transfercoderepo

Documentation

Index

• func DeclineConsentByState(tx *sqlx.Tx, state *state.State) error
• func DeleteTransferCodeByState(tx *sqlx.Tx, state *state.State) error
• func LinkPollingCodeToMT(tx *sqlx.Tx, pollingCode, jwt string, mID mtid.MTID) error
• func PopTokenForTransferCode(tx *sqlx.Tx, pollingCode string, clientMetadata api.ClientMetaData) (jwt string, err error)
• type ShortToken
  • func NewShortToken(jwt string, mID mtid.MTID) (*ShortToken, error)
  • func ParseShortToken(token string) *ShortToken
  • func (pt ShortToken) Delete(tx *sqlx.Tx) error
  • func (pt *ShortToken) ID() string
  • func (pt *ShortToken) JWT(tx *sqlx.Tx) (jwt string, valid bool, err error)
  • func (pt *ShortToken) SetJWT(jwt string, mID mtid.MTID) (err error)
  • func (pt ShortToken) Store(tx *sqlx.Tx) error
  • func (pt ShortToken) String() string
  • func (pt ShortToken) Token() string
  • func (pt ShortToken) Update(tx *sqlx.Tx) error
• type TransferCode
  • func CreatePollingCode(pollingCode string, responseType model.ResponseType, maxTokenLen int) *TransferCode
  • func NewTransferCode(jwt string, mID mtid.MTID, newMT bool, responseType model.ResponseType) (*TransferCode, error)
  • func ParseTransferCode(token string) *TransferCode
  • func (pt TransferCode) Delete(tx *sqlx.Tx) error
  • func (tc TransferCode) GetRevokeJWT(tx *sqlx.Tx) (bool, error)
  • func (pt *TransferCode) ID() string
  • func (pt *TransferCode) JWT(tx *sqlx.Tx) (jwt string, valid bool, err error)
  • func (pt *TransferCode) SetJWT(jwt string, mID mtid.MTID) (err error)
  • func (tc TransferCode) Store(tx *sqlx.Tx) error
  • func (pt TransferCode) String() string
  • func (pt TransferCode) Token() string
  • func (pt TransferCode) Update(tx *sqlx.Tx) error
• type TransferCodeStatus
  • func CheckTransferCode(tx *sqlx.Tx, pollingCode string) (TransferCodeStatus, error)

Functions

func DeclineConsentByState

func DeclineConsentByState(tx *sqlx.Tx, state *state.State) error

DeclineConsentByState updates the polling code attribute after the consent has been declined

func DeleteTransferCodeByState

func DeleteTransferCodeByState(tx *sqlx.Tx, state *state.State) error

DeleteTransferCodeByState deletes a polling code

func LinkPollingCodeToMT

func LinkPollingCodeToMT(tx *sqlx.Tx, pollingCode, jwt string, mID mtid.MTID) error

LinkPollingCodeToMT links a pollingCode to a Mytoken

func PopTokenForTransferCode

func PopTokenForTransferCode(tx *sqlx.Tx, pollingCode string, clientMetadata api.ClientMetaData) (jwt string, err error)

PopTokenForTransferCode returns the decrypted token for a polling code and then deletes the entry

Types

type ShortToken

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

ShortToken holds database information of a short token

func NewShortToken

func NewShortToken(jwt string, mID mtid.MTID) (*ShortToken, error)

NewShortToken creates a new short token from the given jwt of a normal Mytoken

func ParseShortToken

func ParseShortToken(token string) *ShortToken

ParseShortToken creates a new short token from a short token string

func (ShortToken) Delete

func (pt ShortToken) Delete(tx *sqlx.Tx) error

Delete deletes the proxyToken from the database, it does not delete the linked Mytoken, the jwt should have been retrieved earlier and the Mytoken if desired be revoked separately

func (*ShortToken) ID

func (pt *ShortToken) ID() string

ID returns the id of this token

func (*ShortToken) JWT

func (pt *ShortToken) JWT(tx *sqlx.Tx) (jwt string, valid bool, err error)

JWT returns the decrypted jwt that is linked to this proxyToken

func (*ShortToken) SetJWT

func (pt *ShortToken) SetJWT(jwt string, mID mtid.MTID) (err error)

SetJWT sets the jwt for this proxyToken

func (ShortToken) Store

func (pt ShortToken) Store(tx *sqlx.Tx) error

Store stores the proxyToken

func (ShortToken) String

func (pt ShortToken) String() string

func (ShortToken) Token

func (pt ShortToken) Token() string

Token returns the token of this proxyToken

func (ShortToken) Update

func (pt ShortToken) Update(tx *sqlx.Tx) error

Update updates the jwt of the proxyToken

type TransferCode

type TransferCode struct {
	Attributes transferCodeAttributes
	// contains filtered or unexported fields
}

TransferCode is a type used to transfer a token

func CreatePollingCode

func CreatePollingCode(pollingCode string, responseType model.ResponseType, maxTokenLen int) *TransferCode

CreatePollingCode creates a polling code

func NewTransferCode

func NewTransferCode(jwt string, mID mtid.MTID, newMT bool, responseType model.ResponseType) (*TransferCode, error)

NewTransferCode creates a new TransferCode for the passed jwt

func ParseTransferCode

func ParseTransferCode(token string) *TransferCode

ParseTransferCode creates a new transfer code from a transfer code string

func (TransferCode) Delete

func (pt TransferCode) Delete(tx *sqlx.Tx) error

Delete deletes the proxyToken from the database, it does not delete the linked Mytoken, the jwt should have been retrieved earlier and the Mytoken if desired be revoked separately

func (TransferCode) GetRevokeJWT

func (tc TransferCode) GetRevokeJWT(tx *sqlx.Tx) (bool, error)

GetRevokeJWT returns a bool indicating if the linked jwt should also be revoked when this TransferCode is revoked or not

func (*TransferCode) ID

func (pt *TransferCode) ID() string

ID returns the id of this token

func (*TransferCode) JWT

func (pt *TransferCode) JWT(tx *sqlx.Tx) (jwt string, valid bool, err error)

JWT returns the decrypted jwt that is linked to this proxyToken

func (*TransferCode) SetJWT

func (pt *TransferCode) SetJWT(jwt string, mID mtid.MTID) (err error)

SetJWT sets the jwt for this proxyToken

func (TransferCode) Store

func (tc TransferCode) Store(tx *sqlx.Tx) error

Store stores the TransferCode in the database

func (TransferCode) String

func (pt TransferCode) String() string

func (TransferCode) Token

func (pt TransferCode) Token() string

Token returns the token of this proxyToken

func (TransferCode) Update

func (pt TransferCode) Update(tx *sqlx.Tx) error

Update updates the jwt of the proxyToken

type TransferCodeStatus

type TransferCodeStatus struct {
	Found           bool               `db:"found"`
	Expired         bool               `db:"expired"`
	ResponseType    model.ResponseType `db:"response_type"`
	ConsentDeclined db.BitBool         `db:"consent_declined"`
	MaxTokenLen     *int               `db:"max_token_len"`
}

TransferCodeStatus holds information about the status of a polling code

func CheckTransferCode

func CheckTransferCode(tx *sqlx.Tx, pollingCode string) (TransferCodeStatus, error)

CheckTransferCode checks the passed polling code in the database