oidc4ci

package

Go to main page

Versions in this module

v1

v1.12.0

Dec 17, 2024

Changes in this version

type Ack

+ CredentialsIssued int

type AckRemote

+ InteractionDetails map[string]interface{}

+ TxID issuecredential.TxID

type AckService

+ func (s *AckService) UpsertAck(ctx context.Context, ack *Ack) (string, error)

type Config

+ WellKnownProvider wellKnownProvider

type EventPayload

+ InteractionDetails map[string]interface{}

type PrepareCredentialResult

+ NotificationID string

v1.11.0

Oct 10, 2024

Changes in this version

type Config

+ PrepareCredential credentialIssuer

type EventPayload

+ CredentialIDs []string

v1.10.0

Jul 10, 2024

Changes in this version

type Config

+ DocumentLoader documentLoader

type InitiateIssuanceComposeCredential

+ PerformStrictValidation bool

v1.8.1

Apr 10, 2024

v1.8.0

Apr 8, 2024

Changes in this version

+ const ClaimDataTypeClaims

+ const ClaimDataTypeVC

+ const GrantTypeAuthorizationCode

+ const GrantTypePreAuthorizedCode

+ const TxCodeLength

type AckRemote

+ Event string

+ EventDescription string

type AuthorizationDetails

+ CredentialConfigurationID string

+ CredentialDefinition *CredentialDefinition

+ CredentialIdentifiers []string

+ func (ad *AuthorizationDetails) ToDTO() common.AuthorizationDetails

+ type ClaimDataType int16

type Config

+ Composer composer

+ TrustRegistry trustRegistry

+ type CredentialComposeConfiguration struct

+ IDTemplate string

+ OverrideIssuer bool

+ OverrideSubjectDID bool

+ type CredentialComposer struct

+ func NewCredentialComposer() *CredentialComposer

+ func (c *CredentialComposer) Compose(_ context.Context, credential *verifiable.Credential, tx *Transaction, ...) (*verifiable.Credential, error)

+ type CredentialDefinition struct

+ Context []string

+ CredentialSubject map[string]interface{}

+ Type []string

type CredentialOfferResponse

+ CredentialConfigurationIDs []string

type EventPayload

+ Credentials map[string]vcsverifiable.OIDCFormat

+ type ExchangeAuthorizationCodeResult struct

+ AuthorizationDetails []*AuthorizationDetails

+ TxID TxID

+ type InitiateIssuanceComposeCredential struct

+ Credential *map[string]interface{}

+ IDTemplate string

+ OverrideIssuer bool

+ OverrideSubjectDID bool

+ type InitiateIssuanceCredentialConfiguration struct

+ ClaimData map[string]interface{}

+ ClaimEndpoint string

+ ComposeCredential *InitiateIssuanceComposeCredential

+ CredentialDescription string

+ CredentialExpiresAt *time.Time

+ CredentialName string

+ CredentialTemplateID string

type InitiateIssuanceRequest

+ CredentialConfiguration []InitiateIssuanceCredentialConfiguration

type PreAuthorizationGrant

+ TxCode *TxCode

type PrepareCredential

+ CredentialRequests []*PrepareCredentialRequest

+ type PrepareCredentialRequest struct

+ AudienceClaim string

+ CredentialFormat vcsverifiable.OIDCFormat

+ CredentialTypes []string

+ DID string

+ HashedToken string

type PrepareCredentialResult

+ Credentials []*PrepareCredentialResultData

+ type PrepareCredentialResultData struct

+ Credential *verifiable.Credential

+ CredentialTemplate *profileapi.CredentialTemplate

+ EnforceStrictValidation bool

+ Format vcsverifiable.Format

+ NotificationID *string

+ OidcFormat vcsverifiable.OIDCFormat

+ Retry bool

type TransactionData

+ CredentialConfiguration []*TxCredentialConfiguration

+ type TxCode struct

+ Description string

+ InputMode string

+ Length int

+ type TxCredentialConfiguration struct

+ AuthorizationDetails *AuthorizationDetails

+ ClaimDataID string

+ ClaimDataType ClaimDataType

+ ClaimEndpoint string

+ CredentialComposeConfiguration *CredentialComposeConfiguration

+ CredentialConfigurationID string

+ CredentialDescription string

+ CredentialExpiresAt *time.Time

+ CredentialName string

+ CredentialTemplate *profileapi.CredentialTemplate

+ ID string

+ OIDCCredentialFormat vcsverifiable.OIDCFormat

+ PreAuthCodeExpiresAt *time.Time

v1.6.0

Feb 6, 2024

Changes in this version

+ var ErrAckExpired = errors.New("expired_ack_id")

+ type Ack struct

+ HashedToken string

+ OrgID string

+ ProfileID string

+ ProfileVersion string

+ TxID TxID

+ WebHookURL string

+ type AckRemote struct

+ ErrorText string

+ HashedToken string

+ ID string

+ IssuerIdentifier string

+ Status string

+ type AckService struct

+ func NewAckService(cfg *AckServiceConfig) *AckService

+ func (s *AckService) Ack(ctx context.Context, req AckRemote) error

+ func (s *AckService) AckEventMap(status string) (spi.EventType, error)

+ func (s *AckService) CreateAck(ctx context.Context, ack *Ack) (*string, error)

+ func (s *AckService) HandleAckNotFound(ctx context.Context, req AckRemote) error

+ type AckServiceConfig struct

+ AckStore ackStore

+ EventSvc eventService

+ EventTopic string

+ ProfileSvc profileService

type Config

+ AckService ackService

+ ClientAttestationService clientAttestationService

type PrepareCredential

+ HashedToken string

type PrepareCredentialResult

+ AckID *string

type Service

+ func (s *Service) AuthenticateClient(ctx context.Context, profile *profile.Issuer, ...) error

v1.5.0

Oct 27, 2023

Changes in this version

type Config

+ JSONSchemaValidator jsonSchemaValidator

+ type EventPayload struct

+ AuthorizationEndpoint string

+ CredentialTemplateID string

+ Error string

+ ErrorCode string

+ ErrorComponent string

+ Format string

+ InitiateIssuanceURL string

+ OrgID string

+ PinRequired bool

+ PreAuthFlow bool

+ ProfileID string

+ ProfileVersion string

+ WalletInitiatedFlow bool

+ WebHook string

+ type IssuerIDPOIDCConfiguration struct

+ AuthorizationEndpoint string

+ GrantTypesSupported []string

+ InitiateIssuanceEndpoint string

+ PushedAuthorizationRequestEndpoint string

+ ResponseTypesSupported []string

+ ScopesSupported []string

+ TokenEndpoint string

v1.3.0

Sep 14, 2023

Changes in this version

type Config

+ CryptoJWTSigner cryptoJWTSigner

+ KMSRegistry kmsRegistry

type InitiateIssuanceResponse

+ ContentType InitiateIssuanceResponseContentType

+ type InitiateIssuanceResponseContentType = string

+ const ContentTypeApplicationJSON

+ const ContentTypeApplicationJWT

+ type JWTCredentialOfferClaims struct

+ CredentialOffer *CredentialOfferResponse

v1.2.0

Aug 29, 2023

Changes in this version

+ const WalletInitFlowClaimExpectedMatchCount

+ var ErrInvalidIssuerURL = errors.New("invalid issuer url")

+ func ExtractIssuerURL(input string) string

type AuthorizeState

+ WalletInitiatedFlow *common.WalletInitiatedFlowData

type InitiateIssuanceRequest

+ WalletInitiatedIssuance bool

type InitiateIssuanceResponse

+ Tx *Transaction

type PrepareClaimDataAuthorizationResponse

+ WalletInitiatedFlow *common.WalletInitiatedFlowData

type PrepareCredentialResult

+ CredentialTemplate *profileapi.CredentialTemplate

type TransactionData

+ WalletInitiatedIssuance bool

v1.1.0

Jul 12, 2023

Changes in this version

type PrepareCredential

+ AudienceClaim string

v1.0.0

May 9, 2023

Changes in this version

+ const TransactionStateAwaitingIssuerOIDCAuthorization

+ const TransactionStateCredentialsIssued

+ const TransactionStateIssuanceInitiated

+ const TransactionStateIssuerOIDCAuthorizationDone

+ const TransactionStatePreAuthCodeValidated

+ const TransactionStateUnknown

+ var ErrAuthorizedCodeFlowNotSupported = errors.New("authorized code flow not supported")

+ var ErrCredentialFormatNotSupported = errors.New("credential format not supported")

+ var ErrCredentialTemplateIDRequired = errors.New("credential template ID is required")

+ var ErrCredentialTemplateNotConfigured = errors.New("credential template not configured")

+ var ErrCredentialTemplateNotFound = errors.New("credential template not found")

+ var ErrCredentialTypeNotSupported = errors.New("credential type not supported")

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

+ var ErrInvalidScope = errors.New("invalid scope")

+ var ErrOpStateKeyDuplication = errors.New("op state key duplication")

+ var ErrProfileNotActive = errors.New("profile not active")

+ var ErrResponseTypeMismatch = errors.New("response type mismatch")

+ var ErrVCOptionsNotConfigured = errors.New("vc options not configured")

+ func WithDocumentTTL(ttl time.Duration) func(insertOptions *InsertOptions)

+ type AuthorizationCodeGrant struct

+ IssuerState string

+ type AuthorizationDetails struct

+ Format vcsverifiable.Format

+ Locations []string

+ Type string

+ Types []string

+ type AuthorizeState struct

+ Header map[string][]string

+ Parameters map[string][]string

+ RedirectURI *url.URL

+ RespondMode string

+ type ClaimData struct

+ EncryptedData *dataprotect.EncryptedData

+ type ClaimDataStore claimDataStore

+ type Config struct

+ ClaimDataStore claimDataStore

+ CredentialOfferReferenceStore credentialOfferReferenceStore

+ DataProtector dataProtector

+ EventService eventService

+ EventTopic string

+ HTTPClient httpClient

+ IssuerVCSPublicHost string

+ OAuth2Client oAuth2Client

+ PinGenerator pinGenerator

+ PreAuthCodeTTL int32

+ ProfileService profileService

+ TransactionStore transactionStore

+ WellKnownService wellKnownService

+ type CredentialOffer struct

+ Format vcsverifiable.OIDCFormat

+ Types []string

+ type CredentialOfferGrant struct

+ AuthorizationCode *AuthorizationCodeGrant

+ PreAuthorizationGrant *PreAuthorizationGrant

+ type CredentialOfferResponse struct

+ CredentialIssuer string

+ Credentials []CredentialOffer

+ Grants CredentialOfferGrant

+ type InitiateIssuanceRequest struct

+ ClaimData map[string]interface{}

+ ClaimEndpoint string

+ ClientInitiateIssuanceURL string

+ ClientWellKnownURL string

+ CredentialDescription string

+ CredentialExpiresAt *time.Time

+ CredentialName string

+ CredentialTemplateID string

+ GrantType string

+ OpState string

+ ResponseType string

+ Scope []string

+ UserPinRequired bool

+ type InitiateIssuanceResponse struct

+ InitiateIssuanceURL string

+ TxID TxID

+ UserPin string

+ type InsertOptions struct

+ TTL time.Duration

+ type OIDCConfiguration struct

+ AuthorizationEndpoint string

+ GrantTypesSupported []string

+ InitiateIssuanceEndpoint string

+ PushedAuthorizationRequestEndpoint string

+ ResponseTypesSupported []string

+ ScopesSupported []string

+ TokenEndpoint string

+ type PreAuthorizationGrant struct

+ PreAuthorizedCode string

+ UserPinRequired bool

+ type PrepareClaimDataAuthorizationRequest struct

+ AuthorizationDetails *AuthorizationDetails

+ OpState string

+ ResponseType string

+ Scope []string

+ type PrepareClaimDataAuthorizationResponse struct

+ AuthorizationEndpoint string

+ ProfileID profileapi.ID

+ ProfileVersion profileapi.Version

+ PushedAuthorizationRequestEndpoint string

+ ResponseType string

+ Scope []string

+ TxID TxID

+ type PrepareCredential struct

+ CredentialFormat vcsverifiable.Format

+ CredentialTypes []string

+ DID string

+ TxID TxID

+ type PrepareCredentialResult struct

+ Credential *verifiable.Credential

+ EnforceStrictValidation bool

+ Format vcsverifiable.Format

+ OidcFormat vcsverifiable.OIDCFormat

+ ProfileID profileapi.ID

+ ProfileVersion profileapi.Version

+ Retry bool

+ type Service struct

+ func NewService(config *Config) (*Service, error)

+ func (s *Service) DecryptClaims(ctx context.Context, data *ClaimData) (map[string]interface{}, error)

+ func (s *Service) EncryptClaims(ctx context.Context, data map[string]interface{}) (*ClaimData, error)

+ func (s *Service) ExchangeAuthorizationCode(ctx context.Context, opState string) (TxID, error)

+ func (s *Service) GetCredentialsExpirationTime(req *InitiateIssuanceRequest, template *profileapi.CredentialTemplate) time.Time

+ func (s *Service) InitiateIssuance(ctx context.Context, req *InitiateIssuanceRequest, profile *profileapi.Issuer) (*InitiateIssuanceResponse, error)

+ func (s *Service) PrepareClaimDataAuthorizationRequest(ctx context.Context, req *PrepareClaimDataAuthorizationRequest) (*PrepareClaimDataAuthorizationResponse, error)

+ func (s *Service) PrepareCredential(ctx context.Context, req *PrepareCredential) (*PrepareCredentialResult, error)

+ func (s *Service) PushAuthorizationDetails(ctx context.Context, opState string, ad *AuthorizationDetails) error

+ func (s *Service) SelectProperOIDCFormat(format verifiable.Format, template *profileapi.CredentialTemplate) verifiable.OIDCFormat

+ func (s *Service) StoreAuthorizationCode(ctx context.Context, opState string, code string) (TxID, error)

+ func (s *Service) ValidatePreAuthorizedCodeRequest(ctx context.Context, preAuthorizedCode string, pin string) (*Transaction, error)

+ type ServiceInterface interface

+ ExchangeAuthorizationCode func(ctx context.Context, opState string) (TxID, error)

+ InitiateIssuance func(ctx context.Context, req *InitiateIssuanceRequest, profile *profileapi.Issuer) (*InitiateIssuanceResponse, error)

+ PrepareClaimDataAuthorizationRequest func(ctx context.Context, req *PrepareClaimDataAuthorizationRequest) (*PrepareClaimDataAuthorizationResponse, error)

+ PrepareCredential func(ctx context.Context, req *PrepareCredential) (*PrepareCredentialResult, error)

+ PushAuthorizationDetails func(ctx context.Context, opState string, ad *AuthorizationDetails) error

+ StoreAuthorizationCode func(ctx context.Context, opState string, code string) (TxID, error)

+ ValidatePreAuthorizedCodeRequest func(ctx context.Context, preAuthorizedCode string, pin string) (*Transaction, error)

+ type Transaction struct

+ ID TxID

+ type TransactionData struct

+ AuthorizationDetails *AuthorizationDetails

+ AuthorizationEndpoint string

+ ClaimDataID string

+ ClaimEndpoint string

+ ClientScope []string

+ CredentialDescription string

+ CredentialExpiresAt *time.Time

+ CredentialFormat vcsverifiable.Format

+ CredentialName string

+ CredentialTemplate *profileapi.CredentialTemplate

+ DID string

+ GrantType string

+ IsPreAuthFlow bool

+ IssuerAuthCode string

+ IssuerToken string

+ OIDCCredentialFormat vcsverifiable.OIDCFormat

+ OpState string

+ OrgID string

+ PreAuthCode string

+ PreAuthCodeExpiresAt *time.Time

+ ProfileID profileapi.ID

+ ProfileVersion profileapi.Version

+ PushedAuthorizationRequestEndpoint string

+ RedirectURI string

+ ResponseType string

+ Scope []string

+ State TransactionState

+ TokenEndpoint string

+ UserPin string

+ WebHookURL string

+ type TransactionState int16

+ type TransactionStore transactionStore

+ type TxID string

v1.0.0-rc3

Mar 10, 2023

v1.0.0-rc2

Mar 10, 2023

v1.0.0-rc1

Feb 27, 2023

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL