sp

Documentation

Index

• type ArtifactCallback
• type Configuration
• type ServiceProvider
  • func New(conf Configuration) (ServiceProvider, error)

Types

type ArtifactCallback

type ArtifactCallback func(w http.ResponseWriter, r *http.Request, state []byte, assertion *saml.Assertion)

ArtifactCallback is called by the service provider following success retrieval of a SAML assertion

type Configuration

type Configuration struct {
	EntityID                    string
	AssertionConsumerServiceURL string
	IDPRedirectEndpoint         string
	IDPArtifactEndpoint         string
	IDPQueryEndpoint            string
	// Optional override of client added for testing
	// but may have other uses
	Client          *http.Client
	Timeout         time.Duration
	TLSConfig       *tls.Config
	Cache           store.Cache
	TimestampMargin time.Duration
}

Configuration holds the service provider's configuration

type ServiceProvider

type ServiceProvider interface {
	Query(nameID string) (*saml.Assertion, error)
	GetRedirect([]byte) (string, error)
	MetadataFunc() (http.HandlerFunc, error)
	ArtifactFunc(callback ArtifactCallback) http.HandlerFunc
}

ServiceProvider acts as a SAML service provider

func New

func New(conf Configuration) (ServiceProvider, error)

New creates a service provider from the provided configuration