github

Documentation

Index

• Constants
• Variables
• func NewTeamVerifier(teams []Team, gitHubClient Client) verifier.Verifier
• func NewUserVerifier(users []string, gitHubClient Client) verifier.Verifier
• type Client
  • func NewClient(baseURL string) Client
• type GitHubAuthConfig
  • func (*GitHubAuthConfig) AuthMethod(oauthBaseURL string, teamName string) atc.AuthMethod
  • func (auth *GitHubAuthConfig) IsConfigured() bool
  • func (auth *GitHubAuthConfig) Validate() error
• type GitHubProvider
  • func (GitHubProvider) PreTokenClient() (*http.Client, error)
• type GitHubTeamConfig
  • func (flag *GitHubTeamConfig) UnmarshalFlag(value string) error
• type GitHubTeamProvider
  • func (GitHubTeamProvider) AddAuthGroup(group *flags.Group) provider.AuthConfig
  • func (GitHubTeamProvider) ProviderConstructor(config provider.AuthConfig, redirectURL string) (provider.Provider, bool)
  • func (GitHubTeamProvider) UnmarshalConfig(config *json.RawMessage) (provider.AuthConfig, error)
• type OrganizationTeams
• type OrganizationVerifier
  • func NewOrganizationVerifier(organizations []string, gitHubClient Client) OrganizationVerifier
  • func (verifier OrganizationVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)
• type Team
• type TeamVerifier
  • func (verifier TeamVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)
• type UserVerifier
  • func (verifier UserVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)

Constants

const DisplayName = "GitHub"

const ProviderName = "github"

Variables

var Scopes = []string{"read:org"}

Functions

func NewTeamVerifier

func NewTeamVerifier(
	teams []Team,
	gitHubClient Client,
) verifier.Verifier

func NewUserVerifier

func NewUserVerifier(
	users []string,
	gitHubClient Client,
) verifier.Verifier

Types

type Client

type Client interface {
	CurrentUser(*http.Client) (string, error)
	Organizations(*http.Client) ([]string, error)
	Teams(*http.Client) (OrganizationTeams, error)
}

func NewClient

func NewClient(baseURL string) Client

type GitHubAuthConfig

type GitHubAuthConfig struct {
	ClientID     string `json:"client_id"     long:"client-id"     description:"Application client ID for enabling GitHub OAuth."`
	ClientSecret string `json:"client_secret" long:"client-secret" description:"Application client secret for enabling GitHub OAuth."`

	Organizations []string           `` /* 134-byte string literal not displayed */
	Teams         []GitHubTeamConfig `` /* 131-byte string literal not displayed */
	Users         []string           `json:"users,omitempty"         long:"user"          description:"GitHub user to permit access." value-name:"LOGIN"`
	AuthURL       string             `json:"auth_url,omitempty"      long:"auth-url"      description:"Override default endpoint AuthURL for Github Enterprise."`
	TokenURL      string             `json:"token_url,omitempty"     long:"token-url"     description:"Override default endpoint TokenURL for Github Enterprise."`
	APIURL        string             `json:"api_url,omitempty"       long:"api-url"       description:"Override default API endpoint URL for Github Enterprise."`
}

func (*GitHubAuthConfig) AuthMethod

func (*GitHubAuthConfig) AuthMethod(oauthBaseURL string, teamName string) atc.AuthMethod

func (*GitHubAuthConfig) IsConfigured

func (auth *GitHubAuthConfig) IsConfigured() bool

func (*GitHubAuthConfig) Validate

func (auth *GitHubAuthConfig) Validate() error

type GitHubProvider

type GitHubProvider struct {
	*oauth2.Config
	verifier.Verifier
}

func (GitHubProvider) PreTokenClient

func (GitHubProvider) PreTokenClient() (*http.Client, error)

type GitHubTeamConfig

type GitHubTeamConfig struct {
	OrganizationName string `json:"organization_name,omitempty"`
	TeamName         string `json:"team_name,omitempty"`
}

func (*GitHubTeamConfig) UnmarshalFlag

func (flag *GitHubTeamConfig) UnmarshalFlag(value string) error

type GitHubTeamProvider

type GitHubTeamProvider struct {
}

func (GitHubTeamProvider) AddAuthGroup

func (GitHubTeamProvider) AddAuthGroup(group *flags.Group) provider.AuthConfig

func (GitHubTeamProvider) ProviderConstructor

func (GitHubTeamProvider) ProviderConstructor(
	config provider.AuthConfig,
	redirectURL string,
) (provider.Provider, bool)

func (GitHubTeamProvider) UnmarshalConfig

func (GitHubTeamProvider) UnmarshalConfig(config *json.RawMessage) (provider.AuthConfig, error)

type OrganizationTeams

type OrganizationTeams map[string][]string

type OrganizationVerifier

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

func NewOrganizationVerifier

func NewOrganizationVerifier(
	organizations []string,
	gitHubClient Client,
) OrganizationVerifier

func (OrganizationVerifier) Verify

func (verifier OrganizationVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)

type Team

type Team struct {
	Name         string
	Organization string
}

type TeamVerifier

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

func (TeamVerifier) Verify

func (verifier TeamVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)

type UserVerifier

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

func (UserVerifier) Verify

func (verifier UserVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)