storage

Documentation

Index

• Variables
• type AuthorizationCodeSession
• type AuthorizationCodeSessionReader
• type AuthorizationCodeSessionWriter
• type AuthorizationRequest
• type AuthorizationRequestReader
• type AuthorizationRequestWriter
• type Client
• type ClientReader
• type ClientWriter
• type DPoP
• type DeviceCodeSession
• type DeviceCodeSessionReader
• type DeviceCodeSessionWriter
• type Resource
• type ResourceReader
• type Token
• type TokenReader
• type TokenWriter

Variables

var ErrNotFound = errors.New("no result found")

ErrNotFound is returned when the query return no result.

Types

type AuthorizationCodeSession

type AuthorizationCodeSession interface {
	AuthorizationCodeSessionReader
	AuthorizationCodeSessionWriter
}

AuthorizationCodeSession describes user session operation contract.

type AuthorizationCodeSessionReader

type AuthorizationCodeSessionReader interface {
	Get(ctx context.Context, issuer, code string) (*sessionv1.AuthorizationCodeSession, error)
}

AuthorizationCodeSessionReader describes read-only storage operation contract.

type AuthorizationCodeSessionWriter

type AuthorizationCodeSessionWriter interface {
	Register(ctx context.Context, issuer, code string, s *sessionv1.AuthorizationCodeSession) (uint64, error)
	Delete(ctx context.Context, issuer, code string) error
}

AuthorizationCodeSessionWriter describes write-only operation contract.

type AuthorizationRequest

type AuthorizationRequest interface {
	AuthorizationRequestReader
	AuthorizationRequestWriter
}

AuthorizationRequest describes complete authorization request storage operation contract.

type AuthorizationRequestReader

type AuthorizationRequestReader interface {
	Get(ctx context.Context, issuer, requestURI string) (*flowv1.AuthorizationRequest, error)
}

AuthorizationRequestReader describes authorization request storage read-only operation contract.

type AuthorizationRequestWriter

type AuthorizationRequestWriter interface {
	Register(ctx context.Context, issuer, requestURI string, req *flowv1.AuthorizationRequest) (uint64, error)
	Delete(ctx context.Context, issuer, requestURI string) error
}

AuthorizationRequestWriter describes authorization request storage write-only operation contract.

type Client

type Client interface {
	ClientReader
	ClientWriter
}

Client describes complete client storage contract.

type ClientReader

type ClientReader interface {
	Get(ctx context.Context, id string) (*clientv1.Client, error)
	GetByName(ctx context.Context, name string) (*clientv1.Client, error)
}

ClientReader defines client storage read-only operation contract.

type ClientWriter

type ClientWriter interface {
	Register(ctx context.Context, c *clientv1.Client) (string, error)
}

ClientWriter describes client storage write-only operation contract.

type DPoP

type DPoP interface {
	Register(ctx context.Context, id string) error
	Delete(ctx context.Context, id string) error
	Exists(ctx context.Context, id string) (bool, error)
}

DPoP describes dpop proof jti storage to prevent dpop replay attack.

type DeviceCodeSession

type DeviceCodeSession interface {
	DeviceCodeSessionReader
	DeviceCodeSessionWriter
}

DeviceCodeSession describes deviceCode operation contract.

type DeviceCodeSessionReader

type DeviceCodeSessionReader interface {
	GetByDeviceCode(ctx context.Context, issuer, deviceCode string) (*sessionv1.DeviceCodeSession, error)
	GetByUserCode(ctx context.Context, issuer, userCode string) (*sessionv1.DeviceCodeSession, error)
}

DeviceCodeSessionReader describes deviceCode read-only operation contract.

type DeviceCodeSessionWriter

type DeviceCodeSessionWriter interface {
	Register(ctx context.Context, issuer, userCode string, r *sessionv1.DeviceCodeSession) (uint64, error)
	Delete(ctx context.Context, issuer, userCode string) error
	Validate(ctx context.Context, issuer, userCode string, r *sessionv1.DeviceCodeSession) error
}

DeviceCodeSessionWriter describes deviceCode write-only operation contract.

type Resource

type Resource interface {
	ResourceReader
}

type ResourceReader

type ResourceReader interface {
	GetByURI(ctx context.Context, urn string) (*resourcev1.Resource, error)
}

ResourceReader describes resource resolver contract.

type Token

type Token interface {
	TokenReader
	TokenWriter
}

Token describes accessToken operation contract.

type TokenReader

type TokenReader interface {
	Get(ctx context.Context, issuer, id string) (*tokenv1.Token, error)
	GetByValue(ctx context.Context, issuer, value string) (*tokenv1.Token, error)
}

TokenReader describes accessToken read-only operation storage contract.

type TokenWriter

type TokenWriter interface {
	Create(ctx context.Context, issuer string, t *tokenv1.Token) error
	Delete(ctx context.Context, issuer, id string) error
	Revoke(ctx context.Context, issuer, id string) error
}

TokenWriter describes accessToken write-only operation contract.