gitauth

Documentation

Index

• func CheckCommand(args, env []string) bool
• func OverrideVSCodeConfigs(fs afero.Fs) error
• func ParseAskpass(prompt string) (user string, host string, err error)
• type Config
  • func ConvertConfig(entries []codersdk.GitAuthConfig, accessURL *url.URL) ([]*Config, error)
  • func (c *Config) RefreshToken(ctx context.Context, db database.Store, gitAuthLink database.GitAuthLink) (database.GitAuthLink, bool, error)
  • func (c *Config) ValidateToken(ctx context.Context, token string) (bool, error)

Functions

func CheckCommand

func CheckCommand(args, env []string) bool

CheckCommand returns true if the command arguments and environment match those when the GIT_ASKPASS command is invoked by git.

func OverrideVSCodeConfigs

func OverrideVSCodeConfigs(fs afero.Fs) error

OverrideVSCodeConfigs overwrites a few properties to consume GIT_ASKPASS from the host instead of VS Code-specific authentication.

func ParseAskpass

func ParseAskpass(prompt string) (user string, host string, err error)

ParseAskpass returns the user and host from a git askpass prompt. For example: "user1" and "https://github.com". Note that for HTTP protocols, the URL will never contain a path.

For details on how the prompt is formatted, see `credential_ask_one`: https://github.com/git/git/blob/bbe21b64a08f89475d8a3818e20c111378daa621/credential.c#L173-L191

Types

type Config

type Config struct {
	httpmw.OAuth2Config
	// ID is a unique identifier for the authenticator.
	ID string
	// Regex is a regexp that URLs will match against.
	Regex *regexp.Regexp
	// Type is the type of provider.
	Type codersdk.GitProvider
	// NoRefresh stops Coder from using the refresh token
	// to renew the access token.
	//
	// Some organizations have security policies that require
	// re-authentication for every token.
	NoRefresh bool
	// ValidateURL ensures an access token is valid before
	// returning it to the user. If omitted, tokens will
	// not be validated before being returned.
	ValidateURL string
}

Config is used for authentication for Git operations.

func ConvertConfig

func ConvertConfig(entries []codersdk.GitAuthConfig, accessURL *url.URL) ([]*Config, error)

ConvertConfig converts the SDK configuration entry format to the parsed and ready-to-consume in coderd provider type.

func (*Config) RefreshToken

func (c *Config) RefreshToken(ctx context.Context, db database.Store, gitAuthLink database.GitAuthLink) (database.GitAuthLink, bool, error)

RefreshToken automatically refreshes the token if expired and permitted. It returns the token and a bool indicating if the token was refreshed.

func (*Config) ValidateToken

func (c *Config) ValidateToken(ctx context.Context, token string) (bool, error)

ValidateToken ensures the Git token provided is valid!