Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

github

package

Go to main page

Versions in this module

v0

v0.13.0

Apr 30, 2026

v0.12.0

Apr 28, 2026

v0.11.0

Apr 27, 2026

v0.10.1

Apr 24, 2026

Changes in this version

type Handler

+ func (h *Handler) ActiveFlow(ctx context.Context) auth.Flow

v0.10.0

Apr 20, 2026

v0.9.0

Apr 19, 2026

v0.8.0

Apr 16, 2026

v0.7.1

Apr 6, 2026

v0.7.0

Apr 6, 2026

v0.6.0

Mar 19, 2026

Changes in this version

type Option

+ func WithHTTPClientConfig(cfg *config.HTTPClientConfig) Option

v0.5.0

Feb 25, 2026

Changes in this version

+ const DefaultClientID

+ const DefaultHostname

+ const DefaultMinPollInterval

+ const DefaultTimeout

+ const EnvGHHost

+ const EnvGHToken

+ const EnvGitHubAppID

+ const EnvGitHubAppInstallationID

+ const EnvGitHubAppPrivateKey

+ const EnvGitHubAppPrivateKeyPath

+ const EnvGitHubToken

+ const HandlerDisplayName

+ const HandlerName

+ const SecretKeyAccessToken

+ const SecretKeyAppJWT

+ const SecretKeyMetadata

+ const SecretKeyRefreshToken

+ const SecretKeyTokenPrefix

+ var BrowserOpener = oauth.OpenBrowser

+ func GetHostnameFromEnv() string

+ func GetPATFromEnv() string

+ func HasPATCredentials() bool

+ type AppInfo struct

+ Description string

+ ID int64

+ Name string

+ Owner struct{ ... }

+ Slug string

+ type CachedToken struct

+ AccessToken string

+ CachedAt time.Time

+ ExpiresAt time.Time

+ Scope string

+ SessionID string

+ TokenType string

+ type Config struct

+ AppID int64

+ ClientID string

+ ClientSecret string

+ DefaultScopes []string

+ Hostname string

+ InstallationID int64

+ MinPollInterval time.Duration

+ PrivateKey string

+ PrivateKeyPath string

+ PrivateKeySecretName string

+ SlowDownIncrement time.Duration

+ func DefaultConfig() *Config

+ func (c *Config) GetAPIBaseURL() string

+ func (c *Config) GetAppID() int64

+ func (c *Config) GetInstallationID() int64

+ func (c *Config) GetOAuthBaseURL() string

+ func (c *Config) GetPrivateKey(ctx context.Context, store secrets.Store) ([]byte, error)

+ func (c *Config) Validate() error

+ func (c *Config) ValidateAppConfig(ctx context.Context, store secrets.Store) error

+ type DefaultHTTPClient struct

+ func NewDefaultHTTPClient(logger logr.Logger) *DefaultHTTPClient

+ func (c *DefaultHTTPClient) Get(ctx context.Context, reqURL string, headers map[string]string) (*http.Response, error)

+ func (c *DefaultHTTPClient) PostForm(ctx context.Context, reqURL string, data url.Values) (*http.Response, error)

+ func (c *DefaultHTTPClient) PostJSON(ctx context.Context, reqURL string, body any, headers map[string]string) (*http.Response, error)

+ type DeviceCodeResponse struct

+ DeviceCode string

+ ExpiresIn int

+ Interval int

+ UserCode string

+ VerificationURI string

+ type HTTPClient interface

+ Get func(ctx context.Context, url string, headers map[string]string) (*http.Response, error)

+ PostForm func(ctx context.Context, url string, data url.Values) (*http.Response, error)

+ PostJSON func(ctx context.Context, url string, body any, headers map[string]string) (*http.Response, error)

+ type Handler struct

+ func New(opts ...Option) (*Handler, error)

+ func (h *Handler) Capabilities() []auth.Capability

+ func (h *Handler) DisplayName() string

+ func (h *Handler) GetToken(ctx context.Context, opts auth.TokenOptions) (*auth.Token, error)

+ func (h *Handler) InjectAuth(ctx context.Context, req *http.Request, opts auth.TokenOptions) error

+ func (h *Handler) ListCachedTokens(ctx context.Context) ([]*auth.CachedTokenInfo, error)

+ func (h *Handler) Login(ctx context.Context, opts auth.LoginOptions) (*auth.Result, error)

+ func (h *Handler) Logout(ctx context.Context) error

+ func (h *Handler) Name() string

+ func (h *Handler) PurgeExpiredTokens(ctx context.Context) (int, error)

+ func (h *Handler) Status(ctx context.Context) (*auth.Status, error)

+ func (h *Handler) SupportedFlows() []auth.Flow

+ type InstallationTokenResponse struct

+ ExpiresAt time.Time

+ Permissions map[string]string

+ Token string

+ type MockHTTPClient struct

+ Requests []*MockRequest

+ Responses []*MockResponse

+ func NewMockHTTPClient() *MockHTTPClient

+ func (m *MockHTTPClient) AddError(err error) *MockHTTPClient

+ func (m *MockHTTPClient) AddResponse(statusCode int, body any) *MockHTTPClient

+ func (m *MockHTTPClient) Get(ctx context.Context, endpoint string, headers map[string]string) (*http.Response, error)

+ func (m *MockHTTPClient) GetRequests() []*MockRequest

+ func (m *MockHTTPClient) PostForm(ctx context.Context, endpoint string, data url.Values) (*http.Response, error)

+ func (m *MockHTTPClient) PostJSON(ctx context.Context, endpoint string, _ any, headers map[string]string) (*http.Response, error)

+ func (m *MockHTTPClient) Reset()

+ type MockRequest struct

+ Data url.Values

+ Endpoint string

+ Headers map[string]string

+ Method string

+ type MockResponse struct

+ Body any

+ Err error

+ StatusCode int

+ type Option func(*Handler)

+ func WithConfig(cfg *Config) Option

+ func WithHTTPClient(client HTTPClient) Option

+ func WithLogger(lgr logr.Logger) Option

+ func WithSecretStore(store secrets.Store) Option

+ type TokenCache struct

+ func NewTokenCache(secretStore secrets.Store) *TokenCache

+ func (c *TokenCache) Clear(ctx context.Context) error

+ func (c *TokenCache) Delete(ctx context.Context, scope string) error

+ func (c *TokenCache) Get(ctx context.Context, scope string) (*auth.Token, error)

+ func (c *TokenCache) ListCachedScopes(ctx context.Context) ([]string, error)

+ func (c *TokenCache) PurgeExpired(ctx context.Context) (int, error)

+ func (c *TokenCache) Set(ctx context.Context, scope string, token *auth.Token) error

+ type TokenErrorResponse struct

+ Error string

+ ErrorDescription string

+ ErrorURI string

+ type TokenMetadata struct

+ Claims *auth.Claims

+ ClientID string

+ Hostname string

+ IdentityType string

+ LastRefresh time.Time

+ RefreshTokenExpiresAt time.Time

+ Scopes []string

+ SessionID string

+ type TokenResponse struct

+ AccessToken string

+ ExpiresIn int

+ RefreshToken string

+ RefreshTokenExpiresIn int

+ Scope string

+ TokenType string

+ type User struct

+ AvatarURL string

+ Email string

+ ID int64

+ Login string

+ Name string