Documentation
¶
Index ¶
- func RegisterConnector(connector *Connector)
- func WireConnectors(group *flags.Group)
- func WireTeamConnectors(group *flags.Group)
- type AuthFlags
- type AuthTeamFlags
- type CFFlags
- type CFTeamFlags
- type Config
- type Connector
- type GithubFlags
- type GithubTeamFlags
- type GitlabFlags
- type GitlabTeamFlags
- type LDAPFlags
- type LDAPTeamFlags
- type OAuthFlags
- type OAuthTeamFlags
- type OIDCFlags
- type OIDCTeamFlags
- type TeamConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterConnector ¶
func RegisterConnector(connector *Connector)
func WireConnectors ¶
func WireTeamConnectors ¶
Types ¶
type AuthFlags ¶
type AuthFlags struct {
SecureCookies bool `long:"cookie-secure" description:"Force sending secure flag on http cookies"`
Expiration time.Duration `` /* 135-byte string literal not displayed */
SigningKey *flag.PrivateKey `long:"session-signing-key" description:"File containing an RSA private key, used to sign auth tokens."`
LocalUsers map[string]string `` /* 204-byte string literal not displayed */
}
type AuthTeamFlags ¶
type CFFlags ¶
type CFFlags struct {
ClientID string `long:"client-id" description:"(Required) Client id"`
ClientSecret string `long:"client-secret" description:"(Required) Client secret"`
APIURL string `` /* 167-byte string literal not displayed */
CACerts []flag.File `long:"ca-cert" description:"CA Certificate"`
InsecureSkipVerify bool `long:"skip-ssl-validation" description:"Skip SSL validation"`
}
type CFTeamFlags ¶
type CFTeamFlags struct {
Users []string `long:"user" description:"List of whitelisted CloudFoundry users." value-name:"USERNAME"`
Orgs []string `long:"org" description:"List of whitelisted CloudFoundry orgs" value-name:"ORG_NAME"`
Spaces []string `long:"space" description:"List of whitelisted CloudFoundry spaces" value-name:"ORG_NAME:SPACE_NAME"`
SpaceGuids []string `long:"space-guid" description:"(Deprecated) List of whitelisted CloudFoundry space guids" value-name:"SPACE_GUID"`
}
func (*CFTeamFlags) GetGroups ¶
func (self *CFTeamFlags) GetGroups() []string
func (*CFTeamFlags) GetUsers ¶
func (self *CFTeamFlags) GetUsers() []string
func (*CFTeamFlags) IsValid ¶
func (self *CFTeamFlags) IsValid() bool
type Connector ¶
type Connector struct {
// contains filtered or unexported fields
}
func GetConnectors ¶
func GetConnectors() []*Connector
func (*Connector) GetTeamGroups ¶
func (*Connector) GetTeamUsers ¶
func (*Connector) HasTeamConfig ¶
type GithubFlags ¶
type GithubFlags struct {
ClientID string `long:"client-id" description:"(Required) Client id"`
ClientSecret string `long:"client-secret" description:"(Required) Client secret"`
Host string `long:"host" description:"Hostname of GitHub Enterprise deployment (No scheme, No trailing slash)"`
CACert flag.File `long:"ca-cert" description:"CA certificate of GitHub Enterprise deployment"`
}
func (*GithubFlags) Name ¶
func (self *GithubFlags) Name() string
func (*GithubFlags) Serialize ¶
func (self *GithubFlags) Serialize(redirectURI string) ([]byte, error)
func (*GithubFlags) Validate ¶
func (self *GithubFlags) Validate() error
type GithubTeamFlags ¶
type GithubTeamFlags struct {
Users []string `long:"user" description:"List of whitelisted GitHub users" value-name:"USERNAME"`
Orgs []string `long:"org" description:"List of whitelisted GitHub orgs" value-name:"ORG_NAME"`
Teams []string `long:"team" description:"List of whitelisted GitHub teams" value-name:"ORG_NAME:TEAM_NAME"`
}
func (*GithubTeamFlags) GetGroups ¶
func (self *GithubTeamFlags) GetGroups() []string
func (*GithubTeamFlags) GetUsers ¶
func (self *GithubTeamFlags) GetUsers() []string
func (*GithubTeamFlags) IsValid ¶
func (self *GithubTeamFlags) IsValid() bool
type GitlabFlags ¶
type GitlabFlags struct {
ClientID string `long:"client-id" description:"(Required) Client id"`
ClientSecret string `long:"client-secret" description:"(Required) Client secret"`
Host string `long:"host" description:"Hostname of Gitlab Enterprise deployment (Include scheme, No trailing slash)"`
}
func (*GitlabFlags) Name ¶
func (self *GitlabFlags) Name() string
func (*GitlabFlags) Serialize ¶
func (self *GitlabFlags) Serialize(redirectURI string) ([]byte, error)
func (*GitlabFlags) Validate ¶
func (self *GitlabFlags) Validate() error
type GitlabTeamFlags ¶
type GitlabTeamFlags struct {
Users []string `long:"user" description:"List of whitelisted GitLab users" value-name:"USERNAME"`
Groups []string `long:"group" description:"List of whitelisted GitLab groups" value-name:"GROUP_NAME"`
}
func (*GitlabTeamFlags) GetGroups ¶
func (self *GitlabTeamFlags) GetGroups() []string
func (*GitlabTeamFlags) GetUsers ¶
func (self *GitlabTeamFlags) GetUsers() []string
func (*GitlabTeamFlags) IsValid ¶
func (self *GitlabTeamFlags) IsValid() bool
type LDAPFlags ¶
type LDAPFlags struct {
DisplayName string `long:"display-name" description:"The auth provider name displayed to users on the login page"`
Host string `` /* 170-byte string literal not displayed */
BindDN string `long:"bind-dn" description:"(Required) Bind DN for searching LDAP users and groups. Typically this is a read-only user."`
BindPW string `long:"bind-pw" description:"(Required) Bind Password for the user specified by 'bind-dn'"`
InsecureNoSSL bool `long:"insecure-no-ssl" description:"Required if LDAP host does not use TLS."`
InsecureSkipVerify bool `long:"insecure-skip-verify" description:"Skip certificate verification"`
StartTLS bool `long:"start-tls" description:"Start on insecure port, then negotiate TLS"`
CACert flag.File `long:"ca-cert" description:"CA certificate"`
UserSearch struct {
BaseDN string `long:"user-search-base-dn" description:"BaseDN to start the search from. For example 'cn=users,dc=example,dc=com'"`
Filter string `` /* 129-byte string literal not displayed */
Username string `` /* 176-byte string literal not displayed */
Scope string `` /* 140-byte string literal not displayed */
IDAttr string `long:"user-search-id-attr" description:"A mapping of attributes on the user entry to claims. Defaults to 'uid'."`
EmailAttr string `long:"user-search-email-attr" description:"A mapping of attributes on the user entry to claims. Defaults to 'mail'."`
NameAttr string `long:"user-search-name-attr" description:"A mapping of attributes on the user entry to claims."`
}
GroupSearch struct {
BaseDN string `long:"group-search-base-dn" description:"BaseDN to start the search from. For example 'cn=groups,dc=example,dc=com'"`
Filter string `` /* 134-byte string literal not displayed */
Scope string `` /* 141-byte string literal not displayed */
UserAttr string `` /* 217-byte string literal not displayed */
GroupAttr string `` /* 218-byte string literal not displayed */
NameAttr string `long:"group-search-name-attr" description:"The attribute of the group that represents its name."`
}
}
type LDAPTeamFlags ¶
type LDAPTeamFlags struct {
Users []string `json:"users" long:"user" description:"List of whitelisted LDAP users" value-name:"USERNAME"`
Groups []string `json:"groups" long:"group" description:"List of whitelisted LDAP groups" value-name:"GROUP_NAME"`
}
func (*LDAPTeamFlags) GetGroups ¶
func (self *LDAPTeamFlags) GetGroups() []string
func (*LDAPTeamFlags) GetUsers ¶
func (self *LDAPTeamFlags) GetUsers() []string
func (*LDAPTeamFlags) IsValid ¶
func (self *LDAPTeamFlags) IsValid() bool
type OAuthFlags ¶
type OAuthFlags struct {
DisplayName string `long:"display-name" description:"The auth provider name displayed to users on the login page"`
ClientID string `long:"client-id" description:"(Required) Client id"`
ClientSecret string `long:"client-secret" description:"(Required) Client secret"`
AuthURL string `long:"auth-url" description:"(Required) Authorization URL"`
TokenURL string `long:"token-url" description:"(Required) Token URL"`
UserInfoURL string `long:"userinfo-url" description:"UserInfo URL"`
Scopes []string `long:"scope" description:"Any additional scopes that need to be requested during authorization"`
GroupsKey string `long:"groups-key" description:"The groups key indicates which claim to use to map external groups to Concourse teams."`
CACerts []flag.File `long:"ca-cert" description:"CA Certificate"`
InsecureSkipVerify bool `long:"skip-ssl-validation" description:"Skip SSL validation"`
}
func (*OAuthFlags) Name ¶
func (self *OAuthFlags) Name() string
func (*OAuthFlags) Serialize ¶
func (self *OAuthFlags) Serialize(redirectURI string) ([]byte, error)
func (*OAuthFlags) Validate ¶
func (self *OAuthFlags) Validate() error
type OAuthTeamFlags ¶
type OAuthTeamFlags struct {
Users []string `json:"users" long:"user" description:"List of whitelisted OAuth2 users" value-name:"USERNAME"`
Groups []string `json:"groups" long:"group" description:"List of whitelisted OAuth2 groups" value-name:"GROUP_NAME"`
}
func (*OAuthTeamFlags) GetGroups ¶
func (self *OAuthTeamFlags) GetGroups() []string
func (*OAuthTeamFlags) GetUsers ¶
func (self *OAuthTeamFlags) GetUsers() []string
func (*OAuthTeamFlags) IsValid ¶
func (self *OAuthTeamFlags) IsValid() bool
type OIDCFlags ¶
type OIDCFlags struct {
DisplayName string `long:"display-name" description:"The auth provider name displayed to users on the login page"`
Issuer string `` /* 153-byte string literal not displayed */
ClientID string `long:"client-id" description:"(Required) Client id"`
ClientSecret string `long:"client-secret" description:"(Required) Client secret"`
Scopes []string `long:"scope" description:"Any additional scopes that need to be requested during authorization"`
GroupsKey string `long:"groups-key" description:"The groups key indicates which claim to use to map external groups to Concourse teams."`
HostedDomains []string `` /* 140-byte string literal not displayed */
CACerts []flag.File `long:"ca-cert" description:"CA Certificate"`
InsecureSkipVerify bool `long:"skip-ssl-validation" description:"Skip SSL validation"`
}
type OIDCTeamFlags ¶
type OIDCTeamFlags struct {
Users []string `json:"users" long:"user" description:"List of whitelisted OIDC users" value-name:"USERNAME"`
Groups []string `json:"groups" long:"group" description:"List of whitelisted OIDC groups" value-name:"GROUP_NAME"`
}
func (*OIDCTeamFlags) GetGroups ¶
func (self *OIDCTeamFlags) GetGroups() []string
func (*OIDCTeamFlags) GetUsers ¶
func (self *OIDCTeamFlags) GetUsers() []string
func (*OIDCTeamFlags) IsValid ¶
func (self *OIDCTeamFlags) IsValid() bool
type TeamConfig ¶
Click to show internal directories.
Click to hide internal directories.