oidc4vp

package
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 6, 2024 License: Apache-2.0 Imports: 36 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrDataNotFound = errors.New("data not found")

Functions

func CreateEvent added in v1.5.0 

func CreateEvent(
	eventType spi.EventType,
	transactionID TxID,
	ep *EventPayload,
) (*spi.Event, error)

func GetSupportedVPFormats added in v1.1.0 

func GetSupportedVPFormats(
	kmsSupportedKeyTypes []kmsapi.KeyType,
	supportedVPFormats,
	supportedVCFormats []vcsverifiable.Format,
) *presexch.Format

Types

type AuthorizationResponseParsed added in v1.6.0 

type AuthorizationResponseParsed struct {
	// CustomScopeClaims stores additional claims provided by Holder
	// caused by custom scope as a part of Initiate Credential Presentation request.
	CustomScopeClaims map[string]Claims
	VPTokens          []*ProcessedVPToken
}

type ClaimData 

type ClaimData struct {
	EncryptedData *dataprotect.EncryptedData `json:"encrypted_data"`
}

type Claims added in v1.6.0 

type Claims = map[string]interface{}

type Config 

type Config struct {
	TransactionManager       transactionManager
	RequestObjectPublicStore requestObjectPublicStore
	KMSRegistry              kmsRegistry
	DocumentLoader           ld.DocumentLoader
	ProfileService           profileService
	EventSvc                 eventService
	EventTopic               string
	PresentationVerifier     presentationVerifier
	VDR                      vdrapi.Registry

	RedirectURL   string
	TokenLifetime time.Duration
	Metrics       metricsProvider
}

type CredentialMetadata 

type CredentialMetadata struct {
	Format         vcsverifiable.Format `json:"format,omitempty"`
	Type           []string             `json:"type,omitempty"`
	SubjectData    interface{}          `json:"subjectData,omitempty"`
	Issuer         interface{}          `json:"issuer,omitempty"`
	IssuanceDate   *util.TimeWrapper    `json:"issuanceDate,omitempty"`
	ExpirationDate *util.TimeWrapper    `json:"expirationDate,omitempty"`
	CustomClaims   map[string]Claims    `json:"customClaims,omitempty"`
}

type EventPayload added in v1.5.0 

type EventPayload struct {
	WebHook                  string  `json:"webHook,omitempty"`
	ProfileID                string  `json:"profileID,omitempty"`
	ProfileVersion           string  `json:"profileVersion,omitempty"`
	OrgID                    string  `json:"orgID,omitempty"`
	PresentationDefinitionID string  `json:"presentationDefinitionID,omitempty"`
	Filter                   *Filter `json:"filter,omitempty"`
	AuthorizationRequest     string  `json:"authorizationRequest,omitempty"`
	Error                    string  `json:"error,omitempty"`
	ErrorCode                string  `json:"errorCode,omitempty"`
	ErrorComponent           string  `json:"errorComponent,omitempty"`
}

type Filter added in v1.5.0 

type Filter struct {
	Fields []string `json:"fields"`
}

type InteractionInfo 

type InteractionInfo struct {
	AuthorizationRequest string
	TxID                 TxID
}

type JWSSigner 

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

func NewJWSSigner 

func NewJWSSigner(keyID string, signer vc.SignerAlgorithm) *JWSSigner

func (*JWSSigner) Headers 

func (s *JWSSigner) Headers() jose.Headers

Headers provides JWS headers. "alg" header must be provided (see https://tools.ietf.org/html/rfc7515#section-4.1)

func (*JWSSigner) Sign 

func (s *JWSSigner) Sign(data []byte) ([]byte, error)

Sign signs.

type ProcessedVPToken 

type ProcessedVPToken struct {
	Nonce         string
	ClientID      string
	SignerDIDID   string
	VpTokenFormat vcsverifiable.Format
	Presentation  *verifiable.Presentation
}

type ReceivedClaims 

type ReceivedClaims struct {
	CustomScopeClaims map[string]Claims
	Credentials       map[string]*verifiable.Credential
}

type ReceivedClaimsRaw 

type ReceivedClaimsRaw struct {
	Credentials       map[string][]byte `json:"credentials"`
	CustomScopeClaims map[string][]byte `json:"customScopeClaims,omitempty"`
}

ReceivedClaimsRaw is temporary struct for parsing to ReceivedClaims, as we need to unmarshal credentials separately.

type RequestObject 

type RequestObject struct {
	JTI          string                    `json:"jti"`
	IAT          int64                     `json:"iat"`
	ISS          string                    `json:"iss"`
	ResponseType string                    `json:"response_type"`
	ResponseMode string                    `json:"response_mode"`
	Scope        string                    `json:"scope"`
	Nonce        string                    `json:"nonce"`
	ClientID     string                    `json:"client_id"`
	RedirectURI  string                    `json:"redirect_uri"`
	State        string                    `json:"state"`
	Exp          int64                     `json:"exp"`
	Registration RequestObjectRegistration `json:"registration"`
	Claims       RequestObjectClaims       `json:"claims"`
}

RequestObject represents the request object sent to the wallet. It contains the presentation definition that specifies what verifiable credentials should be sent back by the wallet.

type RequestObjectClaims 

type RequestObjectClaims struct {
	VPToken VPToken `json:"vp_token"`
}

type RequestObjectRegistration 

type RequestObjectRegistration struct {
	ClientName                  string           `json:"client_name"`
	SubjectSyntaxTypesSupported []string         `json:"subject_syntax_types_supported"`
	VPFormats                   *presexch.Format `json:"vp_formats"`
	ClientPurpose               string           `json:"client_purpose"`
	LogoURI                     string           `json:"logo_uri"`
}

type Service 

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

func NewService 

func NewService(cfg *Config) *Service

func (*Service) DeleteClaims 

func (s *Service) DeleteClaims(_ context.Context, claimsID string) error

func (*Service) GetTx 

func (s *Service) GetTx(_ context.Context, id TxID) (*Transaction, error)

func (*Service) InitiateOidcInteraction 

func (s *Service) InitiateOidcInteraction(
	ctx context.Context,
	presentationDefinition *presexch.PresentationDefinition,
	purpose string,
	customScopes []string,
	profile *profileapi.Verifier,
) (*InteractionInfo, error)

func (*Service) RetrieveClaims 

func (s *Service) RetrieveClaims(
	ctx context.Context,
	tx *Transaction,
	profile *profileapi.Verifier,
) map[string]CredentialMetadata

func (*Service) VerifyOIDCVerifiablePresentation 

func (s *Service) VerifyOIDCVerifiablePresentation(
	ctx context.Context,
	txID TxID,
	authResponse *AuthorizationResponseParsed,
) error

type ServiceInterface 

type ServiceInterface interface {
	InitiateOidcInteraction(
		ctx context.Context,
		presentationDefinition *presexch.PresentationDefinition,
		purpose string,
		customScopes []string,
		profile *profileapi.Verifier,
	) (*InteractionInfo, error)
	VerifyOIDCVerifiablePresentation(ctx context.Context, txID TxID, authResponse *AuthorizationResponseParsed) error
	GetTx(ctx context.Context, id TxID) (*Transaction, error)
	RetrieveClaims(ctx context.Context, tx *Transaction, profile *profileapi.Verifier) map[string]CredentialMetadata
	DeleteClaims(ctx context.Context, receivedClaimsID string) error
}

type Transaction 

type Transaction struct {
	ID                     TxID
	ProfileID              string
	ProfileVersion         string
	PresentationDefinition *presexch.PresentationDefinition
	ReceivedClaims         *ReceivedClaims
	ReceivedClaimsID       string
	CustomScopes           []string
}

type TransactionUpdate 

type TransactionUpdate struct {
	ID               TxID
	ReceivedClaimsID string
}

type TxClaimsStore 

type TxClaimsStore txClaimsStore

type TxID 

type TxID string

type TxManager 

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

TxManager used to manage oidc transactions.

func NewTxManager 

func NewTxManager(
	store txNonceStore,
	txStore txStore,
	txClaimsStore txClaimsStore,
	dataProtector dataProtector,
	docLoader ld.DocumentLoader,
) *TxManager

NewTxManager creates TxManager.

func (*TxManager) ClaimsToClaimsRaw 

func (tm *TxManager) ClaimsToClaimsRaw(data *ReceivedClaims) (*ReceivedClaimsRaw, error)

func (*TxManager) CreateTx 

func (tm *TxManager) CreateTx(
	pd *presexch.PresentationDefinition,
	profileID, profileVersion string,
	customScopes []string,
) (*Transaction, string, error)

CreateTx creates transaction and generate one time access token.

func (*TxManager) DecryptClaims 

func (tm *TxManager) DecryptClaims(ctx context.Context, data *ClaimData) (*ReceivedClaims, error)

func (*TxManager) DeleteReceivedClaims 

func (tm *TxManager) DeleteReceivedClaims(claimsID string) error

func (*TxManager) EncryptClaims 

func (tm *TxManager) EncryptClaims(ctx context.Context, data *ReceivedClaims) (*ClaimData, error)

func (*TxManager) Get 

func (tm *TxManager) Get(txID TxID) (*Transaction, error)

Get transaction id.

func (*TxManager) GetByOneTimeToken 

func (tm *TxManager) GetByOneTimeToken(nonce string) (*Transaction, bool, error)

GetByOneTimeToken get transaction by nonce and then delete nonce.

func (*TxManager) StoreReceivedClaims 

func (tm *TxManager) StoreReceivedClaims(txID TxID, claims *ReceivedClaims) error

type TxNonceStore 

type TxNonceStore txNonceStore

type TxStore added in v1.6.0 

type TxStore txStore

type VPToken 

type VPToken struct {
	PresentationDefinition *presexch.PresentationDefinition `json:"presentation_definition"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.