paymentauth

Documentation

Overview

Package paymentauth binds one device-signed Payment catalog query to the authority-issued installation certificate that nominates its trusted key and account. It owns no billing or receipt persistence policy.

Index

• Constants
• func IssueResponse(i ResponseIssuance) (controlplane.ResponseProjection[payment.CatalogDocument], error)
• func VerifyResponse(v ResponseVerification) (...)
• type RequestAssembly
  • func (a RequestAssembly) Validate() error
• type RequestDocument
  • func Assemble(assembly RequestAssembly) (RequestDocument, error)
  • func (d RequestDocument) ControlNonce() controlwire.RequestNonce
  • func (RequestDocument) ControlRequestBodyLimit() (core.ByteCount, error)
  • func (d RequestDocument) ControlRevision() controlwire.Revision
  • func (d RequestDocument) ControlRoute() (controlwire.RouteContract, error)
  • func (d RequestDocument) MarshalJSON() ([]byte, error)
  • func (d *RequestDocument) UnmarshalJSON(data []byte) error
  • func (d RequestDocument) Validate() error
• type ResponseIssuance
  • func (i ResponseIssuance) Validate() error
• type ResponseVerification
  • func (v ResponseVerification) Validate() error
• type Verification
  • func (v Verification) Validate() error
• type Verified
  • func Verify(verification Verification) (Verified, error)
  • func (v Verified) Payload() (payment.QueryPayload, error)
  • func (v Verified) Validate() error

Constants

const (
	RequestDocumentJSONMaximumBytes = payment.QueryDocumentJSONMaximumBytes +
		controlplane.InstallationCertificateDocumentJSONMaximumBytes +
		core.CredentialedRequestDocumentSyntaxBytes + core.CredentialedDocumentWhitespaceMaximumBytes
)

Functions

func IssueResponse

func IssueResponse(i ResponseIssuance) (controlplane.ResponseProjection[payment.CatalogDocument], error)

func VerifyResponse

func VerifyResponse(v ResponseVerification) (controlplane.VerifiedResponse[payment.CatalogDocument, *payment.CatalogDocument], error)

Types

type RequestAssembly

type RequestAssembly struct {
	Request     payment.QueryDocument
	Certificate controlplane.InstallationCertificateDocument
}

func (RequestAssembly) Validate

func (a RequestAssembly) Validate() error

type RequestDocument

type RequestDocument struct {
	Request     payment.QueryDocument                        `json:"request"`
	Certificate controlplane.InstallationCertificateDocument `json:"certificate"`
}

func Assemble

func Assemble(assembly RequestAssembly) (RequestDocument, error)

func (RequestDocument) ControlNonce

func (d RequestDocument) ControlNonce() controlwire.RequestNonce

ControlNonce projects the signed query identity.

func (RequestDocument) ControlRequestBodyLimit

func (RequestDocument) ControlRequestBodyLimit() (core.ByteCount, error)

func (RequestDocument) ControlRevision

func (d RequestDocument) ControlRevision() controlwire.Revision

ControlRevision projects the exact device-signed query revision.

func (RequestDocument) ControlRoute

func (d RequestDocument) ControlRoute() (controlwire.RouteContract, error)

ControlRoute projects the sole route admitted by this credentialed query.

func (RequestDocument) MarshalJSON

func (d RequestDocument) MarshalJSON() ([]byte, error)

func (*RequestDocument) UnmarshalJSON

func (d *RequestDocument) UnmarshalJSON(data []byte) error

func (RequestDocument) Validate

func (d RequestDocument) Validate() error

type ResponseIssuance

type ResponseIssuance struct {
	Signer     crypto.Signer
	Header     controlplane.ResponseHeader
	Body       payment.CatalogDocument
	Assessment controlwire.ProtocolAssessment
}

func (ResponseIssuance) Validate

func (i ResponseIssuance) Validate() error

type ResponseVerification

type ResponseVerification struct {
	Expected    controlplane.ResponseExpectation
	Document    controlplane.ResponseDocument[payment.CatalogDocument, *payment.CatalogDocument]
	TrustedKeys attest.TrustedKeys
}

func (ResponseVerification) Validate

func (v ResponseVerification) Validate() error

type Verification

type Verification struct {
	Document    RequestDocument
	TrustedKeys attest.TrustedKeys
}

func (Verification) Validate

func (v Verification) Validate() error

type Verified

type Verified struct {
	// contains filtered or unexported fields
}

func Verify

func Verify(verification Verification) (Verified, error)

func (Verified) Payload

func (v Verified) Payload() (payment.QueryPayload, error)

func (Verified) Validate

func (v Verified) Validate() error