Documentation
¶
Index ¶
- Constants
- Variables
- func RedirectOnAuthenticated(c configuration.Provider) httprouter.Handle
- func RedirectOnUnauthenticated(to string) httprouter.Handle
- func RespondWithJSONErrorOnAuthenticated(h herodot.Writer, err error) httprouter.Handle
- func TestPersister(p interface{ ... }) func(t *testing.T)
- type Device
- type Handler
- func (h *Handler) IsAuthenticated(wrap httprouter.Handle, onUnauthenticated httprouter.Handle) httprouter.Handle
- func (h *Handler) IsNotAuthenticated(wrap httprouter.Handle, onAuthenticated httprouter.Handle) httprouter.Handle
- func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin)
- func (h *Handler) RegisterPublicRoutes(public *x.RouterPublic)
- type HandlerProvider
- type ManagementProvider
- type Manager
- type ManagerHTTP
- func (s *ManagerHTTP) CreateAndIssueCookie(ctx context.Context, w http.ResponseWriter, r *http.Request, ss *Session) error
- func (s *ManagerHTTP) FetchFromRequest(ctx context.Context, r *http.Request) (*Session, error)
- func (s *ManagerHTTP) IssueCookie(ctx context.Context, w http.ResponseWriter, r *http.Request, session *Session) error
- func (s *ManagerHTTP) PurgeFromRequest(ctx context.Context, w http.ResponseWriter, r *http.Request) error
- type PersistenceProvider
- type Persister
- type Session
Constants ¶
View Source
const ( RouteWhoami = "/sessions/whoami" RouteRevoke = "/sessions" )
View Source
const DefaultSessionCookieName = "ory_kratos_session"
DefaultSessionCookieName returns the default cookie name for the kratos session.
Variables ¶
View Source
var ( // ErrNoActiveSessionFound is returned when no active cookie session could be found in the request. ErrNoActiveSessionFound = herodot.ErrUnauthorized.WithError("request does not have a valid authentication session").WithReason("No active session was found in this request.") )
Functions ¶
func RedirectOnAuthenticated ¶
func RedirectOnAuthenticated(c configuration.Provider) httprouter.Handle
func RedirectOnUnauthenticated ¶
func RedirectOnUnauthenticated(to string) httprouter.Handle
func RespondWithJSONErrorOnAuthenticated ¶
func RespondWithJSONErrorOnAuthenticated(h herodot.Writer, err error) httprouter.Handle
func TestPersister ¶
func TestPersister(p interface {
Persister
identity.PrivilegedPool
}) func(t *testing.T)
Types ¶
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
func NewHandler ¶
func NewHandler( r handlerDependencies, ) *Handler
func (*Handler) IsAuthenticated ¶
func (h *Handler) IsAuthenticated(wrap httprouter.Handle, onUnauthenticated httprouter.Handle) httprouter.Handle
func (*Handler) IsNotAuthenticated ¶
func (h *Handler) IsNotAuthenticated(wrap httprouter.Handle, onAuthenticated httprouter.Handle) httprouter.Handle
func (*Handler) RegisterAdminRoutes ¶
func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin)
func (*Handler) RegisterPublicRoutes ¶
func (h *Handler) RegisterPublicRoutes(public *x.RouterPublic)
type HandlerProvider ¶
type HandlerProvider interface {
SessionHandler() *Handler
}
type ManagementProvider ¶
type ManagementProvider interface {
SessionManager() Manager
}
type Manager ¶
type Manager interface {
// CreateAndIssueCookie stores a session in the database and issues a cookie by calling IssueCookie.
//
// Also regenerates CSRF tokens due to assumed principal change.
CreateAndIssueCookie(context.Context, http.ResponseWriter, *http.Request, *Session) error
// IssueCookie issues a cookie for the given session.
//
// Also regenerates CSRF tokens due to assumed principal change.
IssueCookie(context.Context, http.ResponseWriter, *http.Request, *Session) error
// FetchFromRequest creates an HTTP session using cookies.
FetchFromRequest(context.Context, *http.Request) (*Session, error)
// PurgeFromRequest removes an HTTP session.
PurgeFromRequest(context.Context, http.ResponseWriter, *http.Request) error
}
Manager handles identity sessions.
type ManagerHTTP ¶
type ManagerHTTP struct {
// contains filtered or unexported fields
}
func NewManagerHTTP ¶
func NewManagerHTTP( c managerHTTPConfiguration, r managerHTTPDependencies, ) *ManagerHTTP
func (*ManagerHTTP) CreateAndIssueCookie ¶
func (s *ManagerHTTP) CreateAndIssueCookie(ctx context.Context, w http.ResponseWriter, r *http.Request, ss *Session) error
func (*ManagerHTTP) FetchFromRequest ¶
func (*ManagerHTTP) IssueCookie ¶
func (s *ManagerHTTP) IssueCookie(ctx context.Context, w http.ResponseWriter, r *http.Request, session *Session) error
func (*ManagerHTTP) PurgeFromRequest ¶
func (s *ManagerHTTP) PurgeFromRequest(ctx context.Context, w http.ResponseWriter, r *http.Request) error
type PersistenceProvider ¶
type PersistenceProvider interface {
SessionPersister() Persister
}
type Persister ¶
type Persister interface {
// GetSession retrieves a session from the store.
GetSession(ctx context.Context, sid uuid.UUID) (*Session, error)
// CreateSession adds a session to the store.
CreateSession(ctx context.Context, s *Session) error
// DeleteSession removes a session from the store.
DeleteSession(ctx context.Context, id uuid.UUID) error
// DeleteSessionsByIdentity removes all active session from the store for the given identity.
DeleteSessionsByIdentity(ctx context.Context, identity uuid.UUID) error
// GetSessionByToken gets the session associated with the given token.
//
// Functionality is similar to GetSession but accepts a session token
// instead of a session ID.
GetSessionByToken(context.Context, string) (*Session, error)
// DeleteSessionByToken deletes a session associated with the given token.
//
// Functionality is similar to DeleteSession but accepts a session token
// instead of a session ID.
DeleteSessionByToken(context.Context, string) error
// RevokeSessionByToken marks a session inactive with the given token.
RevokeSessionByToken(ctx context.Context, token string) error
}
type Session ¶
type Session struct {
// required: true
ID uuid.UUID `json:"id" faker:"-" db:"id"`
Active bool `json:"active" db:"active"`
// required: true
ExpiresAt time.Time `json:"expires_at" db:"expires_at" faker:"time_type"`
// required: true
AuthenticatedAt time.Time `json:"authenticated_at" db:"authenticated_at" faker:"time_type"`
// required: true
IssuedAt time.Time `json:"issued_at" db:"issued_at" faker:"time_type"`
// required: true
Identity *identity.Identity `json:"identity" faker:"identity" db:"-" belongs_to:"identities" fk_id:"IdentityID"`
// IdentityID is a helper struct field for gobuffalo.pop.
IdentityID uuid.UUID `json:"-" faker:"-" db:"identity_id"`
// CreatedAt is a helper struct field for gobuffalo.pop.
CreatedAt time.Time `json:"-" faker:"-" db:"created_at"`
// UpdatedAt is a helper struct field for gobuffalo.pop.
UpdatedAt time.Time `json:"-" faker:"-" db:"updated_at"`
Token string `json:"-" db:"token"`
}
swagger:model session
func NewActiveSession ¶
func (*Session) Declassify ¶
Click to show internal directories.
Click to hide internal directories.