ldap

Documentation

Index

• Constants
• type ADProvider
  • func InitializeProvider() (*ADProvider, error)
  • func (a *ADProvider) AddProviderConfig(authConfig *model.AuthConfig, providerSettings map[string]string)
  • func (a *ADProvider) CustomizeSchema(schema *v1client.Schema) *v1client.Schema
  • func (a *ADProvider) GenerateToken(jsonInput map[string]string) (model.Token, int, error)
  • func (a *ADProvider) GetConfig() model.AuthConfig
  • func (a *ADProvider) GetIdentities(accessToken string) ([]client.Identity, error)
  • func (a *ADProvider) GetIdentity(distinguishedName string, scope string, accessToken string) (client.Identity, error)
  • func (a *ADProvider) GetIdentitySeparator() string
  • func (a *ADProvider) GetLegacySettings() map[string]string
  • func (a *ADProvider) GetName() string
  • func (a *ADProvider) GetProviderConfigResource() interface{}
  • func (a *ADProvider) GetProviderSecretSettings() []string
  • func (a *ADProvider) GetProviderSettingList(listOnly bool) []string
  • func (a *ADProvider) GetRedirectURL() string
  • func (a *ADProvider) GetSettings() map[string]string
  • func (a *ADProvider) GetUserType() string
  • func (a *ADProvider) IsIdentityLookupSupported() bool
  • func (a *ADProvider) LoadConfig(authConfig *model.AuthConfig) error
  • func (a *ADProvider) RefreshToken(json map[string]string) (model.Token, int, error)
  • func (a *ADProvider) SearchIdentities(name string, exactMatch bool, accessToken string) ([]client.Identity, error)
  • func (a *ADProvider) TestLogin(testAuthConfig *model.TestAuthConfig, accessToken string) (int, error)

Constants

const (
	Name                 = "ldap"
	UserScope            = Name + "_user"
	GroupScope           = Name + "_group"
	Config               = Name + "config"
	LdapJwt              = Name + "Jwt"
	MemberOfAttribute    = "memberOf"
	ObjectClassAttribute = "objectClass"

	AccessModeSetting               = settingBase + "access.mode"
	DomainSetting                   = settingBase + "domain"
	GroupSearchDomainSetting        = settingBase + "group.search.domain"
	LoginDomainSetting              = settingBase + "login.domain"
	PortSetting                     = settingBase + "port"
	UserSearchFieldSetting          = settingBase + "user.search.field"
	ServiceAccountUsernameSetting   = settingBase + "service.account.user"
	GroupSearchFieldSetting         = settingBase + "group.search.field"
	UserObjectClassSetting          = settingBase + "user.object.class"
	UserNameFieldSetting            = settingBase + "user.name.field"
	GroupObjectClassSetting         = settingBase + "group.object.class"
	UserLoginFieldSetting           = settingBase + "user.login.field"
	UserDisabledBitMaskSetting      = settingBase + "user.enabled.mask.bit"
	ServerSetting                   = settingBase + "server"
	ServiceAccountPasswordSetting   = settingBase + "service.account.password"
	UserEnabledAttributeSetting     = settingBase + "user.enabled.attribute"
	GroupNameFieldSetting           = settingBase + "group.name.field"
	TLSSetting                      = settingBase + "tls"
	TimeoutSetting                  = settingBase + "connection.timeout"
	AllowedIdentitiesSetting        = settingBase + "allowed.identities"
	GroupDnFieldSetting             = settingBase + "group.dn.field"
	GroupMemberUserAttributeSetting = settingBase + "group.member.user.attribute"
)

Types

type ADProvider

type ADProvider struct {
	LdapClient *ldap.LClient
}

func InitializeProvider

func InitializeProvider() (*ADProvider, error)

func (*ADProvider) AddProviderConfig

func (a *ADProvider) AddProviderConfig(authConfig *model.AuthConfig, providerSettings map[string]string)

AddProviderConfig adds the provider config into the generic config using the settings from db

func (*ADProvider) CustomizeSchema

func (a *ADProvider) CustomizeSchema(schema *v1client.Schema) *v1client.Schema

func (*ADProvider) GenerateToken

func (a *ADProvider) GenerateToken(jsonInput map[string]string) (model.Token, int, error)

func (*ADProvider) GetConfig

func (a *ADProvider) GetConfig() model.AuthConfig

GetConfig returns the provider config

func (*ADProvider) GetIdentities

func (a *ADProvider) GetIdentities(accessToken string) ([]client.Identity, error)

GetIdentities returns list of user and group identities associated to this token

func (*ADProvider) GetIdentity

func (a *ADProvider) GetIdentity(distinguishedName string, scope string, accessToken string) (client.Identity, error)

func (*ADProvider) GetIdentitySeparator

func (a *ADProvider) GetIdentitySeparator() string

GetIdentitySeparator returns the provider specific separator to use to separate allowedIdentities

func (*ADProvider) GetLegacySettings

func (a *ADProvider) GetLegacySettings() map[string]string

GetLegacySettings returns the provider specific legacy db settings

func (*ADProvider) GetName

func (a *ADProvider) GetName() string

func (*ADProvider) GetProviderConfigResource

func (a *ADProvider) GetProviderConfigResource() interface{}

func (*ADProvider) GetProviderSecretSettings

func (a *ADProvider) GetProviderSecretSettings() []string

func (*ADProvider) GetProviderSettingList

func (a *ADProvider) GetProviderSettingList(listOnly bool) []string

GetProviderSettingList returns the provider specific db setting list

func (*ADProvider) GetRedirectURL

func (a *ADProvider) GetRedirectURL() string

GetRedirectURL returns the provider specific redirect URL used by UI

func (*ADProvider) GetSettings

func (a *ADProvider) GetSettings() map[string]string

GetSettings transforms the provider config to db settings

func (*ADProvider) GetUserType

func (a *ADProvider) GetUserType() string

func (*ADProvider) IsIdentityLookupSupported

func (a *ADProvider) IsIdentityLookupSupported() bool

func (*ADProvider) LoadConfig

func (a *ADProvider) LoadConfig(authConfig *model.AuthConfig) error

LoadConfig initializes the provider with the passed config

func (*ADProvider) RefreshToken

func (a *ADProvider) RefreshToken(json map[string]string) (model.Token, int, error)

RefreshToken re-authenticates and generate a new token

func (*ADProvider) SearchIdentities

func (a *ADProvider) SearchIdentities(name string, exactMatch bool, accessToken string) ([]client.Identity, error)

SearchIdentities returns the identity by name

func (*ADProvider) TestLogin

func (a *ADProvider) TestLogin(testAuthConfig *model.TestAuthConfig, accessToken string) (int, error)