adscert

Documentation

Index

• type AuthenticatedConnectionSignature
  • func (acs *AuthenticatedConnectionSignature) String() string
• type AuthenticatedConnectionSignatureParams
• type AuthenticatedConnectionVerification
• type AuthenticatedConnectionsSigner
  • func NewAuthenticatedConnectionsSigner(signatory adscertcrypto.AuthenticatedConnectionsSignatory, reader io.Reader, ...) AuthenticatedConnectionsSigner

Types

type AuthenticatedConnectionSignature

type AuthenticatedConnectionSignature struct {
	SignatureMessages []string

	// Exposes structured data about the outcomes of signing operations so that the integrator
	// can use that information for monitoring and analytics (e.g. monitoring the distribution
	// of signature outcome status codes.)
	SignatureInfo []adscertcrypto.SignatureInfo
}

AuthenticatedConnectionSignature represents a signature conforming to the ads.cert Authenticated Connections specification. Multiple signatures may be present for integrations that utilize a third-party verification service or similar multiparty integration.

func (*AuthenticatedConnectionSignature) String

func (acs *AuthenticatedConnectionSignature) String() string

String provides a summary of the generated signature, including the originating and destination parties. It also includes the keys used. Signature responses containing multiple values will be concatentated into one string, where applicable.

type AuthenticatedConnectionSignatureParams

type AuthenticatedConnectionSignatureParams struct {
	DestinationURL       string
	InvocationHostname   string
	HashedDestinationURL *[32]byte

	RequestBody       []byte
	HashedRequestBody *[32]byte

	// When verifying an existing set of signatures, also include these values.
	SignatureMessageToVerify []string
}

AuthenticatedConnectionSignatureParams captures parameters for the SignAuthenticatedConnection operation.

type AuthenticatedConnectionVerification

type AuthenticatedConnectionVerification struct {
	BodyValid bool
	URLValid  bool
}

AuthenticatedConnectionVerification captures the results of verifying a signature against the ads.cert Authenticated Connections specification requirements.

type AuthenticatedConnectionsSigner

type AuthenticatedConnectionsSigner interface {
	SignAuthenticatedConnection(params AuthenticatedConnectionSignatureParams) (AuthenticatedConnectionSignature, error)

	VerifyAuthenticatedConnection(params AuthenticatedConnectionSignatureParams) (AuthenticatedConnectionVerification, error)
}

AuthenticatedConnectionsSigner generates a signature intended for the specified party over the specified message.

func NewAuthenticatedConnectionsSigner

func NewAuthenticatedConnectionsSigner(signatory adscertcrypto.AuthenticatedConnectionsSignatory, reader io.Reader, clock clock.Clock) AuthenticatedConnectionsSigner

NewAuthenticatedConnectionsSigner creates a new signer instance for creating ads.cert Authenticated Connections signatures.