types

Documentation

Index

• Constants
• func EncodeSignatureEvidence(evidence SignatureEvidence) (string, error)
• func SpansRich(spans []Span) bool
• func SpansText(spans []Span) string
• type BissBaseResponse
  • func (r BissBaseResponse) Err(prefix string) error
• type BissGetSignerRequest
• type BissGetSignerResponse
• type BissSelector
• type BissSignRequest
• type BissSignResponse
• type BissVersionResponse
• type BlockContext
• type BlockUpdateResult
  • func Handled(col int) BlockUpdateResult
  • func Unhandled(col int) BlockUpdateResult
• type CertificateOptions
• type GeneratedCertificate
• type GeneratedKey
• type NetworkContext
• type SignatureEvidence
  • func DecodeSignatureEvidence(raw string) (SignatureEvidence, bool)
• type SignatureEvidenceDraft
  • func NewSignatureEvidenceDraft(contentHash, blockPayload string, side int, partyName string) SignatureEvidenceDraft
  • func (d SignatureEvidenceDraft) Complete(signerOutput, signingMethod string, now time.Time) (SignatureEvidence, error)
  • func (d SignatureEvidenceDraft) SigningPayload() string
• type SigningContext
  • func CurrentSigningContext(signingMethod string) SigningContext
• type Span

Constants

const SignatureEvidenceVersion = "pact-signature-evidence-v1"

Functions

func EncodeSignatureEvidence

func EncodeSignatureEvidence(evidence SignatureEvidence) (string, error)

func SpansRich

func SpansRich(spans []Span) bool

SpansRich reports whether any span carries non-default formatting.

func SpansText

func SpansText(spans []Span) string

SpansText concatenates the text of all spans.

Types

type BissBaseResponse

type BissBaseResponse struct {
	Status     string `json:"status"`
	ReasonCode int    `json:"reasonCode"`
	ReasonText string `json:"reasonText"`
}

func (BissBaseResponse) Err

func (r BissBaseResponse) Err(prefix string) error

type BissGetSignerRequest

type BissGetSignerRequest struct {
	Selector       BissSelector `json:"selector,omitempty"`
	ShowValidCerts bool         `json:"showValidCerts"`
}

type BissGetSignerResponse

type BissGetSignerResponse struct {
	BissBaseResponse
	Chain []string `json:"chain"`
}

type BissSelector

type BissSelector struct {
	KeyUsages []string `json:"keyUsages,omitempty"`
}

type BissSignRequest

type BissSignRequest struct {
	SignerCertificateB64  string   `json:"signerCertificateB64"`
	SignedContentsCert    []string `json:"signedContentsCert"`
	SignedContents        []string `json:"signedContents"`
	Contents              []string `json:"contents"`
	HashAlgorithm         string   `json:"hashAlgorithm"`
	AdditionalConfirmText string   `json:"additionalConfirmText,omitempty"`
	ConfirmText           []string `json:"confirmText,omitempty"`
}

type BissSignResponse

type BissSignResponse struct {
	BissBaseResponse
	Signatures []string `json:"signatures"`
}

type BissVersionResponse

type BissVersionResponse struct {
	Version           string `json:"version"`
	HTTPMethods       string `json:"httpMethods"`
	ContentTypes      string `json:"contentTypes"`
	SignatureTypes    string `json:"signatureTypes"`
	SelectorAvailable bool   `json:"selectorAvailable"`
	HashAlgorithms    string `json:"hashAlgorithms"`
}

type BlockContext

type BlockContext struct {
	Col         int
	Mode        enums.DocumentMode
	ToList      func(content string, align enums.Alignment) any
	ToText      func(content string, align enums.Alignment) any
	ToRule      func() any
	ToTable     func() any
	ToSignature func() any
	ToCheckbox  func(label string, col int) any
	ToColumns   func(leftContent string, align enums.Alignment) any
}

type BlockUpdateResult

type BlockUpdateResult struct {
	Block       any
	NewBlock    any
	DeleteBlock bool
	Col         int
	Handled     bool
}

func Handled

func Handled(col int) BlockUpdateResult

func Unhandled

func Unhandled(col int) BlockUpdateResult

type CertificateOptions

type CertificateOptions struct {
	Name     string
	Identity string
}

type GeneratedCertificate

type GeneratedCertificate struct {
	PrivateKeyPath  string
	PublicKeyPath   string
	CertificatePath string
}

type GeneratedKey

type GeneratedKey struct {
	PrivateKeyPath string
	PublicKeyPath  string
}

type NetworkContext

type NetworkContext struct {
	GatewayIP string `json:"gatewayIp,omitempty"`
	LocalIP   string `json:"localIp,omitempty"`
	PublicIP  string `json:"publicIp,omitempty"`
}

type SignatureEvidence

type SignatureEvidence struct {
	Version              string         `json:"version"`
	ID                   string         `json:"id"`
	CreatedAtUTC         string         `json:"createdAtUtc"`
	ContentHashAlgorithm string         `json:"contentHashAlgorithm"`
	ContentHash          string         `json:"contentHash"`
	SignatureSide        string         `json:"signatureSide"`
	PartyName            string         `json:"partyName"`
	SignerOutput         string         `json:"signerOutput"`
	SigningContext       SigningContext `json:"signingContext"`
}

func DecodeSignatureEvidence

func DecodeSignatureEvidence(raw string) (SignatureEvidence, bool)

type SignatureEvidenceDraft

type SignatureEvidenceDraft struct {
	ContentHashAlgorithm  string
	ContentHash           string
	SignatureBlockPayload string
	SignatureSide         string
	PartyName             string
}

func NewSignatureEvidenceDraft

func NewSignatureEvidenceDraft(contentHash, blockPayload string, side int, partyName string) SignatureEvidenceDraft

func (SignatureEvidenceDraft) Complete

func (d SignatureEvidenceDraft) Complete(signerOutput, signingMethod string, now time.Time) (SignatureEvidence, error)

func (SignatureEvidenceDraft) SigningPayload

func (d SignatureEvidenceDraft) SigningPayload() string

type SigningContext

type SigningContext struct {
	OS            string         `json:"os"`
	ComputerName  string         `json:"computerName,omitempty"`
	OSAccount     string         `json:"osAccount,omitempty"`
	SigningMethod string         `json:"signingMethod,omitempty"`
	Network       NetworkContext `json:"network,omitempty"`
}

func CurrentSigningContext

func CurrentSigningContext(signingMethod string) SigningContext

type Span

type Span struct {
	Text  string
	Bold  bool
	Color string // "#RRGGBB"; empty means default
}

Span is a run of text with optional rich formatting.