cosigner

Documentation

Index

• type AuthCosigner
  • func New(signer crypto.Signer, alg jwa.SignatureAlgorithm, issuer, keyID string, ...) (*AuthCosigner, error)
  • func (c *AuthCosigner) InitAuth(pkt *pktoken.PKToken, sig []byte) (string, error)
  • func (c *AuthCosigner) IssueSignature(pkt *pktoken.PKToken, authState AuthState, authID string) ([]byte, error)
  • func (c *AuthCosigner) NewAuthcode(authID string) (string, error)
  • func (c *AuthCosigner) RedeemAuthcode(sig []byte) ([]byte, error)
• type AuthIDIssuer
  • func NewAuthIDIssuer(hmacKey []byte) *AuthIDIssuer
  • func (i *AuthIDIssuer) CreateAuthID(timeNow uint64) (string, error)
• type AuthState
  • func NewAuthState(pkt *pktoken.PKToken, ruri string, nonce string) (*AuthState, error)
  • func (as AuthState) UserKey() UserKey
• type AuthStateStore
• type Cosigner
  • func (c *Cosigner) Cosign(pkt *pktoken.PKToken, cosClaims pktoken.CosignerClaims) ([]byte, error)
• type CosignerVerifierOpts
• type DefaultCosignerVerifier
  • func NewCosignerVerifier(issuer string, options CosignerVerifierOpts) *DefaultCosignerVerifier
  • func (v *DefaultCosignerVerifier) Issuer() string
  • func (v *DefaultCosignerVerifier) Strict() bool
  • func (v *DefaultCosignerVerifier) VerifyCosigner(ctx context.Context, pkt *pktoken.PKToken) error
• type UserKey

Types

type AuthCosigner

type AuthCosigner struct {
	Cosigner
	Issuer         string
	KeyID          string
	AuthStateStore AuthStateStore
}

func New

func New(signer crypto.Signer, alg jwa.SignatureAlgorithm, issuer, keyID string, store AuthStateStore) (*AuthCosigner, error)

func (*AuthCosigner) InitAuth

func (c *AuthCosigner) InitAuth(pkt *pktoken.PKToken, sig []byte) (string, error)

func (*AuthCosigner) IssueSignature

func (c *AuthCosigner) IssueSignature(pkt *pktoken.PKToken, authState AuthState, authID string) ([]byte, error)

func (*AuthCosigner) NewAuthcode

func (c *AuthCosigner) NewAuthcode(authID string) (string, error)

func (*AuthCosigner) RedeemAuthcode

func (c *AuthCosigner) RedeemAuthcode(sig []byte) ([]byte, error)

type AuthIDIssuer

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

func NewAuthIDIssuer

func NewAuthIDIssuer(hmacKey []byte) *AuthIDIssuer

func (*AuthIDIssuer) CreateAuthID

func (i *AuthIDIssuer) CreateAuthID(timeNow uint64) (string, error)

type AuthState

type AuthState struct {
	Pkt              *pktoken.PKToken
	Issuer           string // ID Token issuer (iss)
	Aud              string // ID Token audience (aud)
	Sub              string // ID Token subject ID (sub)
	Username         string // ID Token email or username
	DisplayName      string // ID Token display name (or username if none given)
	RedirectURI      string // Redirect URI
	Nonce            string // Nonce supplied by user
	AuthcodeIssued   bool   // Has an authcode been issued for this auth session
	AuthcodeRedeemed bool   // Was the pkt cosigned
}

func NewAuthState

func NewAuthState(pkt *pktoken.PKToken, ruri string, nonce string) (*AuthState, error)

func (AuthState) UserKey

func (as AuthState) UserKey() UserKey

type AuthStateStore

type AuthStateStore interface {
	CreateNewAuthSession(pkt *pktoken.PKToken, ruri string, nonce string) (authID string, err error)
	LookupAuthState(authID string) (*AuthState, bool)
	UpdateAuthState(authID string, authState AuthState) error
	CreateAuthcode(authID string) (authcode string, err error)
	RedeemAuthcode(authcode string) (authState AuthState, authID string, err error)
}

type Cosigner

type Cosigner struct {
	Alg    jwa.KeyAlgorithm
	Signer crypto.Signer
}

func (*Cosigner) Cosign

func (c *Cosigner) Cosign(pkt *pktoken.PKToken, cosClaims pktoken.CosignerClaims) ([]byte, error)

type CosignerVerifierOpts

type CosignerVerifierOpts struct {
	// Strict specifies whether or not a pk token MUST contain a signature by this cosigner.
	// Defaults to true.
	Strict *bool
	// Allows users to set custom function for discovering public key of Cosigner
	DiscoverPublicKey *discover.PublicKeyFinder
}

type DefaultCosignerVerifier

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

func NewCosignerVerifier

func NewCosignerVerifier(issuer string, options CosignerVerifierOpts) *DefaultCosignerVerifier

func (*DefaultCosignerVerifier) Issuer

func (v *DefaultCosignerVerifier) Issuer() string

func (*DefaultCosignerVerifier) Strict

func (v *DefaultCosignerVerifier) Strict() bool

func (*DefaultCosignerVerifier) VerifyCosigner

func (v *DefaultCosignerVerifier) VerifyCosigner(ctx context.Context, pkt *pktoken.PKToken) error

type UserKey

type UserKey struct {
	Issuer string // ID Token issuer (iss)
	Aud    string // ID Token audience (aud)
	Sub    string // ID Token subject ID (sub)
}