github

package

v1.21.0 Latest Latest Go to latest Published: Apr 12, 2024 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const Name = "github"

This section is empty.

This section is empty.

type Provider struct {
	*generic.Provider
	// contains filtered or unexported fields
}

func NewProvider(ctx context.Context, conf config.Config, httpClient *http.Client) (*Provider, error)

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

CheckUser implements the github.com/jkroepke/openvpn-auth-oauth2/internal/oauth2.Provider interface. It checks if mets specific GitHub related conditions.

func (p *Provider) GetName() string

func (p *Provider) GetProviderConfig(conf config.Config) (types.ProviderConfig, error)

GetProviderConfig implements the github.com/jkroepke/openvpn-auth-oauth2/internal/oauth2.Provider interface. It returns the OAuth2 GitHub endpoints.GitHub, since GitHub does not support OIDC discovery.

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 (p *Provider) GetUser(ctx context.Context, _ *slog.Logger, tokens *oidc.Tokens[*idtoken.Claims]) (types.UserData, error)

func (p *Provider) Refresh(_ context.Context, _ *slog.Logger, _ rp.RelyingParty, refreshToken string) (*oidc.Tokens[*idtoken.Claims], 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.

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