cryptosuite

type CryptoSuite interface {
	CryptoSuiteInfo

	// Sign https://w3c-ccg.github.io/data-integrity-spec/#proof-algorithm
	// this method mutates the provided provable object, adding a `proof` block`
	Sign(s Signer, p WithEmbeddedProof) error
	// Verify https://w3c-ccg.github.io/data-integrity-spec/#proof-verification-algorithm
	Verify(v Verifier, p WithEmbeddedProof) error
}

type CryptoSuiteInfo interface {
	ID() string
	Type() LDKeyType
	CanonicalizationAlgorithm() string
	MessageDigestAlgorithm() gocrypto.Hash
	SignatureAlgorithm() SignatureType
	RequiredContexts() []string
}

type CryptoSuiteProofType interface {
	Marshal(data any) ([]byte, error)
	Canonicalize(marshaled []byte) (*string, error)
	// CreateVerifyHash https://www.w3.org/community/reports/credentials/CG-FINAL-data-integrity-20220722/#create-verify-hash-algorithm
	CreateVerifyHash(doc map[string]any, proof crypto.Proof, proofOptions *ProofOptions) ([]byte, error)
	// Digest runs a given digest algorithm https://www.w3.org/community/reports/credentials/CG-FINAL-data-integrity-20220722/#dfn-message-digest-algorithm
	// on a canonizliaed document prior to signing. Sometimes implementations will be a no-op as digesting is handled
	// by the signature algorithm itself.
	Digest(tbd []byte) ([]byte, error)
}

type GenericProvable map[string]any

type LDKeyType string

type PayloadFormat string

type ProofOptions struct {
	// JSON-LD contexts to add to the proof
	Contexts []any

	// Indexes of the credential subject to require be revealed in BBS+ signatures
	RevealIndexes []int
}

type ProofPurpose string

type SignatureType string

type Signer interface {
	Sign(tbs []byte) ([]byte, error)

	GetKeyID() string
	GetSignatureType() SignatureType
	GetSigningAlgorithm() string

	SetProofPurpose(purpose ProofPurpose)
	GetProofPurpose() ProofPurpose

	SetPayloadFormat(format PayloadFormat)
	GetPayloadFormat() PayloadFormat
}

type Verifier interface {
	Verify(message, signature []byte) error
	GetKeyID() string
}

type WithEmbeddedProof interface {
	GetProof() *crypto.Proof
	SetProof(p *crypto.Proof)
}