auth

Documentation

Overview

Package auth is a set of functions for retrieving authentication tokens and authenticated hosts.

Index

• func DefaultHost() (string, string)
• func KnownHosts() []string
• func TokenForHost(host string) (string, string)
• func TokenFromEnvOrConfig(host string) (string, string)

Functions

func DefaultHost

func DefaultHost() (string, string)

DefaultHost retrieves an authenticated host and the source of host. The source can be either an environment variable or from the configuration file. Returns "github.com", "default" if no viable host is found.

func KnownHosts

func KnownHosts() []string

KnownHosts retrieves a list of hosts that have corresponding authentication tokens, either from environment variables or from the configuration file. Returns an empty string slice if no hosts are found.

func TokenForHost

func TokenForHost(host string) (string, string)

TokenForHost retrieves an authentication token and the source of that token for the specified host. The source can be either an environment variable, configuration file, or the system keyring. In the latter case, this shells out to "gh auth token" to obtain the token.

Returns "", "default" if no applicable token is found.

func TokenFromEnvOrConfig

func TokenFromEnvOrConfig(host string) (string, string)

TokenFromEnvOrConfig retrieves an authentication token from environment variables or the config file as fallback, but does not support reading the token from system keyring. Most consumers should use TokenForHost.