samlsp

package

Go to main page

Versions in this module

v1

v1.4.1

Nov 12, 2025

v1.4.0

Nov 12, 2025

Changes in this version

type CookieSessionProvider

+ func (c *CookieSessionProvider) GetCodec() SessionCodec

+ func (c *CookieSessionProvider) GetMaxAge() time.Duration

+ func (c *CookieSessionProvider) GetName() string

+ func (c *CookieSessionProvider) SetCodec(codec SessionCodec)

+ func (c *CookieSessionProvider) SetMaxAge(age time.Duration)

+ func (c *CookieSessionProvider) SetName(name string)

type Middleware

+ GetLogoutUrl func() string

+ Logout func(ctx *gin.Context) (*url.URL, error)

type MiddlewareImpl

+ LogoutUrl *url.URL

+ func (m *MiddlewareImpl) GetLogoutUrl() string

+ func (m *MiddlewareImpl) Logout(ctx *gin.Context) (*url.URL, error)

type Options

+ LogoutUrl *url.URL

+ OverrideServiceProvider saml.ServiceProvider

+ OverrideSessionProvider SessionProvider

type SessionProvider

+ GetCodec func() SessionCodec

+ GetMaxAge func() time.Duration

+ GetName func() string

+ SetCodec func(codec SessionCodec)

+ SetMaxAge func(age time.Duration)

+ SetName func(name string)

v1.3.0

Nov 11, 2025

v1.2.1

Nov 5, 2025

Changes in this version

type Middleware

+ GetRequestTracker func() RequestTracker

+ GetServiceProvider func() saml.ServiceProvider

+ GetSession func() SessionProvider

+ SetOnError func(onErr func(ctx *gin.Context, err error) error)

+ SetRequestTracker func(tracker RequestTracker)

+ SetServiceProvider func(sp saml.ServiceProvider)

+ SetSession func(session SessionProvider)

+ type MiddlewareImpl struct

+ ACSHandler gin.HandlerFunc

+ AssertionHandler AssertionHandler

+ Binding string

+ ForceRedirectUrl string

+ MetadataHandler gin.HandlerFunc

+ OnError func(c *gin.Context, err error) error

+ RequestTracker RequestTracker

+ ResponseBinding string

+ ServiceProvider saml.ServiceProvider

+ Session SessionProvider

+ func (m *MiddlewareImpl) CreateSessionFromAssertion(c *gin.Context, assertion *saml.Assertion, redirectURI string) (string, error)

+ func (m *MiddlewareImpl) GetRequestTracker() RequestTracker

+ func (m *MiddlewareImpl) GetServiceProvider() saml.ServiceProvider

+ func (m *MiddlewareImpl) GetSession() SessionProvider

+ func (m *MiddlewareImpl) HandleStartAuthFlow(c *gin.Context)

+ func (m *MiddlewareImpl) RequireAccount() gin.HandlerFunc

+ func (m *MiddlewareImpl) ServeACS(c *gin.Context) (string, error)

+ func (m *MiddlewareImpl) ServeMetadata(c *gin.Context) ([]byte, error)

+ func (m *MiddlewareImpl) SetOnError(onErr func(ctx *gin.Context, err error) error)

+ func (m *MiddlewareImpl) SetRequestTracker(tracker RequestTracker)

+ func (m *MiddlewareImpl) SetServiceProvider(sp saml.ServiceProvider)

+ func (m *MiddlewareImpl) SetSession(session SessionProvider)

v1.2.0

Nov 5, 2025

v1.1.1

Oct 29, 2025

v1.1.0

Oct 29, 2025

v1.0.0

Oct 29, 2025

Changes in this version

+ var ErrNoSession = errors.New("saml: session not present")

+ func AttributeFromContext(ctx *gin.Context, name string) string

+ func ContextWithSession(ctx *gin.Context, session Session) context.Context

+ func DefaultOnError(c *gin.Context, err error) error

+ func DefaultServiceProvider(opts Options) saml.ServiceProvider

+ func FetchMetadata(ctx context.Context, httpClient *http.Client, metadataURL url.URL) (*saml.EntityDescriptor, error)

+ func ParseMetadata(data []byte) (*saml.EntityDescriptor, error)

+ func RequireAttribute(name, value string) gin.HandlerFunc

+ type AssertionHandler interface

+ HandleAssertion func(assertion *saml.Assertion) error

+ type Attributes map[string][]string

+ func (a Attributes) Get(key string) string

+ type CookieRequestTracker struct

+ Codec TrackedRequestCodec

+ MaxAge time.Duration

+ NamePrefix string

+ RelayStateFunc func(w http.ResponseWriter, r *http.Request) string

+ SameSite http.SameSite

+ ServiceProvider *saml.ServiceProvider

+ func DefaultRequestTracker(opts Options, serviceProvider *saml.ServiceProvider) CookieRequestTracker

+ func (t CookieRequestTracker) GetTrackedRequest(r *http.Request, index string) (*TrackedRequest, error)

+ func (t CookieRequestTracker) GetTrackedRequests(r *http.Request) []TrackedRequest

+ func (t CookieRequestTracker) StopTrackingRequest(w http.ResponseWriter, r *http.Request, index string) error

+ func (t CookieRequestTracker) TrackRequest(w http.ResponseWriter, r *http.Request, samlRequestID string) (string, error)

+ type CookieSessionProvider struct

+ Codec SessionCodec

+ Domain string

+ HTTPOnly bool

+ MaxAge time.Duration

+ Name string

+ Path string

+ SameSite http.SameSite

+ Secure bool

+ func DefaultSessionProvider(opts Options) CookieSessionProvider

+ func (c CookieSessionProvider) CreateSession(ctx *gin.Context, assertion *saml.Assertion) error

+ func (c CookieSessionProvider) DeleteSession(ctx *gin.Context) error

+ func (c CookieSessionProvider) GetSession(ctx *gin.Context) (Session, error)

+ type ErrorFunction func(w http.ResponseWriter, r *http.Request, err error)

+ type JWTSessionClaims struct

+ Attributes Attributes

+ SAMLSession bool

+ func (c JWTSessionClaims) GetAttributes() Attributes

+ type JWTSessionCodec struct

+ Audience string

+ Issuer string

+ Key crypto.Signer

+ MaxAge time.Duration

+ SigningMethod jwt.SigningMethod

+ func DefaultSessionCodec(opts Options) JWTSessionCodec

+ func (c JWTSessionCodec) Decode(signed string) (Session, error)

+ func (c JWTSessionCodec) Encode(s Session) (string, error)

+ func (c JWTSessionCodec) New(assertion *saml.Assertion) (Session, error)

+ type JWTTrackedRequestClaims struct

+ SAMLAuthnRequest bool

+ type JWTTrackedRequestCodec struct

+ Audience string

+ Issuer string

+ Key crypto.Signer

+ MaxAge time.Duration

+ SigningMethod jwt.SigningMethod

+ func DefaultTrackedRequestCodec(opts Options) JWTTrackedRequestCodec

+ func (s JWTTrackedRequestCodec) Decode(signed string) (*TrackedRequest, error)

+ func (s JWTTrackedRequestCodec) Encode(value TrackedRequest) (string, error)

+ type Middleware struct

+ ACSHandler gin.HandlerFunc

+ AssertionHandler AssertionHandler

+ Binding string

+ ForceRedirectUrl string

+ MetadataHandler gin.HandlerFunc

+ OnError func(c *gin.Context, err error) error

+ RequestTracker RequestTracker

+ ResponseBinding string

+ ServiceProvider saml.ServiceProvider

+ Session SessionProvider

+ func New(opts Options) (*Middleware, error)

+ func (m *Middleware) CreateSessionFromAssertion(c *gin.Context, assertion *saml.Assertion, redirectURI string) (string, error)

+ func (m *Middleware) HandleStartAuthFlow(c *gin.Context)

+ func (m *Middleware) RequireAccount() gin.HandlerFunc

+ func (m *Middleware) ServeACS(c *gin.Context) (string, error)

+ func (m *Middleware) ServeMetadata(c *gin.Context) ([]byte, error)

+ type NopAssertionHandler struct

+ func DefaultAssertionHandler(_ Options) NopAssertionHandler

+ func (as NopAssertionHandler) HandleAssertion(_ *saml.Assertion) error

+ type Options struct

+ AllowIDPInitiated bool

+ Certificate *x509.Certificate

+ CookieName string

+ CookieSameSite http.SameSite

+ DefaultRedirectURI string

+ EntityID string

+ ForceAuthn bool

+ ForceRedirectUrl *url.URL

+ HTTPClient *http.Client

+ IDPMetadata *saml.EntityDescriptor

+ Intermediates []*x509.Certificate

+ Key crypto.Signer

+ LogoutBindings []string

+ RelayStateFunc func(w http.ResponseWriter, r *http.Request) string

+ RequestedAuthnContext *saml.RequestedAuthnContext

+ SignRequest bool

+ URL url.URL

+ UseArtifactResponse bool

+ type RequestTracker interface

+ GetTrackedRequest func(r *http.Request, index string) (*TrackedRequest, error)

+ GetTrackedRequests func(r *http.Request) []TrackedRequest

+ StopTrackingRequest func(w http.ResponseWriter, r *http.Request, index string) error

+ TrackRequest func(w http.ResponseWriter, r *http.Request, samlRequestID string) (index string, err error)

+ type Session interface

+ func SessionFromContext(ctx *gin.Context) Session

+ type SessionCodec interface

+ Decode func(string) (Session, error)

+ Encode func(s Session) (string, error)

+ New func(assertion *saml.Assertion) (Session, error)

+ type SessionProvider interface

+ CreateSession func(ctx *gin.Context, assertion *saml.Assertion) error

+ DeleteSession func(ctx *gin.Context) error

+ GetSession func(ctx *gin.Context) (Session, error)

+ type SessionWithAttributes interface

+ GetAttributes func() Attributes

+ type TrackedRequest struct

+ Index string

+ SAMLRequestID string

+ URI string

+ type TrackedRequestCodec interface

+ Decode func(signed string) (*TrackedRequest, error)

+ Encode func(value TrackedRequest) (string, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL