bertyvcissuer

Documentation

Index

• Constants
• Variables
• func CodeGeneratorEightDigits(secret []byte) func(state *verifiablecredstypes.StateCode) (string, error)
• func CodeGeneratorZero(_ *verifiablecredstypes.StateCode) (string, error)
• func EmbeddedPublicKeyFetcher(issuerID, keyID string) (*verifier.PublicKey, error)
• func EmbeddedPublicKeyFetcherAllowList(allowList []string) func(issuerID, keyID string) (*verifier.PublicKey, error)
• func ExtractSubjectFromVC(credential *verifiable.Credential) (string, error)
• type Client
  • func NewClient(serverRoot string) *Client
  • func (c *Client) Complete(uri string) (string, string, *verifiable.Credential, error)
  • func (c *Client) Init(ctx context.Context, bertyURL string, accountPriv crypto.Signer) (string, error)
• type Config
• type CredentialSubject
• type FlowConfig
• type JSONChallenge
• type JSONError
• type PhoneCodeSenderMockService
  • func (m *PhoneCodeSenderMockService) SendVerificationCode(ctx context.Context, in SendVerificationCodeData) error
  • func (m *PhoneCodeSenderMockService) ValidateIdentifier(ctx context.Context, rawIdentifier string) (string, error)
• type SendVerificationCodeData
• type VCIssuer
  • func New(config *Config) (*VCIssuer, error)
  • func (i *VCIssuer) CreateSignedProof(bertyID string, identifier string) ([]byte, error)
  • func (i *VCIssuer) CreateSignedProofForPeriod(bertyID string, identifier string, issued time.Time, expired time.Time) ([]byte, error)
  • func (i *VCIssuer) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type VerificationCodeSender

Constants

const (
	PathChallenge    = "/challenge"
	PathAuthenticate = "/authenticate"
	PathProof        = "/proof"

	ParamBertyID      = "berty_id"
	ParamState        = "state"
	ParamRedirectURI  = "redirect_uri"
	ParamChallenge    = "challenge"
	ParamChallengeSig = "challenge_sig"
	ParamCode         = "code"
	ParamContext      = "context"
	ParamCredentials  = "credentials"
	ParamIdentifier   = "identifier"
)

const DefaultRedirectURI = "berty://vc"

Variables

var (
	ErrNewConfigMissing                  = fmt.Errorf("config is required")
	ErrNewConfigPrivateKeyMissing        = fmt.Errorf("issuer private key is required")
	ErrNewConfigFlowMissing              = fmt.Errorf("flow is missing")
	ErrNewConfigFlowTypeUnimplemented    = fmt.Errorf("unimplemented flow type")
	ErrNewConfigFlowTypeMissing          = fmt.Errorf("flow type is missing")
	ErrNewConfigFlowCodeGeneratorMissing = fmt.Errorf("code generator is missing")
	ErrNewConfigFlowCodeSenderMissing    = fmt.Errorf("code emitter endpoint is required")

	ErrFlowStateMissing       = fmt.Errorf("a state is required")
	ErrFlowRedirectURIMissing = fmt.Errorf("a redirect_uri is required")
	ErrChallengeAuthenticity  = fmt.Errorf("unable to certify challenge")
	ErrChallengeVerify        = fmt.Errorf("unable to verify challenge")
	ErrChallengeExpired       = fmt.Errorf("expired challenge")
	ErrChallengeFailed        = fmt.Errorf("unable to verify challenge signature")

	ErrMsgInvalidIdentifier    = "Invalid identifier"
	ErrMsgUnableToSendCode     = "Unable to send code"
	ErrMsgUnableToGenerateCode = "Unable to generate code"
	ErrMsgInvalidCode          = "Invalid code submitted"
)

Functions

func CodeGeneratorEightDigits

func CodeGeneratorEightDigits(secret []byte) func(state *verifiablecredstypes.StateCode) (string, error)

func CodeGeneratorZero

func CodeGeneratorZero(_ *verifiablecredstypes.StateCode) (string, error)

func EmbeddedPublicKeyFetcher

func EmbeddedPublicKeyFetcher(issuerID, keyID string) (*verifier.PublicKey, error)

func EmbeddedPublicKeyFetcherAllowList

func EmbeddedPublicKeyFetcherAllowList(allowList []string) func(issuerID, keyID string) (*verifier.PublicKey, error)

func ExtractSubjectFromVC

func ExtractSubjectFromVC(credential *verifiable.Credential) (string, error)

Types

type Client

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

func NewClient

func NewClient(serverRoot string) *Client

func (*Client) Complete

func (c *Client) Complete(uri string) (string, string, *verifiable.Credential, error)

func (*Client) Init

func (c *Client) Init(ctx context.Context, bertyURL string, accountPriv crypto.Signer) (string, error)

type Config

type Config struct {
	ServerRootURL string
	IssuerID      string
	IssuerSignKey *[32]byte
	Flow          *FlowConfig
	Logger        *zap.Logger
}

type CredentialSubject

type CredentialSubject struct {
	ID string `json:"id"`
}

type FlowConfig

type FlowConfig struct {
	Type             verifiablecredstypes.FlowType
	CodeGenerator    func(state *verifiablecredstypes.StateCode) (string, error)
	CodeSenderClient VerificationCodeSender
}

type JSONChallenge

type JSONChallenge struct {
	Challenge string `json:"challenge"`
}

type JSONError

type JSONError struct {
	Error string `json:"error"`
}

type PhoneCodeSenderMockService

type PhoneCodeSenderMockService struct {
	Logger *zap.Logger
}

func (*PhoneCodeSenderMockService) SendVerificationCode

func (m *PhoneCodeSenderMockService) SendVerificationCode(ctx context.Context, in SendVerificationCodeData) error

func (*PhoneCodeSenderMockService) ValidateIdentifier

func (m *PhoneCodeSenderMockService) ValidateIdentifier(ctx context.Context, rawIdentifier string) (string, error)

type SendVerificationCodeData

type SendVerificationCodeData struct {
	Recipient      string
	Code           string
	NetworkContext string
	Context        string
}

type VCIssuer

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

func New

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

func (*VCIssuer) CreateSignedProof

func (i *VCIssuer) CreateSignedProof(bertyID string, identifier string) ([]byte, error)

func (*VCIssuer) CreateSignedProofForPeriod

func (i *VCIssuer) CreateSignedProofForPeriod(bertyID string, identifier string, issued time.Time, expired time.Time) ([]byte, error)

func (*VCIssuer) ServeHTTP

func (i *VCIssuer) ServeHTTP(w http.ResponseWriter, r *http.Request)

type VerificationCodeSender

type VerificationCodeSender interface {
	SendVerificationCode(ctx context.Context, verificationData SendVerificationCodeData) error
	ValidateIdentifier(ctx context.Context, rawIdentifier string) (sanitized string, err error)
}