github

Documentation

Index

• Constants
• type Provider
  • func NewProvider(conf config.Config) *Provider
  • func (p *Provider) CheckOrgs(ctx context.Context, tokens *oidc.Tokens[*idtoken.Claims]) error
  • func (p *Provider) CheckTeams(ctx context.Context, tokens *oidc.Tokens[*idtoken.Claims]) error
  • func (p *Provider) CheckUser(ctx context.Context, _ state.State, _ types.UserData, ...) error
  • func (p *Provider) GetDefaultScopes() []string
  • func (p *Provider) GetEndpoints(conf config.Config) (oauth2.Endpoint, error)
  • func (p *Provider) GetName() string
  • func (p *Provider) GetRefreshToken(tokens *oidc.Tokens[*idtoken.Claims]) string
  • func (p *Provider) GetUser(ctx context.Context, tokens *oidc.Tokens[*idtoken.Claims]) (types.UserData, error)
  • func (p *Provider) Refresh(ctx context.Context, _ *slog.Logger, accessToken string, _ rp.RelyingParty) (string, error)

Constants

const Name = "github"

Types

type Provider

type Provider struct {
	*generic.Provider
}

func NewProvider

func NewProvider(conf config.Config) *Provider

func (*Provider) CheckOrgs

func (p *Provider) CheckOrgs(ctx context.Context, tokens *oidc.Tokens[*idtoken.Claims]) error

func (*Provider) CheckTeams

func (p *Provider) CheckTeams(ctx context.Context, tokens *oidc.Tokens[*idtoken.Claims]) error

func (*Provider) CheckUser

func (p *Provider) CheckUser(
	ctx context.Context, _ state.State, _ types.UserData, tokens *oidc.Tokens[*idtoken.Claims],
) error

func (*Provider) GetDefaultScopes

func (p *Provider) GetDefaultScopes() []string

func (*Provider) GetEndpoints

func (p *Provider) GetEndpoints(conf config.Config) (oauth2.Endpoint, error)

func (*Provider) GetName

func (p *Provider) GetName() string

func (*Provider) GetRefreshToken

func (p *Provider) GetRefreshToken(tokens *oidc.Tokens[*idtoken.Claims]) string

GetRefreshToken returns the oauth2.Token.AccessToken of the user, since it does not expire. OAuth2 App on GitHub doesn't provide a refresh token.

func (*Provider) GetUser

func (p *Provider) GetUser(ctx context.Context, tokens *oidc.Tokens[*idtoken.Claims]) (types.UserData, error)

func (*Provider) Refresh

func (p *Provider) Refresh(ctx context.Context, _ *slog.Logger, accessToken string, _ rp.RelyingParty) (string, error)

Refresh use the oauth2.Token.AccessToken from initial authentication and call the REST API if the user is still present inside the required groups.