transfercoderepo

Documentation

Index

• func DeclineConsentByState(rlog log.Ext1FieldLogger, tx *sqlx.Tx, state *state.State) error
• func DeleteTransferCodeByState(rlog log.Ext1FieldLogger, tx *sqlx.Tx, state *state.State) error
• func LinkPollingCodeToMT(rlog log.Ext1FieldLogger, tx *sqlx.Tx, pollingCode, jwt string, mID mtid.MTID) error
• func LinkPollingCodeToSSHKey(rlog log.Ext1FieldLogger, tx *sqlx.Tx, pollingCode, sshKeyHash string) error
• func PopTokenForTransferCode(rlog log.Ext1FieldLogger, tx *sqlx.Tx, pollingCode string, ...) (jwt string, err 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 (tc TransferCode) GetRevokeJWT(rlog log.Ext1FieldLogger, tx *sqlx.Tx) (bool, error)
  • func (tc TransferCode) Store(rlog log.Ext1FieldLogger, tx *sqlx.Tx) error
• type TransferCodeStatus
  • func CheckTransferCode(rlog log.Ext1FieldLogger, tx *sqlx.Tx, pollingCode string) (TransferCodeStatus, error)

Functions

func DeclineConsentByState

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

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

func DeleteTransferCodeByState

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

DeleteTransferCodeByState deletes a polling code

func LinkPollingCodeToMT

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

LinkPollingCodeToMT links a pollingCode to a Mytoken

func LinkPollingCodeToSSHKey

func LinkPollingCodeToSSHKey(rlog log.Ext1FieldLogger, tx *sqlx.Tx, pollingCode, sshKeyHash string) error

LinkPollingCodeToSSHKey links a pollingCode to an ssh public key

func PopTokenForTransferCode

func PopTokenForTransferCode(
	rlog log.Ext1FieldLogger, 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 TransferCode

type TransferCode struct {
	shorttokenrepo.ProxyToken
	Attributes transferCodeAttributes
}

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) GetRevokeJWT

func (tc TransferCode) GetRevokeJWT(rlog log.Ext1FieldLogger, 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) Store

func (tc TransferCode) Store(rlog log.Ext1FieldLogger, tx *sqlx.Tx) error

Store stores the TransferCode in the database

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"`
	SSHKeyFingerprint db.NullString      `db:"ssh_key_fp"`
}

TransferCodeStatus holds information about the status of a polling code

func CheckTransferCode

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

CheckTransferCode checks the passed polling code in the database