func CheckCommand(args, env []string)bool

func OverrideVSCodeConfigs(fsafero.Fs)error

func ParseAskpass(promptstring) (userstring, hoststring, errerror)

type AppInstallation struct {IDint// Login is the username of the installation.Loginstring// URL is a link to configure the app install.URLstring}

type Config struct {OAuth2Config// ID is a unique identifier for the authenticator.IDstring// Regex is a regexp that URLs will match against.Regex *regexp.Regexp// Type is the type of provider.Typecodersdk.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.NoRefreshbool// ValidateURL ensures an access token is valid before// returning it to the user. If omitted, tokens will// not be validated before being returned.ValidateURLstring// AppInstallURL is for GitHub App's (and hopefully others eventually)// to provide a link to install the app. There's installation// of the application, and user authentication. It's possible// for the user to authenticate but the application to not.AppInstallURLstring// InstallationsURL is an API endpoint that returns a list of// installations for the user. This is used for GitHub Apps.AppInstallationsURLstring// DeviceAuth is set if the provider uses the device flow.DeviceAuth *DeviceAuth}

funcConvertConfig¶

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

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

func (*Config)AppInstallations¶added inv0.25.0

func (c *Config) AppInstallations(ctxcontext.Context, tokenstring) ([]codersdk.GitAuthAppInstallation,bool,error)

AppInstallations returns a list of app installations for the given token.If the provider does not support app installations, it returns nil.

func (*Config)RefreshToken¶added inv0.20.1

func (c *Config) RefreshToken(ctxcontext.Context, dbdatabase.Store, gitAuthLinkdatabase.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¶added inv0.20.1

func (c *Config) ValidateToken(ctxcontext.Context, tokenstring) (bool, *codersdk.GitAuthUser,error)

ValidateToken ensures the Git token provided is valid!The user is optionally returned if the provider supports it.

type DeviceAuth struct {ClientIDstringTokenURLstringScopes   []stringCodeURLstring}

func (*DeviceAuth)AuthorizeDevice¶added inv0.25.0

func (c *DeviceAuth) AuthorizeDevice(ctxcontext.Context) (*codersdk.GitAuthDevice,error)

AuthorizeDevice begins the device authorization flow.See:https://tools.ietf.org/html/rfc8628#section-3.1

func (*DeviceAuth)ExchangeDeviceCode¶added inv0.25.0

func (c *DeviceAuth) ExchangeDeviceCode(ctxcontext.Context, deviceCodestring) (*oauth2.Token,error)

ExchangeDeviceCode exchanges a device code for an access token.The boolean returned indicates whether the device code is still pendingand the caller should try again.

type ExchangeDeviceCodeResponse struct {AccessTokenstring `json:"access_token"`RefreshTokenstring `json:"refresh_token"`ExpiresInint    `json:"expires_in"`Errorstring `json:"error"`ErrorDescriptionstring `json:"error_description"`}

type OAuth2Config interface {AuthCodeURL(statestring, opts ...oauth2.AuthCodeOption)stringExchange(ctxcontext.Context, codestring, opts ...oauth2.AuthCodeOption) (*oauth2.Token,error)TokenSource(context.Context, *oauth2.Token)oauth2.TokenSource}