api

package
v0.9.0 Latest Latest
Warning

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

Go to latest
Published: Jul 2, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	SignatureStatus_name = map[int32]string{
		0: "SIGNATURE_STATUS_UNDEFINED",
		1: "SIGNATURE_STATUS_OK",
		2: "SIGNATURE_STATUS_SIGNATORY_DEACTIVATED",
		3: "SIGNATURE_STATUS_SIGNATORY_INTERNAL_ERROR",
		4: "SIGNATURE_STATUS_MISSING_REQUIRED_PARAMETER",
		5: "SIGNATURE_STATUS_NO_COUNTERPARTY_INFO",
	}
	SignatureStatus_value = map[string]int32{
		"SIGNATURE_STATUS_UNDEFINED":                  0,
		"SIGNATURE_STATUS_OK":                         1,
		"SIGNATURE_STATUS_SIGNATORY_DEACTIVATED":      2,
		"SIGNATURE_STATUS_SIGNATORY_INTERNAL_ERROR":   3,
		"SIGNATURE_STATUS_MISSING_REQUIRED_PARAMETER": 4,
		"SIGNATURE_STATUS_NO_COUNTERPARTY_INFO":       5,
	}
)

Enum value maps for SignatureStatus.

View Source
var (
	VerificationStatus_name = map[int32]string{
		0: "VERIFICATION_STATUS_UNDEFINED",
		1: "VERIFICATION_STATUS_OK",
		2: "VERIFICATION_STATUS_SIGNATORY_DEACTIVATED",
		3: "VERIFICATION_STATUS_SIGNATORY_INTERNAL_ERROR",
		4: "VERIFICATION_STATUS_MISSING_REQUIRED_PARAMETER",
		5: "VERIFICATION_STATUS_NO_COUNTERPARTY_INFO",
	}
	VerificationStatus_value = map[string]int32{
		"VERIFICATION_STATUS_UNDEFINED":                  0,
		"VERIFICATION_STATUS_OK":                         1,
		"VERIFICATION_STATUS_SIGNATORY_DEACTIVATED":      2,
		"VERIFICATION_STATUS_SIGNATORY_INTERNAL_ERROR":   3,
		"VERIFICATION_STATUS_MISSING_REQUIRED_PARAMETER": 4,
		"VERIFICATION_STATUS_NO_COUNTERPARTY_INFO":       5,
	}
)

Enum value maps for VerificationStatus.

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 added in v0.7.0

func RegisterAdsCertSignatoryServer(s grpc.ServiceRegistrar, srv AdsCertSignatoryServer)

Types

type AdsCertSignatoryClient added in v0.7.0

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.

func NewAdsCertSignatoryClient added in v0.7.0

func NewAdsCertSignatoryClient(cc grpc.ClientConnInterface) AdsCertSignatoryClient

type AdsCertSignatoryServer added in v0.7.0

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 added in v0.5.0

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 added in v0.5.0

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

Deprecated: Use AuthenticatedConnectionSignatureRequest.ProtoReflect.Descriptor instead.

func (*AuthenticatedConnectionSignatureRequest) GetNonce added in v0.5.0

func (*AuthenticatedConnectionSignatureRequest) GetRequestInfo added in v0.5.0

func (*AuthenticatedConnectionSignatureRequest) GetTimestamp added in v0.5.0

func (*AuthenticatedConnectionSignatureRequest) ProtoMessage added in v0.5.0

func (*AuthenticatedConnectionSignatureRequest) ProtoReflect added in v0.5.0

func (*AuthenticatedConnectionSignatureRequest) Reset added in v0.5.0

func (*AuthenticatedConnectionSignatureRequest) String added in v0.5.0

type AuthenticatedConnectionSignatureResponse added in v0.5.0

type AuthenticatedConnectionSignatureResponse struct {
	SignatureStatus SignatureStatus  `` /* 132-byte string literal not displayed */
	SignatureInfo   []*SignatureInfo `protobuf:"bytes,2,rep,name=signature_info,json=signatureInfo,proto3" json:"signature_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 added in v0.5.0

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

Deprecated: Use AuthenticatedConnectionSignatureResponse.ProtoReflect.Descriptor instead.

func (*AuthenticatedConnectionSignatureResponse) GetSignatureInfo added in v0.5.0

func (*AuthenticatedConnectionSignatureResponse) GetSignatureStatus added in v0.8.0

func (*AuthenticatedConnectionSignatureResponse) ProtoMessage added in v0.5.0

func (*AuthenticatedConnectionSignatureResponse) ProtoReflect added in v0.5.0

func (*AuthenticatedConnectionSignatureResponse) Reset added in v0.5.0

func (*AuthenticatedConnectionSignatureResponse) String added in v0.5.0

type AuthenticatedConnectionVerificationRequest added in v0.5.0

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

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

func (*AuthenticatedConnectionVerificationRequest) Descriptor deprecated added in v0.5.0

Deprecated: Use AuthenticatedConnectionVerificationRequest.ProtoReflect.Descriptor instead.

func (*AuthenticatedConnectionVerificationRequest) GetRequestInfo added in v0.5.0

func (*AuthenticatedConnectionVerificationRequest) GetSignatureMessage added in v0.5.0

func (x *AuthenticatedConnectionVerificationRequest) GetSignatureMessage() []string

func (*AuthenticatedConnectionVerificationRequest) ProtoMessage added in v0.5.0

func (*AuthenticatedConnectionVerificationRequest) ProtoReflect added in v0.5.0

func (*AuthenticatedConnectionVerificationRequest) Reset added in v0.5.0

func (*AuthenticatedConnectionVerificationRequest) String added in v0.5.0

type AuthenticatedConnectionVerificationResponse added in v0.5.0

type AuthenticatedConnectionVerificationResponse struct {
	VerificationStatus VerificationStatus `` /* 144-byte string literal not displayed */
	BodyValid          bool               `protobuf:"varint,2,opt,name=body_valid,json=bodyValid,proto3" json:"body_valid,omitempty"`
	UrlValid           bool               `protobuf:"varint,3,opt,name=url_valid,json=urlValid,proto3" json:"url_valid,omitempty"`
	// contains filtered or unexported fields
}

AuthenticatedConnectionVerificationResponse contains the results of verifying signatures.

func (*AuthenticatedConnectionVerificationResponse) Descriptor deprecated added in v0.5.0

Deprecated: Use AuthenticatedConnectionVerificationResponse.ProtoReflect.Descriptor instead.

func (*AuthenticatedConnectionVerificationResponse) GetBodyValid added in v0.5.0

func (*AuthenticatedConnectionVerificationResponse) GetUrlValid added in v0.5.0

func (*AuthenticatedConnectionVerificationResponse) GetVerificationStatus added in v0.8.0

func (*AuthenticatedConnectionVerificationResponse) ProtoMessage added in v0.5.0

func (*AuthenticatedConnectionVerificationResponse) ProtoReflect added in v0.5.0

func (*AuthenticatedConnectionVerificationResponse) Reset added in v0.5.0

func (*AuthenticatedConnectionVerificationResponse) String added in v0.5.0

type RequestInfo added in v0.5.0

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"`
	// contains filtered or unexported fields
}

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

func (*RequestInfo) Descriptor deprecated added in v0.5.0

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

Deprecated: Use RequestInfo.ProtoReflect.Descriptor instead.

func (*RequestInfo) GetBodyHash added in v0.5.0

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

func (*RequestInfo) GetInvokingDomain added in v0.8.0

func (x *RequestInfo) GetInvokingDomain() string

func (*RequestInfo) GetUrlHash added in v0.5.0

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

func (*RequestInfo) ProtoMessage added in v0.5.0

func (*RequestInfo) ProtoMessage()

func (*RequestInfo) ProtoReflect added in v0.5.0

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

func (*RequestInfo) Reset added in v0.5.0

func (x *RequestInfo) Reset()

func (*RequestInfo) String added in v0.5.0

func (x *RequestInfo) String() string

type SignatureInfo added in v0.5.0

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 added in v0.5.0

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

Deprecated: Use SignatureInfo.ProtoReflect.Descriptor instead.

func (*SignatureInfo) GetFromDomain added in v0.5.0

func (x *SignatureInfo) GetFromDomain() string

func (*SignatureInfo) GetFromKey added in v0.5.0

func (x *SignatureInfo) GetFromKey() string

func (*SignatureInfo) GetInvokingDomain added in v0.5.0

func (x *SignatureInfo) GetInvokingDomain() string

func (*SignatureInfo) GetSignatureMessage added in v0.5.0

func (x *SignatureInfo) GetSignatureMessage() string

func (*SignatureInfo) GetSigningStatus added in v0.5.0

func (x *SignatureInfo) GetSigningStatus() string

func (*SignatureInfo) GetToDomain added in v0.5.0

func (x *SignatureInfo) GetToDomain() string

func (*SignatureInfo) GetToKey added in v0.5.0

func (x *SignatureInfo) GetToKey() string

func (*SignatureInfo) ProtoMessage added in v0.5.0

func (*SignatureInfo) ProtoMessage()

func (*SignatureInfo) ProtoReflect added in v0.5.0

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

func (*SignatureInfo) Reset added in v0.5.0

func (x *SignatureInfo) Reset()

func (*SignatureInfo) String added in v0.5.0

func (x *SignatureInfo) String() string

type SignatureStatus added in v0.8.0

type SignatureStatus int32
const (
	SignatureStatus_SIGNATURE_STATUS_UNDEFINED                  SignatureStatus = 0
	SignatureStatus_SIGNATURE_STATUS_OK                         SignatureStatus = 1
	SignatureStatus_SIGNATURE_STATUS_SIGNATORY_DEACTIVATED      SignatureStatus = 2
	SignatureStatus_SIGNATURE_STATUS_SIGNATORY_INTERNAL_ERROR   SignatureStatus = 3
	SignatureStatus_SIGNATURE_STATUS_MISSING_REQUIRED_PARAMETER SignatureStatus = 4
	SignatureStatus_SIGNATURE_STATUS_NO_COUNTERPARTY_INFO       SignatureStatus = 5
)

func (SignatureStatus) Descriptor added in v0.8.0

func (SignatureStatus) Enum added in v0.8.0

func (x SignatureStatus) Enum() *SignatureStatus

func (SignatureStatus) EnumDescriptor deprecated added in v0.8.0

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

Deprecated: Use SignatureStatus.Descriptor instead.

func (SignatureStatus) Number added in v0.8.0

func (SignatureStatus) String added in v0.8.0

func (x SignatureStatus) String() string

func (SignatureStatus) Type added in v0.8.0

type UnimplementedAdsCertSignatoryServer added in v0.7.0

type UnimplementedAdsCertSignatoryServer struct {
}

UnimplementedAdsCertSignatoryServer must be embedded to have forward compatible implementations.

func (UnimplementedAdsCertSignatoryServer) SignAuthenticatedConnection added in v0.7.0

type UnsafeAdsCertSignatoryServer added in v0.7.0

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 VerificationStatus added in v0.8.0

type VerificationStatus int32
const (
	VerificationStatus_VERIFICATION_STATUS_UNDEFINED                  VerificationStatus = 0
	VerificationStatus_VERIFICATION_STATUS_OK                         VerificationStatus = 1
	VerificationStatus_VERIFICATION_STATUS_SIGNATORY_DEACTIVATED      VerificationStatus = 2
	VerificationStatus_VERIFICATION_STATUS_SIGNATORY_INTERNAL_ERROR   VerificationStatus = 3
	VerificationStatus_VERIFICATION_STATUS_MISSING_REQUIRED_PARAMETER VerificationStatus = 4
	VerificationStatus_VERIFICATION_STATUS_NO_COUNTERPARTY_INFO       VerificationStatus = 5
)

func (VerificationStatus) Descriptor added in v0.8.0

func (VerificationStatus) Enum added in v0.8.0

func (VerificationStatus) EnumDescriptor deprecated added in v0.8.0

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

Deprecated: Use VerificationStatus.Descriptor instead.

func (VerificationStatus) Number added in v0.8.0

func (VerificationStatus) String added in v0.8.0

func (x VerificationStatus) String() string

func (VerificationStatus) Type added in v0.8.0

Jump to

Keyboard shortcuts

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