api

package
v0.51.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 8, 2023 License: Apache-2.0 Imports: 8 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	SignatureDecodeStatus_name = map[int32]string{
		0: "SIGNATURE_DECODE_STATUS_UNDEFINED",
		1: "SIGNATURE_DECODE_STATUS_BODY_AND_URL_VALID",
		2: "SIGNATURE_DECODE_STATUS_BODY_VALID",
		3: "SIGNATURE_DECODE_STATUS_INVALID_SIGNATURE",
		4: "SIGNATURE_DECODE_STATUS_SIGNATURE_NOT_PRESENT",
		5: "SIGNATURE_DECODE_STATUS_SIGNATURE_MALFORMED",
		6: "SIGNATURE_DECODE_STATUS_UNRELATED_SIGNATURE",
		7: "SIGNATURE_DECODE_STATUS_COUNTERPARTY_LOOKUP_ERROR",
		8: "SIGNATURE_DECODE_STATUS_NO_SHARED_SECRET_AVAILABLE",
	}
	SignatureDecodeStatus_value = map[string]int32{
		"SIGNATURE_DECODE_STATUS_UNDEFINED":                  0,
		"SIGNATURE_DECODE_STATUS_BODY_AND_URL_VALID":         1,
		"SIGNATURE_DECODE_STATUS_BODY_VALID":                 2,
		"SIGNATURE_DECODE_STATUS_INVALID_SIGNATURE":          3,
		"SIGNATURE_DECODE_STATUS_SIGNATURE_NOT_PRESENT":      4,
		"SIGNATURE_DECODE_STATUS_SIGNATURE_MALFORMED":        5,
		"SIGNATURE_DECODE_STATUS_UNRELATED_SIGNATURE":        6,
		"SIGNATURE_DECODE_STATUS_COUNTERPARTY_LOOKUP_ERROR":  7,
		"SIGNATURE_DECODE_STATUS_NO_SHARED_SECRET_AVAILABLE": 8,
	}
)

Enum value maps for SignatureDecodeStatus.

View Source
var (
	SignatureOperationStatus_name = map[int32]string{
		0: "SIGNATURE_OPERATION_STATUS_UNDEFINED",
		1: "SIGNATURE_OPERATION_STATUS_OK",
		2: "SIGNATURE_OPERATION_STATUS_SIGNATORY_DEACTIVATED",
		3: "SIGNATURE_OPERATION_STATUS_SIGNATORY_INTERNAL_ERROR",
		4: "SIGNATURE_OPERATION_STATUS_MALFORMED_REQUEST",
	}
	SignatureOperationStatus_value = map[string]int32{
		"SIGNATURE_OPERATION_STATUS_UNDEFINED":                0,
		"SIGNATURE_OPERATION_STATUS_OK":                       1,
		"SIGNATURE_OPERATION_STATUS_SIGNATORY_DEACTIVATED":    2,
		"SIGNATURE_OPERATION_STATUS_SIGNATORY_INTERNAL_ERROR": 3,
		"SIGNATURE_OPERATION_STATUS_MALFORMED_REQUEST":        4,
	}
)

Enum value maps for SignatureOperationStatus.

View Source
var (
	VerificationOperationStatus_name = map[int32]string{
		0: "VERIFICATION_OPERATION_STATUS_UNDEFINED",
		1: "VERIFICATION_OPERATION_STATUS_OK",
		2: "VERIFICATION_OPERATION_STATUS_SIGNATORY_DEACTIVATED",
		3: "VERIFICATION_OPERATION_STATUS_SIGNATORY_INTERNAL_ERROR",
		4: "VERIFICATION_OPERATION_STATUS_MALFORMED_REQUEST",
	}
	VerificationOperationStatus_value = map[string]int32{
		"VERIFICATION_OPERATION_STATUS_UNDEFINED":                0,
		"VERIFICATION_OPERATION_STATUS_OK":                       1,
		"VERIFICATION_OPERATION_STATUS_SIGNATORY_DEACTIVATED":    2,
		"VERIFICATION_OPERATION_STATUS_SIGNATORY_INTERNAL_ERROR": 3,
		"VERIFICATION_OPERATION_STATUS_MALFORMED_REQUEST":        4,
	}
)

Enum value maps for VerificationOperationStatus.

View Source
var AdsCertSignatory_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.AdsCertSignatory",
	HandlerType: (*AdsCertSignatoryServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SignAuthenticatedConnection",
			Handler:    _AdsCertSignatory_SignAuthenticatedConnection_Handler,
		},
		{
			MethodName: "VerifyAuthenticatedConnection",
			Handler:    _AdsCertSignatory_VerifyAuthenticatedConnection_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/adscert.proto",
}

AdsCertSignatory_ServiceDesc is the grpc.ServiceDesc for AdsCertSignatory service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_api_adscert_proto protoreflect.FileDescriptor

Functions

func RegisterAdsCertSignatoryServer

func RegisterAdsCertSignatoryServer(s grpc.ServiceRegistrar, srv AdsCertSignatoryServer)

Types

type AdsCertSignatoryClient

type AdsCertSignatoryClient interface {
	SignAuthenticatedConnection(ctx context.Context, in *AuthenticatedConnectionSignatureRequest, opts ...grpc.CallOption) (*AuthenticatedConnectionSignatureResponse, error)
	VerifyAuthenticatedConnection(ctx context.Context, in *AuthenticatedConnectionVerificationRequest, opts ...grpc.CallOption) (*AuthenticatedConnectionVerificationResponse, error)
}

AdsCertSignatoryClient is the client API for AdsCertSignatory service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type AdsCertSignatoryServer

type AdsCertSignatoryServer interface {
	SignAuthenticatedConnection(context.Context, *AuthenticatedConnectionSignatureRequest) (*AuthenticatedConnectionSignatureResponse, error)
	VerifyAuthenticatedConnection(context.Context, *AuthenticatedConnectionVerificationRequest) (*AuthenticatedConnectionVerificationResponse, error)
	// contains filtered or unexported methods
}

AdsCertSignatoryServer is the server API for AdsCertSignatory service. All implementations must embed UnimplementedAdsCertSignatoryServer for forward compatibility

type AuthenticatedConnectionSignatureRequest

type AuthenticatedConnectionSignatureRequest struct {
	RequestInfo *RequestInfo `protobuf:"bytes,1,opt,name=request_info,json=requestInfo,proto3" json:"request_info,omitempty"`
	Timestamp   string       `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Nonce       string       `protobuf:"bytes,3,opt,name=nonce,proto3" json:"nonce,omitempty"`
	// contains filtered or unexported fields
}

AuthenticatedConnectionSignatureRequest contains the parameters for a signing request.

func (*AuthenticatedConnectionSignatureRequest) Descriptor deprecated

func (*AuthenticatedConnectionSignatureRequest) Descriptor() ([]byte, []int)

Deprecated: Use AuthenticatedConnectionSignatureRequest.ProtoReflect.Descriptor instead.

func (*AuthenticatedConnectionSignatureRequest) GetNonce

func (*AuthenticatedConnectionSignatureRequest) GetRequestInfo

func (*AuthenticatedConnectionSignatureRequest) GetTimestamp

func (*AuthenticatedConnectionSignatureRequest) ProtoMessage

func (*AuthenticatedConnectionSignatureRequest) ProtoReflect

func (*AuthenticatedConnectionSignatureRequest) Reset

func (*AuthenticatedConnectionSignatureRequest) String

type AuthenticatedConnectionSignatureResponse

type AuthenticatedConnectionSignatureResponse struct {
	SignatureOperationStatus SignatureOperationStatus `` /* 170-byte string literal not displayed */
	RequestInfo              *RequestInfo             `protobuf:"bytes,2,opt,name=request_info,json=requestInfo,proto3" json:"request_info,omitempty"`
	// contains filtered or unexported fields
}

AuthenticatedConnectionSignatureResponse contains the results of a signing request, including any signature and relevant metadata. Multiple signatures can technically be present according to the specification.

func (*AuthenticatedConnectionSignatureResponse) Descriptor deprecated

func (*AuthenticatedConnectionSignatureResponse) Descriptor() ([]byte, []int)

Deprecated: Use AuthenticatedConnectionSignatureResponse.ProtoReflect.Descriptor instead.

func (*AuthenticatedConnectionSignatureResponse) GetRequestInfo added in v0.16.0

func (*AuthenticatedConnectionSignatureResponse) GetSignatureOperationStatus added in v0.17.0

func (x *AuthenticatedConnectionSignatureResponse) GetSignatureOperationStatus() SignatureOperationStatus

func (*AuthenticatedConnectionSignatureResponse) ProtoMessage

func (*AuthenticatedConnectionSignatureResponse) ProtoReflect

func (*AuthenticatedConnectionSignatureResponse) Reset

func (*AuthenticatedConnectionSignatureResponse) String

type AuthenticatedConnectionVerificationRequest

type AuthenticatedConnectionVerificationRequest struct {
	RequestInfo []*RequestInfo `protobuf:"bytes,1,rep,name=request_info,json=requestInfo,proto3" json:"request_info,omitempty"`
	// contains filtered or unexported fields
}

AuthenticatedConnectionVerificationRequest contains a request for verifying signatures generated by another party.

func (*AuthenticatedConnectionVerificationRequest) Descriptor deprecated

Deprecated: Use AuthenticatedConnectionVerificationRequest.ProtoReflect.Descriptor instead.

func (*AuthenticatedConnectionVerificationRequest) GetRequestInfo

func (*AuthenticatedConnectionVerificationRequest) ProtoMessage

func (*AuthenticatedConnectionVerificationRequest) ProtoReflect

func (*AuthenticatedConnectionVerificationRequest) Reset

func (*AuthenticatedConnectionVerificationRequest) String

type AuthenticatedConnectionVerificationResponse

type AuthenticatedConnectionVerificationResponse struct {
	VerificationOperationStatus VerificationOperationStatus `` /* 182-byte string literal not displayed */
	VerificationInfo            []*RequestVerificationInfo  `protobuf:"bytes,2,rep,name=verification_info,json=verificationInfo,proto3" json:"verification_info,omitempty"`
	// contains filtered or unexported fields
}

AuthenticatedConnectionVerificationResponse contains the results of verifying signatures.

func (*AuthenticatedConnectionVerificationResponse) Descriptor deprecated

Deprecated: Use AuthenticatedConnectionVerificationResponse.ProtoReflect.Descriptor instead.

func (*AuthenticatedConnectionVerificationResponse) GetVerificationInfo added in v0.17.0

func (*AuthenticatedConnectionVerificationResponse) GetVerificationOperationStatus added in v0.17.0

func (*AuthenticatedConnectionVerificationResponse) ProtoMessage

func (*AuthenticatedConnectionVerificationResponse) ProtoReflect

func (*AuthenticatedConnectionVerificationResponse) Reset

func (*AuthenticatedConnectionVerificationResponse) String

type RequestInfo

type RequestInfo struct {
	InvokingDomain string           `protobuf:"bytes,1,opt,name=invoking_domain,json=invokingDomain,proto3" json:"invoking_domain,omitempty"`
	UrlHash        []byte           `protobuf:"bytes,2,opt,name=url_hash,json=urlHash,proto3" json:"url_hash,omitempty"`
	BodyHash       []byte           `protobuf:"bytes,3,opt,name=body_hash,json=bodyHash,proto3" json:"body_hash,omitempty"`
	SignatureInfo  []*SignatureInfo `protobuf:"bytes,4,rep,name=signature_info,json=signatureInfo,proto3" json:"signature_info,omitempty"`
	// contains filtered or unexported fields
}

RequestInfo conveys the basic parameters required for an authenticated connections signing or verify operation.

func (*RequestInfo) Descriptor deprecated

func (*RequestInfo) Descriptor() ([]byte, []int)

Deprecated: Use RequestInfo.ProtoReflect.Descriptor instead.

func (*RequestInfo) GetBodyHash

func (x *RequestInfo) GetBodyHash() []byte

func (*RequestInfo) GetInvokingDomain

func (x *RequestInfo) GetInvokingDomain() string

func (*RequestInfo) GetSignatureInfo added in v0.16.0

func (x *RequestInfo) GetSignatureInfo() []*SignatureInfo

func (*RequestInfo) GetUrlHash

func (x *RequestInfo) GetUrlHash() []byte

func (*RequestInfo) ProtoMessage

func (*RequestInfo) ProtoMessage()

func (*RequestInfo) ProtoReflect

func (x *RequestInfo) ProtoReflect() protoreflect.Message

func (*RequestInfo) Reset

func (x *RequestInfo) Reset()

func (*RequestInfo) String

func (x *RequestInfo) String() string

type RequestVerificationInfo added in v0.17.0

type RequestVerificationInfo struct {
	SignatureDecodeStatus []SignatureDecodeStatus `` /* 165-byte string literal not displayed */
	// contains filtered or unexported fields
}

RequestVerificationInfo captures the result of a verifying operation against the signatures of a request.

func (*RequestVerificationInfo) Descriptor deprecated added in v0.17.0

func (*RequestVerificationInfo) Descriptor() ([]byte, []int)

Deprecated: Use RequestVerificationInfo.ProtoReflect.Descriptor instead.

func (*RequestVerificationInfo) GetSignatureDecodeStatus added in v0.17.0

func (x *RequestVerificationInfo) GetSignatureDecodeStatus() []SignatureDecodeStatus

func (*RequestVerificationInfo) ProtoMessage added in v0.17.0

func (*RequestVerificationInfo) ProtoMessage()

func (*RequestVerificationInfo) ProtoReflect added in v0.17.0

func (x *RequestVerificationInfo) ProtoReflect() protoreflect.Message

func (*RequestVerificationInfo) Reset added in v0.17.0

func (x *RequestVerificationInfo) Reset()

func (*RequestVerificationInfo) String added in v0.17.0

func (x *RequestVerificationInfo) String() string

type SignatureDecodeStatus added in v0.17.0

type SignatureDecodeStatus int32
const (
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_UNDEFINED                  SignatureDecodeStatus = 0
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_BODY_AND_URL_VALID         SignatureDecodeStatus = 1
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_BODY_VALID                 SignatureDecodeStatus = 2
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_INVALID_SIGNATURE          SignatureDecodeStatus = 3
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_SIGNATURE_NOT_PRESENT      SignatureDecodeStatus = 4
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_SIGNATURE_MALFORMED        SignatureDecodeStatus = 5
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_UNRELATED_SIGNATURE        SignatureDecodeStatus = 6
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_COUNTERPARTY_LOOKUP_ERROR  SignatureDecodeStatus = 7
	SignatureDecodeStatus_SIGNATURE_DECODE_STATUS_NO_SHARED_SECRET_AVAILABLE SignatureDecodeStatus = 8
)

func (SignatureDecodeStatus) Descriptor added in v0.17.0

func (SignatureDecodeStatus) Enum added in v0.17.0

func (SignatureDecodeStatus) EnumDescriptor deprecated added in v0.17.0

func (SignatureDecodeStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use SignatureDecodeStatus.Descriptor instead.

func (SignatureDecodeStatus) Number added in v0.17.0

func (SignatureDecodeStatus) String added in v0.17.0

func (x SignatureDecodeStatus) String() string

func (SignatureDecodeStatus) Type added in v0.17.0

type SignatureInfo

type SignatureInfo struct {
	SignatureMessage string `protobuf:"bytes,1,opt,name=signature_message,json=signatureMessage,proto3" json:"signature_message,omitempty"`
	SigningStatus    string `protobuf:"bytes,2,opt,name=signing_status,json=signingStatus,proto3" json:"signing_status,omitempty"`
	FromDomain       string `protobuf:"bytes,3,opt,name=from_domain,json=fromDomain,proto3" json:"from_domain,omitempty"`
	FromKey          string `protobuf:"bytes,4,opt,name=from_key,json=fromKey,proto3" json:"from_key,omitempty"`
	InvokingDomain   string `protobuf:"bytes,5,opt,name=invoking_domain,json=invokingDomain,proto3" json:"invoking_domain,omitempty"`
	ToDomain         string `protobuf:"bytes,6,opt,name=to_domain,json=toDomain,proto3" json:"to_domain,omitempty"`
	ToKey            string `protobuf:"bytes,7,opt,name=to_key,json=toKey,proto3" json:"to_key,omitempty"`
	// contains filtered or unexported fields
}

SignatureInfo captures the signature generated for the signing request. It also provides structured metadata about the signature operation, useful in the integrating application for diagnostics.

func (*SignatureInfo) Descriptor deprecated

func (*SignatureInfo) Descriptor() ([]byte, []int)

Deprecated: Use SignatureInfo.ProtoReflect.Descriptor instead.

func (*SignatureInfo) GetFromDomain

func (x *SignatureInfo) GetFromDomain() string

func (*SignatureInfo) GetFromKey

func (x *SignatureInfo) GetFromKey() string

func (*SignatureInfo) GetInvokingDomain

func (x *SignatureInfo) GetInvokingDomain() string

func (*SignatureInfo) GetSignatureMessage

func (x *SignatureInfo) GetSignatureMessage() string

func (*SignatureInfo) GetSigningStatus

func (x *SignatureInfo) GetSigningStatus() string

func (*SignatureInfo) GetToDomain

func (x *SignatureInfo) GetToDomain() string

func (*SignatureInfo) GetToKey

func (x *SignatureInfo) GetToKey() string

func (*SignatureInfo) ProtoMessage

func (*SignatureInfo) ProtoMessage()

func (*SignatureInfo) ProtoReflect

func (x *SignatureInfo) ProtoReflect() protoreflect.Message

func (*SignatureInfo) Reset

func (x *SignatureInfo) Reset()

func (*SignatureInfo) String

func (x *SignatureInfo) String() string

type SignatureOperationStatus added in v0.17.0

type SignatureOperationStatus int32
const (
	SignatureOperationStatus_SIGNATURE_OPERATION_STATUS_UNDEFINED                SignatureOperationStatus = 0
	SignatureOperationStatus_SIGNATURE_OPERATION_STATUS_OK                       SignatureOperationStatus = 1
	SignatureOperationStatus_SIGNATURE_OPERATION_STATUS_SIGNATORY_DEACTIVATED    SignatureOperationStatus = 2
	SignatureOperationStatus_SIGNATURE_OPERATION_STATUS_SIGNATORY_INTERNAL_ERROR SignatureOperationStatus = 3
	SignatureOperationStatus_SIGNATURE_OPERATION_STATUS_MALFORMED_REQUEST        SignatureOperationStatus = 4
)

func (SignatureOperationStatus) Descriptor added in v0.17.0

func (SignatureOperationStatus) Enum added in v0.17.0

func (SignatureOperationStatus) EnumDescriptor deprecated added in v0.17.0

func (SignatureOperationStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use SignatureOperationStatus.Descriptor instead.

func (SignatureOperationStatus) Number added in v0.17.0

func (SignatureOperationStatus) String added in v0.17.0

func (x SignatureOperationStatus) String() string

func (SignatureOperationStatus) Type added in v0.17.0

type UnimplementedAdsCertSignatoryServer

type UnimplementedAdsCertSignatoryServer struct {
}

UnimplementedAdsCertSignatoryServer must be embedded to have forward compatible implementations.

type UnsafeAdsCertSignatoryServer

type UnsafeAdsCertSignatoryServer interface {
	// contains filtered or unexported methods
}

UnsafeAdsCertSignatoryServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AdsCertSignatoryServer will result in compilation errors.

type VerificationOperationStatus added in v0.17.0

type VerificationOperationStatus int32
const (
	VerificationOperationStatus_VERIFICATION_OPERATION_STATUS_UNDEFINED                VerificationOperationStatus = 0
	VerificationOperationStatus_VERIFICATION_OPERATION_STATUS_OK                       VerificationOperationStatus = 1
	VerificationOperationStatus_VERIFICATION_OPERATION_STATUS_SIGNATORY_DEACTIVATED    VerificationOperationStatus = 2
	VerificationOperationStatus_VERIFICATION_OPERATION_STATUS_SIGNATORY_INTERNAL_ERROR VerificationOperationStatus = 3
	VerificationOperationStatus_VERIFICATION_OPERATION_STATUS_MALFORMED_REQUEST        VerificationOperationStatus = 4
)

func (VerificationOperationStatus) Descriptor added in v0.17.0

func (VerificationOperationStatus) Enum added in v0.17.0

func (VerificationOperationStatus) EnumDescriptor deprecated added in v0.17.0

func (VerificationOperationStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use VerificationOperationStatus.Descriptor instead.

func (VerificationOperationStatus) Number added in v0.17.0

func (VerificationOperationStatus) String added in v0.17.0

func (VerificationOperationStatus) Type added in v0.17.0

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL