operation

Documentation

Index

• Constants
• type AuthorizationCredentialHandle
• type AuthorizationCredentialReq
• type CHAPIQuery
• type Config
• type CredentialHandlerRequest
• type IssuerTokenReq
• type IssuerTokenResp
• type OIDCClientParams
• type Operation
  • func New(config *Config) (*Operation, error)
  • func (o *Operation) GetRESTHandlers() []restapi.Handler
• type ProfileDataRequest
• type PublicDIDCreator
• type ReferenceCredentialData
• type UserConnectionMapping
• type UserDataReq
• type UserDataRes
• type UserInvitationMapping
• type UserMetadata
• type ValidateConnectResp
• type WalletConnect

Constants

const (

	// DIDConnectCHAPIQueryType CHAPI query type DIDConnect
	DIDConnectCHAPIQueryType = "DIDConnect"
)

Types

type AuthorizationCredentialHandle

type AuthorizationCredentialHandle struct {
	ID               string `json:"id,omitempty"`
	IssuerDID        string `json:"issuerDID,omitempty"`
	SubjectDID       string `json:"subjectDID,omitempty"`
	RPDID            string `json:"rpDID,omitempty"`
	UserConnectionID string `json:"userConnectionID,omitempty"`
	RPConnectionID   string `json:"rpConnectionID,omitempty"`
	Token            string `json:"token,omitempty"`
	IssuerID         string `json:"issuerID,omitempty"`
	OauthID          string `json:"oauthid,omitempty"`
}

AuthorizationCredentialHandle stores authorization credential related data.

type AuthorizationCredentialReq

type AuthorizationCredentialReq struct {
	SubjectDIDDoc *adaptervc.DIDDoc `json:"subjectDIDDoc,omitempty"`
	RPDIDDoc      *adaptervc.DIDDoc `json:"requestingPartyDIDDoc,omitempty"`
}

AuthorizationCredentialReq authorization credential request from wallet.

type CHAPIQuery

type CHAPIQuery struct {
	Type string `json:"type,omitempty"`
}

CHAPIQuery chapi query type data.

type Config

type Config struct {
	AriesCtx             aries.CtxProvider
	AriesMessenger       service.Messenger
	MsgRegistrar         *msghandler.Registrar
	UIEndpoint           string
	StoreProvider        storage.Provider
	PublicDIDCreator     PublicDIDCreator
	TLSConfig            *tls.Config
	WalletBridgeAppURL   string
	OIDCClientStoreKey   []byte
	ExternalURL          string
	DidDomain            string
	JSONLDDocumentLoader ld.DocumentLoader
	CMDescriptors        cmDescriptorProvider
}

Config defines configuration for issuer operations. TODO #580 Create helper function for cmDescriptors

type CredentialHandlerRequest

type CredentialHandlerRequest struct {
	Query             *CHAPIQuery               `json:"query,omitempty"`
	DIDCommInvitation *wallet.GenericInvitation `json:"invitation,omitempty"`
	Credentials       []json.RawMessage         `json:"credentials,omitempty"`
	WACI              bool                      `json:"waci,omitempty"`
	WalletRedirect    string                    `json:"walletRedirect,omitempty"`
}

CredentialHandlerRequest wallet chapi request.

type IssuerTokenReq

type IssuerTokenReq struct {
	State string `json:"state,omitempty"`
}

IssuerTokenReq issuer user data token request.

type IssuerTokenResp

type IssuerTokenResp struct {
	Token  string `json:"token,omitempty"`
	UserID string `json:"userid,omitempty"`
}

IssuerTokenResp issuer user data token response.

type OIDCClientParams

type OIDCClientParams struct {
	ClientID     string `json:"client_id"`
	ClientSecret string `json:"client_secret"`
	SecretExpiry int    `json:"client_secret_expires_at"`
}

OIDCClientParams optional parameters for setting the adapter's oidc client parameters statically.

type Operation

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

Operation defines handlers for rp operations.

func New

func New(config *Config) (*Operation, error)

New returns issuer rest instance.

func (*Operation) GetRESTHandlers

func (o *Operation) GetRESTHandlers() []restapi.Handler

GetRESTHandlers get all controller API handler available for this service.

type ProfileDataRequest

type ProfileDataRequest struct {
	ID                          string            `json:"id,omitempty"`
	Name                        string            `json:"name"`
	SupportedVCContexts         []string          `json:"supportedVCContexts"`
	SupportsAssuranceCredential bool              `json:"supportsAssuranceCredential"`
	RequiresBlindedRoute        bool              `json:"requiresBlindedRoute"`
	URL                         string            `json:"url"`
	SupportsWACI                bool              `json:"supportsWACI"`
	OIDCProviderURL             string            `json:"oidcProvider"`
	OIDCClientParams            *OIDCClientParams `json:"oidcParams,omitempty"`
	CredentialScopes            []string          `json:"scopes,omitempty"`
	LinkedWalletURL             string            `json:"linkedWallet,omitempty"`
	IsDIDCommV1                 bool              `json:"isDIDCommV1,omitempty"`
	// Issuer ID identifies who is the issuer of the credential manifests being issued.
	IssuerID string `json:"issuerID,omitempty"`
	// CMStyle represents an entity styles object as defined in credential manifest spec.
	CMStyle cm.Styles `json:"styles,omitempty"`
}

ProfileDataRequest req for profile creation.

type PublicDIDCreator

type PublicDIDCreator interface {
	Create() (*did.Doc, error)
	CreateV2() (*did.Doc, error)
}

PublicDIDCreator creates public DIDs.

type ReferenceCredentialData

type ReferenceCredentialData struct {
	ID string `json:"id,omitempty"`
}

ReferenceCredentialData reference credential data.

type UserConnectionMapping

type UserConnectionMapping struct {
	ConnectionID string `json:"connectionID,omitempty"`
	IssuerID     string `json:"issuerID,omitempty"`
	Token        string `json:"token,omitempty"`
	TxnID        string `json:"oauthid,omitempty"`
	State        string `json:"state,omitempty"`
}

UserConnectionMapping stores mapping between the connectionID and issuer.

type UserDataReq

type UserDataReq struct {
	Token string `json:"token,omitempty"`
}

UserDataReq request to issuer for the user data.

type UserDataRes

type UserDataRes struct {
	Data     json.RawMessage `json:"data,omitempty"`
	Metadata *UserMetadata   `json:"metadata,omitempty"`
}

UserDataRes response from the issuer for user data.

type UserInvitationMapping

type UserInvitationMapping struct {
	InvitationID string `json:"invitationID,omitempty"`
	IssuerID     string `json:"issuerID,omitempty"`
	TxID         string `json:"txID,omitempty"`
	TxToken      string `json:"txtoken,omitempty"`
	State        string `json:"state,omitempty"`
}

UserInvitationMapping stores mapping between the inviationID and issuer.

type UserMetadata

type UserMetadata struct {
	Contexts    []string `json:"contexts,omitempty"`
	Scopes      []string `json:"scopes,omitempty"`
	Name        string   `json:"name,omitempty"`
	Description string   `json:"description,omitempty"`
}

UserMetadata contains metadata associated with user data.

type ValidateConnectResp

type ValidateConnectResp struct {
	RedirectURL string `json:"redirectURL,omitempty"`
}

ValidateConnectResp response from validate connect api.

type WalletConnect

type WalletConnect struct {
	Resp json.RawMessage `json:"walletResp,omitempty"`
}

WalletConnect response from wallet.