vc

Documentation

Index

• func ValidateCredential(_ context.Context, cred interface{}, formats []vcsverifiable.Format, ...) (*verifiable.Credential, error)
• type DataIntegrityProofConfig
• type Field
• type SDJWT
• type Signer
• type SignerAlgorithm
• type StatusProcessor
• type StatusProcessorGetter
• type StatusType

Functions

func ValidateCredential

func ValidateCredential(
	_ context.Context,
	cred interface{},
	formats []vcsverifiable.Format,
	checkExpiration bool,
	enforceStrictValidation bool,
	documentLoader jsonld.DocumentLoader,
	opts ...verifiable.CredentialOpt,
) (*verifiable.Credential, error)

Types

type DataIntegrityProofConfig

type DataIntegrityProofConfig struct {
	// Enable flag enables Data Integrity Proof feature.
	Enable bool `json:"enable"`
	// SuiteType is the data integrity Type identifier for the suite.
	SuiteType string `json:"suiteType"`
}

DataIntegrityProofConfig represents the Data Integrity LDP config.

type Field

type Field struct {
	Key   string
	Value interface{}
}

Field is used to define the key-value pair for additional fields in VC.

type SDJWT

type SDJWT struct {
	Enable  bool                `json:"enable,omitempty"`
	HashAlg crypto.Hash         `json:"hashAlg,omitempty"`
	Version common.SDJWTVersion `json:"version,omitempty"`
}

SDJWT represents the SD-JWT configuration.

type Signer

type Signer struct {
	DID                     string                      // didResolution.DIDDocument.ID.
	Creator                 string                      // didResolution.DIDDocument.ID + "#" + authentication.ID.
	KMSKeyID                string                      // authentication.ID.
	SignatureType           vcsverifiable.SignatureType // issuer.vcConfig.signingAlgorithm.
	KeyType                 kms.KeyType
	Format                  vcsverifiable.Format               // VC format - LDP/JWT.
	SignatureRepresentation verifiable.SignatureRepresentation // For LDP only - proof/JWS.
	KMS                     keyManager
	VCStatusListType        StatusType // Type of VC status list
	SDJWT                   SDJWT
	DataIntegrityProof      DataIntegrityProofConfig
}

Signer contains information about vc signer, usually this is credential issuer.

type SignerAlgorithm

type SignerAlgorithm interface {
	Sign(data []byte) ([]byte, error)
	Alg() string
}

type StatusProcessor

type StatusProcessor interface {
	ValidateStatus(vcStatus *verifiable.TypedID) error
	GetStatusVCURI(vcStatus *verifiable.TypedID) (string, error)
	GetStatusListIndex(vcStatus *verifiable.TypedID) (int, error)
	CreateVC(vcID string, listSize int, profile *Signer) (*verifiable.Credential, error)
	CreateVCStatus(index, vcID, purpose string, additionalFields ...Field) *verifiable.TypedID
	GetVCContext() string
	UpdateStatus(vc *verifiable.Credential, status bool, indexes ...int) (*verifiable.Credential, error)
	IsSet(vc *verifiable.Credential, index int) (bool, error)
}

StatusProcessor holds the list of methods required for processing different versions of Status(Revocation) List VC.

type StatusProcessorGetter

type StatusProcessorGetter func(vcStatusListType StatusType) (StatusProcessor, error)

type StatusType

type StatusType string

StatusType is used to define implementation of VC status list. Field verifiable.TypedID .Type.

const (
	// StatusList2021VCStatus represents the implementation of VC Status List 2021.
	//  VC > Status > Type
	// 	Doc: https://w3c-ccg.github.io/vc-status-list-2021/
	StatusList2021VCStatus StatusType = "StatusList2021Entry"

	// RevocationList2021VCStatus represents the implementation of VC Status List 2021 v.0.0.1.
	//  VC > Status > Type
	//  Doc: https://github.com/w3c-ccg/vc-status-list-2021/releases/tag/v0.0.1
	RevocationList2021VCStatus StatusType = "RevocationList2021Status"

	// RevocationList2020VCStatus represents the implementation of VC Revocation List 2020.
	//  VC > Status > Type
	// 	Doc: https://w3c-ccg.github.io/vc-status-rl-2020/
	RevocationList2020VCStatus StatusType = "RevocationList2020Status"

	// BitstringStatusList represents the implementation of the Bitstring VC Status List.
	//  VC > Status > Type
	// 	Doc: https://www.w3.org/TR/vc-bitstring-status-list/
	BitstringStatusList StatusType = "BitstringStatusListEntry"
)