sesh

Documentation

Overview

Package sesh provides functionality for setting and reading session data as cookies.

Index

• type CsrfSession
  • func (s CsrfSession) Valid() bool
• type DynamoClient
• type DynamoStore
  • func NewDynamoStore(dynamoClient DynamoClient, keyPairs ...[]byte) *DynamoStore
  • func (s *DynamoStore) Get(r *http.Request, name string) (*sessions.Session, error)
  • func (s *DynamoStore) New(r *http.Request, name string) (*sessions.Session, error)
  • func (s *DynamoStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
• type InvalidSessionError
  • func (e InvalidSessionError) Error() string
• type LoginSession
  • func (s LoginSession) SessionID() string
  • func (s LoginSession) Valid() bool
• type LpaDataSession
  • func (s LpaDataSession) Valid() bool
• type MissingSessionError
  • func (e MissingSessionError) Error() string
• type OneLoginSession
  • func (s OneLoginSession) Valid() bool
• type PaymentSession
  • func (s PaymentSession) Valid() bool
• type Store
  • func NewStore(dynamoClient DynamoClient, keyPairs [][]byte) *Store
  • func (s *Store) ClearLogin(r *http.Request, w http.ResponseWriter) error
  • func (s *Store) ClearPayment(r *http.Request, w http.ResponseWriter) error
  • func (s *Store) Csrf(r *http.Request) (*CsrfSession, error)
  • func (s *Store) Login(r *http.Request) (*LoginSession, error)
  • func (s *Store) LpaData(r *http.Request) (*LpaDataSession, error)
  • func (s *Store) OneLogin(r *http.Request) (*OneLoginSession, error)
  • func (s *Store) Payment(r *http.Request) (*PaymentSession, error)
  • func (s *Store) SetCsrf(r *http.Request, w http.ResponseWriter, csrfSession *CsrfSession) error
  • func (s *Store) SetLogin(r *http.Request, w http.ResponseWriter, donorSession *LoginSession) error
  • func (s *Store) SetLpaData(r *http.Request, w http.ResponseWriter, lpaDataSession *LpaDataSession) error
  • func (s *Store) SetOneLogin(r *http.Request, w http.ResponseWriter, oneLoginSession *OneLoginSession) error
  • func (s *Store) SetPayment(r *http.Request, w http.ResponseWriter, paymentSession *PaymentSession) error

Types

type CsrfSession

type CsrfSession struct {
	IsNew bool
	Token string
}

func (CsrfSession) Valid

func (s CsrfSession) Valid() bool

type DynamoClient

type DynamoClient interface {
	Create(ctx context.Context, v any) error
	One(ctx context.Context, pk dynamo.PK, sk dynamo.SK, v any) error
	DeleteOne(ctx context.Context, pk dynamo.PK, sk dynamo.SK) error
}

type DynamoStore

type DynamoStore struct {
	Codecs  []securecookie.Codec
	Options *sessions.Options
	// contains filtered or unexported fields
}

DynamoStore stores sessions in DynamoDB.

func NewDynamoStore

func NewDynamoStore(dynamoClient DynamoClient, keyPairs ...[]byte) *DynamoStore

func (*DynamoStore) Get

func (s *DynamoStore) Get(r *http.Request, name string) (*sessions.Session, error)

func (*DynamoStore) New

func (s *DynamoStore) New(r *http.Request, name string) (*sessions.Session, error)

func (*DynamoStore) Save

func (s *DynamoStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

type InvalidSessionError

type InvalidSessionError string

func (InvalidSessionError) Error

func (e InvalidSessionError) Error() string

type LoginSession

type LoginSession struct {
	IDToken          string
	Sub              string
	Email            string
	OrganisationID   string
	OrganisationName string
}

func (LoginSession) SessionID

func (s LoginSession) SessionID() string

SessionID is a safe version of the OneLogin sub, that is used to form DynamoDB keys. Note: this is not the identifier stored in the "session" cookie.

func (LoginSession) Valid

func (s LoginSession) Valid() bool

type LpaDataSession

type LpaDataSession struct {
	LpaID string
}

func (LpaDataSession) Valid

func (s LpaDataSession) Valid() bool

type MissingSessionError

type MissingSessionError string

func (MissingSessionError) Error

func (e MissingSessionError) Error() string

type OneLoginSession

type OneLoginSession struct {
	State     string
	Nonce     string
	Locale    string
	Redirect  string
	SessionID string
	LpaID     string
}

func (OneLoginSession) Valid

func (s OneLoginSession) Valid() bool

type PaymentSession

type PaymentSession struct {
	PaymentID string
}

func (PaymentSession) Valid

func (s PaymentSession) Valid() bool

type Store

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

func NewStore

func NewStore(dynamoClient DynamoClient, keyPairs [][]byte) *Store

func (*Store) ClearLogin

func (s *Store) ClearLogin(r *http.Request, w http.ResponseWriter) error

func (*Store) ClearPayment

func (s *Store) ClearPayment(r *http.Request, w http.ResponseWriter) error

func (*Store) Csrf

func (s *Store) Csrf(r *http.Request) (*CsrfSession, error)

func (*Store) Login

func (s *Store) Login(r *http.Request) (*LoginSession, error)

func (*Store) LpaData

func (s *Store) LpaData(r *http.Request) (*LpaDataSession, error)

func (*Store) OneLogin

func (s *Store) OneLogin(r *http.Request) (*OneLoginSession, error)

func (*Store) Payment

func (s *Store) Payment(r *http.Request) (*PaymentSession, error)

func (*Store) SetCsrf

func (s *Store) SetCsrf(r *http.Request, w http.ResponseWriter, csrfSession *CsrfSession) error

func (*Store) SetLogin

func (s *Store) SetLogin(r *http.Request, w http.ResponseWriter, donorSession *LoginSession) error

func (*Store) SetLpaData

func (s *Store) SetLpaData(r *http.Request, w http.ResponseWriter, lpaDataSession *LpaDataSession) error

func (*Store) SetOneLogin

func (s *Store) SetOneLogin(r *http.Request, w http.ResponseWriter, oneLoginSession *OneLoginSession) error

func (*Store) SetPayment

func (s *Store) SetPayment(r *http.Request, w http.ResponseWriter, paymentSession *PaymentSession) error