extsamlidp

Documentation

Index

• Constants
• Variables
• func Use()
• type Options
  • func WithProperties(props *SamlAuthProperties) Options
• type SamlAuthEndpointProperties
• type SamlAuthProperties
  • func BindSamlAuthProperties(ctx *bootstrap.ApplicationContext) SamlAuthProperties
  • func NewSamlAuthProperties() *SamlAuthProperties
• type SamlIdentityProvider
  • func NewIdentityProvider(opts ...SamlIdpOptions) *SamlIdentityProvider
  • func (s SamlIdentityProvider) AuthenticationFlow() idp.AuthenticationFlow
  • func (s SamlIdentityProvider) Domain() string
  • func (s SamlIdentityProvider) EntityId() string
  • func (s SamlIdentityProvider) ExternalIdName() string
  • func (s SamlIdentityProvider) ExternalIdpName() string
  • func (s SamlIdentityProvider) GetAutoCreateUserDetails() security.AutoCreateUserDetails
  • func (s SamlIdentityProvider) GetMetadataTrustedKeys() []string
  • func (s SamlIdentityProvider) MetadataLocation() string
  • func (s SamlIdentityProvider) ShouldMetadataRequireSignature() bool
  • func (s SamlIdentityProvider) ShouldMetadataTrustCheck() bool
• type SamlIdpAutoCreateUserDetails
  • func (a SamlIdpAutoCreateUserDetails) GetAttributeMapping() map[string]string
  • func (a SamlIdpAutoCreateUserDetails) GetElevatedUserRoleNames() []string
  • func (a SamlIdpAutoCreateUserDetails) GetEmailWhiteList() []string
  • func (a SamlIdpAutoCreateUserDetails) GetRegularUserRoleNames() []string
  • func (a SamlIdpAutoCreateUserDetails) IsEnabled() bool
• type SamlIdpDetails
• type SamlIdpOptions
• type SamlIdpSecurityConfigurer
  • func NewSamlIdpSecurityConfigurer(opts ...Options) *SamlIdpSecurityConfigurer
  • func (c *SamlIdpSecurityConfigurer) Configure(ws security.WebSecurity, config *authserver.Configuration)
  • func (c *SamlIdpSecurityConfigurer) ConfigureLogout(ws security.WebSecurity, config *authserver.Configuration)

Constants

const (
	PropertiesPrefix = "security.idp.saml"
)

Variables

var Module = &bootstrap.Module{
	Name:       "SAML IDP",
	Precedence: security.MaxSecurityPrecedence - 100,
	Options: []fx.Option{
		fx.Provide(BindSamlAuthProperties),
	},
}

Functions

func Use

func Use()

Types

type Options

type Options func(opt *option)

func WithProperties

func WithProperties(props *SamlAuthProperties) Options

type SamlAuthEndpointProperties

type SamlAuthEndpointProperties struct{}

type SamlAuthProperties

type SamlAuthProperties struct {
	Enabled   bool                       `json:"enabled"`
	Endpoints SamlAuthEndpointProperties `json:"endpoints"`
}

func BindSamlAuthProperties

func BindSamlAuthProperties(ctx *bootstrap.ApplicationContext) SamlAuthProperties

func NewSamlAuthProperties

func NewSamlAuthProperties() *SamlAuthProperties

type SamlIdentityProvider

type SamlIdentityProvider struct {
	SamlIdpDetails
}

SamlIdentityProvider implements idp.IdentityProvider, idp.AuthenticationFlowAware and samllogin.SamlIdentityProvider

func NewIdentityProvider

func NewIdentityProvider(opts ...SamlIdpOptions) *SamlIdentityProvider

func (SamlIdentityProvider) AuthenticationFlow

func (s SamlIdentityProvider) AuthenticationFlow() idp.AuthenticationFlow

func (SamlIdentityProvider) Domain

func (s SamlIdentityProvider) Domain() string

func (SamlIdentityProvider) EntityId

func (s SamlIdentityProvider) EntityId() string

func (SamlIdentityProvider) ExternalIdName

func (s SamlIdentityProvider) ExternalIdName() string

func (SamlIdentityProvider) ExternalIdpName

func (s SamlIdentityProvider) ExternalIdpName() string

func (SamlIdentityProvider) GetAutoCreateUserDetails

func (s SamlIdentityProvider) GetAutoCreateUserDetails() security.AutoCreateUserDetails

func (SamlIdentityProvider) GetMetadataTrustedKeys

func (s SamlIdentityProvider) GetMetadataTrustedKeys() []string

func (SamlIdentityProvider) MetadataLocation

func (s SamlIdentityProvider) MetadataLocation() string

func (SamlIdentityProvider) ShouldMetadataRequireSignature

func (s SamlIdentityProvider) ShouldMetadataRequireSignature() bool

func (SamlIdentityProvider) ShouldMetadataTrustCheck

func (s SamlIdentityProvider) ShouldMetadataTrustCheck() bool

type SamlIdpAutoCreateUserDetails

type SamlIdpAutoCreateUserDetails struct {
	Enabled               bool
	EmailWhiteList        []string
	AttributeMapping      map[string]string
	ElevatedUserRoleNames []string
	RegularUserRoleNames  []string
}

func (SamlIdpAutoCreateUserDetails) GetAttributeMapping

func (a SamlIdpAutoCreateUserDetails) GetAttributeMapping() map[string]string

func (SamlIdpAutoCreateUserDetails) GetElevatedUserRoleNames

func (a SamlIdpAutoCreateUserDetails) GetElevatedUserRoleNames() []string

func (SamlIdpAutoCreateUserDetails) GetEmailWhiteList

func (a SamlIdpAutoCreateUserDetails) GetEmailWhiteList() []string

func (SamlIdpAutoCreateUserDetails) GetRegularUserRoleNames

func (a SamlIdpAutoCreateUserDetails) GetRegularUserRoleNames() []string

func (SamlIdpAutoCreateUserDetails) IsEnabled

func (a SamlIdpAutoCreateUserDetails) IsEnabled() bool

type SamlIdpDetails

type SamlIdpDetails struct {
	EntityId                 string
	Domain                   string
	MetadataLocation         string
	ExternalIdName           string
	ExternalIdpName          string
	MetadataRequireSignature bool
	MetadataTrustCheck       bool
	MetadataTrustedKeys      []string
	AutoCreateUserDetails    SamlIdpAutoCreateUserDetails
}

type SamlIdpOptions

type SamlIdpOptions func(opt *SamlIdpDetails)

type SamlIdpSecurityConfigurer

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

SamlIdpSecurityConfigurer implements authserver.IdpSecurityConfigurer

func NewSamlIdpSecurityConfigurer

func NewSamlIdpSecurityConfigurer(opts ...Options) *SamlIdpSecurityConfigurer

func (*SamlIdpSecurityConfigurer) Configure

func (c *SamlIdpSecurityConfigurer) Configure(ws security.WebSecurity, config *authserver.Configuration)

func (*SamlIdpSecurityConfigurer) ConfigureLogout

func (c *SamlIdpSecurityConfigurer) ConfigureLogout(ws security.WebSecurity, config *authserver.Configuration)