samlctx

Documentation

Index

• Constants
• Variables
• type SamlBindingManager
• type SamlClient
• type SamlClientStore
• type SamlIdentityProvider
• type SamlIdentityProviderManager
• type SamlProperties
  • func BindSamlProperties(ctx *bootstrap.ApplicationContext) SamlProperties
  • func NewSamlProperties() *SamlProperties

Constants

const (
	GrantTypeSamlSSO = oauth2.GrantTypeSamlSSO
)

const SamlPropertiesPrefix = "security.auth.saml"

Variables

var Module = &bootstrap.Module{
	Name:       "saml",
	Precedence: security.MinSecurityPrecedence + 20,
	Options: []fx.Option{
		fx.Provide(BindSamlProperties),
	},
}

Types

type SamlBindingManager

type SamlBindingManager interface {
	// PreferredBindings returns supported bindings in order of preference.
	// possible values are
	// - saml.HTTPRedirectBinding
	// - saml.HTTPPostBinding
	// - saml.HTTPArtifactBinding
	// - saml.SOAPBinding
	// Note that this is not list of supported bindings. Supported bindings are determined by IDP and SP
	PreferredBindings() []string
}

SamlBindingManager is an additional interface that SamlIdentityProviderManager could implement.

type SamlClient

type SamlClient interface {
	GetEntityId() string
	GetMetadataSource() string
	ShouldSkipAssertionEncryption() bool
	ShouldSkipAuthRequestSignatureVerification() bool
	GetTenantRestrictions() utils.StringSet
	GetTenantRestrictionType() string

	ShouldMetadataRequireSignature() bool
	ShouldMetadataTrustCheck() bool
	GetMetadataTrustedKeys() []string
}

type SamlClientStore

type SamlClientStore interface {
	GetAllSamlClient(ctx context.Context) ([]SamlClient, error)
	GetSamlClientByEntityId(ctx context.Context, entityId string) (SamlClient, error)
}

type SamlIdentityProvider

type SamlIdentityProvider interface {
	idp.IdentityProvider
	EntityId() string
	MetadataLocation() string
	ExternalIdName() string
	ExternalIdpName() string
	ShouldMetadataRequireSignature() bool
	ShouldMetadataTrustCheck() bool
	GetMetadataTrustedKeys() []string
	GetAutoCreateUserDetails() security.AutoCreateUserDetails
}

type SamlIdentityProviderManager

type SamlIdentityProviderManager interface {
	GetIdentityProviderByEntityId(ctx context.Context, entityId string) (idp.IdentityProvider, error)
}

type SamlProperties

type SamlProperties struct {
	CertificateFile string `json:"certificate-file"`
	KeyFile         string `json:"key-file"`
	KeyPassword     string `json:"key-password"`
	NameIDFormat    string `json:"name-id-format"`
}

func BindSamlProperties

func BindSamlProperties(ctx *bootstrap.ApplicationContext) SamlProperties

func NewSamlProperties

func NewSamlProperties() *SamlProperties