towards moving config into context
This commit is contained in:
nate smith
parent
3b635d5260
commit
7427716ea8
7 changed files with 17 additions and 80 deletions
397
github/config.go
397
github/config.go
|
|
@ -1,397 +0,0 @@
|
|||
package github
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"net/url"
|
||||
"os"
|
||||
"os/signal"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
"syscall"
|
||||
|
||||
"github.com/github/gh-cli/ui"
|
||||
"github.com/github/gh-cli/utils"
|
||||
"github.com/mitchellh/go-homedir"
|
||||
"golang.org/x/crypto/ssh/terminal"
|
||||
)
|
||||
|
||||
type yamlHost struct {
|
||||
User string `yaml:"user"`
|
||||
OAuthToken string `yaml:"oauth_token"`
|
||||
Protocol string `yaml:"protocol"`
|
||||
UnixSocket string `yaml:"unix_socket,omitempty"`
|
||||
}
|
||||
|
||||
type Host struct {
|
||||
Host string `toml:"host"`
|
||||
User string `toml:"user"`
|
||||
AccessToken string `toml:"access_token"`
|
||||
Protocol string `toml:"protocol"`
|
||||
UnixSocket string `toml:"unix_socket,omitempty"`
|
||||
}
|
||||
|
||||
type Config struct {
|
||||
Hosts []*Host `toml:"hosts"`
|
||||
}
|
||||
|
||||
func (c *Config) PromptForHost(host string) (h *Host, err error) {
|
||||
token := c.DetectToken()
|
||||
tokenFromEnv := token != ""
|
||||
|
||||
if host != GitHubHost {
|
||||
if _, e := url.Parse("https://" + host); e != nil {
|
||||
err = fmt.Errorf("invalid hostname: %q", host)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
h = c.Find(host)
|
||||
if h != nil {
|
||||
if h.User == "" {
|
||||
utils.Check(CheckWriteable(configsFile()))
|
||||
// User is missing from the config: this is a broken config probably
|
||||
// because it was created with an old (broken) version of hub. Let's fix
|
||||
// it now. See issue #1007 for details.
|
||||
user := c.PromptForUser(host)
|
||||
if user == "" {
|
||||
utils.Check(fmt.Errorf("missing user"))
|
||||
}
|
||||
h.User = user
|
||||
err := newConfigService().Save(configsFile(), c)
|
||||
utils.Check(err)
|
||||
}
|
||||
if tokenFromEnv {
|
||||
h.AccessToken = token
|
||||
} else {
|
||||
return
|
||||
}
|
||||
} else {
|
||||
h = &Host{
|
||||
Host: host,
|
||||
AccessToken: token,
|
||||
Protocol: "https",
|
||||
}
|
||||
c.Hosts = append(c.Hosts, h)
|
||||
}
|
||||
|
||||
client := NewClientWithHost(h)
|
||||
|
||||
if !tokenFromEnv {
|
||||
utils.Check(CheckWriteable(configsFile()))
|
||||
err = c.authorizeClient(client, host)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
userFromEnv := os.Getenv("GITHUB_USER")
|
||||
repoFromEnv := os.Getenv("GITHUB_REPOSITORY")
|
||||
if userFromEnv == "" && repoFromEnv != "" {
|
||||
repoParts := strings.SplitN(repoFromEnv, "/", 2)
|
||||
if len(repoParts) > 0 {
|
||||
userFromEnv = repoParts[0]
|
||||
}
|
||||
}
|
||||
if tokenFromEnv && userFromEnv != "" {
|
||||
h.User = userFromEnv
|
||||
} else {
|
||||
var currentUser *User
|
||||
currentUser, err = client.CurrentUser()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
h.User = currentUser.Login
|
||||
}
|
||||
|
||||
if !tokenFromEnv {
|
||||
err = newConfigService().Save(configsFile(), c)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func (c *Config) authorizeClient(client *Client, host string) (err error) {
|
||||
user := c.PromptForUser(host)
|
||||
pass := c.PromptForPassword(host, user)
|
||||
|
||||
var code, token string
|
||||
for {
|
||||
token, err = client.FindOrCreateToken(user, pass, code)
|
||||
if err == nil {
|
||||
break
|
||||
}
|
||||
|
||||
if ae, ok := err.(*errorInfo); ok && strings.HasPrefix(ae.Response.Header.Get("X-GitHub-OTP"), "required;") {
|
||||
if code != "" {
|
||||
ui.Errorln("warning: invalid two-factor code")
|
||||
}
|
||||
code = c.PromptForOTP()
|
||||
} else {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if err == nil {
|
||||
client.Host.AccessToken = token
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func (c *Config) DetectToken() string {
|
||||
return os.Getenv("GITHUB_TOKEN")
|
||||
}
|
||||
|
||||
func (c *Config) PromptForUser(host string) (user string) {
|
||||
user = os.Getenv("GITHUB_USER")
|
||||
if user != "" {
|
||||
return
|
||||
}
|
||||
|
||||
ui.Printf("%s username: ", host)
|
||||
user = c.scanLine()
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func (c *Config) PromptForPassword(host, user string) (pass string) {
|
||||
pass = os.Getenv("GITHUB_PASSWORD")
|
||||
if pass != "" {
|
||||
return
|
||||
}
|
||||
|
||||
ui.Printf("%s password for %s (never stored): ", host, user)
|
||||
if ui.IsTerminal(os.Stdin) {
|
||||
if password, err := getPassword(); err == nil {
|
||||
pass = password
|
||||
}
|
||||
} else {
|
||||
pass = c.scanLine()
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func (c *Config) PromptForOTP() string {
|
||||
fmt.Print("two-factor authentication code: ")
|
||||
return c.scanLine()
|
||||
}
|
||||
|
||||
func (c *Config) scanLine() string {
|
||||
var line string
|
||||
scanner := bufio.NewScanner(os.Stdin)
|
||||
if scanner.Scan() {
|
||||
line = scanner.Text()
|
||||
}
|
||||
utils.Check(scanner.Err())
|
||||
|
||||
return line
|
||||
}
|
||||
|
||||
func getPassword() (string, error) {
|
||||
stdin := int(syscall.Stdin)
|
||||
initialTermState, err := terminal.GetState(stdin)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
c := make(chan os.Signal)
|
||||
signal.Notify(c, os.Interrupt, syscall.SIGTERM)
|
||||
go func() {
|
||||
s := <-c
|
||||
terminal.Restore(stdin, initialTermState)
|
||||
switch sig := s.(type) {
|
||||
case syscall.Signal:
|
||||
if int(sig) == 2 {
|
||||
fmt.Println("^C")
|
||||
}
|
||||
}
|
||||
os.Exit(1)
|
||||
}()
|
||||
|
||||
passBytes, err := terminal.ReadPassword(stdin)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
signal.Stop(c)
|
||||
fmt.Print("\n")
|
||||
return string(passBytes), nil
|
||||
}
|
||||
|
||||
func (c *Config) Find(host string) *Host {
|
||||
for _, h := range c.Hosts {
|
||||
if h.Host == host {
|
||||
return h
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *Config) selectHost() *Host {
|
||||
options := len(c.Hosts)
|
||||
|
||||
if options == 1 {
|
||||
return c.Hosts[0]
|
||||
}
|
||||
|
||||
prompt := "Select host:\n"
|
||||
for idx, host := range c.Hosts {
|
||||
prompt += fmt.Sprintf(" %d. %s\n", idx+1, host.Host)
|
||||
}
|
||||
prompt += fmt.Sprint("> ")
|
||||
|
||||
ui.Printf(prompt)
|
||||
index := c.scanLine()
|
||||
i, err := strconv.Atoi(index)
|
||||
if err != nil || i < 1 || i > options {
|
||||
utils.Check(fmt.Errorf("Error: must enter a number [1-%d]", options))
|
||||
}
|
||||
|
||||
return c.Hosts[i-1]
|
||||
}
|
||||
|
||||
var defaultConfigsFile string
|
||||
|
||||
func configsFile() string {
|
||||
if configFromEnv := os.Getenv("HUB_CONFIG"); configFromEnv != "" {
|
||||
return configFromEnv
|
||||
}
|
||||
if defaultConfigsFile == "" {
|
||||
var err error
|
||||
defaultConfigsFile, err = determineConfigLocation()
|
||||
utils.Check(err)
|
||||
}
|
||||
return defaultConfigsFile
|
||||
}
|
||||
|
||||
func homeConfig() (string, error) {
|
||||
if home, err := homedir.Dir(); err != nil {
|
||||
return "", err
|
||||
} else {
|
||||
return filepath.Join(home, ".config"), nil
|
||||
}
|
||||
}
|
||||
|
||||
func determineConfigLocation() (string, error) {
|
||||
var err error
|
||||
|
||||
xdgHome := os.Getenv("XDG_CONFIG_HOME")
|
||||
configDir := xdgHome
|
||||
if configDir == "" {
|
||||
if configDir, err = homeConfig(); err != nil {
|
||||
return "", err
|
||||
}
|
||||
}
|
||||
|
||||
xdgDirs := os.Getenv("XDG_CONFIG_DIRS")
|
||||
if xdgDirs == "" {
|
||||
xdgDirs = "/etc/xdg"
|
||||
}
|
||||
searchDirs := append([]string{configDir}, strings.Split(xdgDirs, ":")...)
|
||||
|
||||
for _, dir := range searchDirs {
|
||||
filename := filepath.Join(dir, "hub")
|
||||
if _, err := os.Stat(filename); err == nil {
|
||||
return filename, nil
|
||||
}
|
||||
}
|
||||
|
||||
configFile := filepath.Join(configDir, "hub")
|
||||
|
||||
if configDir == xdgHome {
|
||||
if homeDir, _ := homeConfig(); homeDir != "" {
|
||||
legacyConfig := filepath.Join(homeDir, "hub")
|
||||
if _, err = os.Stat(legacyConfig); err == nil {
|
||||
ui.Errorf("Notice: config file found but not respected at: %s\n", legacyConfig)
|
||||
ui.Errorf("You might want to move it to `%s' to avoid re-authenticating.\n", configFile)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return configFile, nil
|
||||
}
|
||||
|
||||
var currentConfig *Config
|
||||
var configLoadedFrom = ""
|
||||
|
||||
func CurrentConfig() *Config {
|
||||
filename := configsFile()
|
||||
if configLoadedFrom != filename {
|
||||
currentConfig = &Config{}
|
||||
newConfigService().Load(filename, currentConfig)
|
||||
configLoadedFrom = filename
|
||||
}
|
||||
|
||||
return currentConfig
|
||||
}
|
||||
|
||||
func (c *Config) DefaultHost() (host *Host, err error) {
|
||||
if GitHubHostEnv != "" {
|
||||
host, err = c.PromptForHost(GitHubHostEnv)
|
||||
} else if len(c.Hosts) > 0 {
|
||||
host = c.selectHost()
|
||||
// HACK: forces host to inherit GITHUB_TOKEN if applicable
|
||||
host, err = c.PromptForHost(host.Host)
|
||||
} else {
|
||||
host, err = c.PromptForHost(DefaultGitHubHost())
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// CheckWriteable checks if config file is writeable. This should
|
||||
// be called before asking for credentials and only if current
|
||||
// operation needs to update the file. See issue #1314 for details.
|
||||
func CheckWriteable(filename string) error {
|
||||
// Check if file exists already. if it doesn't, we will delete it after
|
||||
// checking for writeabilty
|
||||
fileExistsAlready := false
|
||||
|
||||
if _, err := os.Stat(filename); err == nil {
|
||||
fileExistsAlready = true
|
||||
}
|
||||
|
||||
err := os.MkdirAll(filepath.Dir(filename), 0771)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
w, err := os.OpenFile(filename, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0600)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
w.Close()
|
||||
|
||||
if !fileExistsAlready {
|
||||
err := os.Remove(filename)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Public for testing purpose
|
||||
func CreateTestConfigs(user, token string) *Config {
|
||||
f, _ := ioutil.TempFile("", "test-config")
|
||||
os.Setenv("HUB_CONFIG", f.Name())
|
||||
|
||||
host := &Host{
|
||||
User: "jingweno",
|
||||
AccessToken: "123",
|
||||
Host: GitHubHost,
|
||||
}
|
||||
|
||||
c := &Config{Hosts: []*Host{host}}
|
||||
err := newConfigService().Save(f.Name(), c)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
return c
|
||||
}
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
package github
|
||||
|
||||
import (
|
||||
"io"
|
||||
"io/ioutil"
|
||||
|
||||
"github.com/BurntSushi/toml"
|
||||
"gopkg.in/yaml.v2"
|
||||
)
|
||||
|
||||
type configDecoder interface {
|
||||
Decode(r io.Reader, c *Config) error
|
||||
}
|
||||
|
||||
type tomlConfigDecoder struct {
|
||||
}
|
||||
|
||||
func (t *tomlConfigDecoder) Decode(r io.Reader, c *Config) error {
|
||||
_, err := toml.DecodeReader(r, c)
|
||||
return err
|
||||
}
|
||||
|
||||
type yamlConfigDecoder struct {
|
||||
}
|
||||
|
||||
func (y *yamlConfigDecoder) Decode(r io.Reader, c *Config) error {
|
||||
d, err := ioutil.ReadAll(r)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
yc := yaml.MapSlice{}
|
||||
err = yaml.Unmarshal(d, &yc)
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, hostEntry := range yc {
|
||||
v := hostEntry.Value.([]interface{})
|
||||
if len(v) < 1 {
|
||||
continue
|
||||
}
|
||||
host := &Host{Host: hostEntry.Key.(string)}
|
||||
for _, prop := range v[0].(yaml.MapSlice) {
|
||||
switch prop.Key.(string) {
|
||||
case "user":
|
||||
host.User = prop.Value.(string)
|
||||
case "oauth_token":
|
||||
host.AccessToken = prop.Value.(string)
|
||||
case "protocol":
|
||||
host.Protocol = prop.Value.(string)
|
||||
case "unix_socket":
|
||||
host.UnixSocket = prop.Value.(string)
|
||||
}
|
||||
}
|
||||
c.Hosts = append(c.Hosts, host)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
package github
|
||||
|
||||
import (
|
||||
"io"
|
||||
|
||||
"github.com/BurntSushi/toml"
|
||||
"gopkg.in/yaml.v2"
|
||||
)
|
||||
|
||||
type configEncoder interface {
|
||||
Encode(w io.Writer, c *Config) error
|
||||
}
|
||||
|
||||
type tomlConfigEncoder struct {
|
||||
}
|
||||
|
||||
func (t *tomlConfigEncoder) Encode(w io.Writer, c *Config) error {
|
||||
enc := toml.NewEncoder(w)
|
||||
return enc.Encode(c)
|
||||
}
|
||||
|
||||
type yamlConfigEncoder struct {
|
||||
}
|
||||
|
||||
func (y *yamlConfigEncoder) Encode(w io.Writer, c *Config) error {
|
||||
yc := yaml.MapSlice{}
|
||||
for _, h := range c.Hosts {
|
||||
yc = append(yc, yaml.MapItem{
|
||||
Key: h.Host,
|
||||
Value: []yamlHost{
|
||||
{
|
||||
User: h.User,
|
||||
OAuthToken: h.AccessToken,
|
||||
Protocol: h.Protocol,
|
||||
UnixSocket: h.UnixSocket,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
d, err := yaml.Marshal(yc)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
n, err := w.Write(d)
|
||||
if err == nil && n < len(d) {
|
||||
err = io.ErrShortWrite
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
package github
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
func newConfigService() *configService {
|
||||
return &configService{
|
||||
Encoder: &yamlConfigEncoder{},
|
||||
Decoder: &yamlConfigDecoder{},
|
||||
}
|
||||
}
|
||||
|
||||
type configService struct {
|
||||
Encoder configEncoder
|
||||
Decoder configDecoder
|
||||
}
|
||||
|
||||
func (s *configService) Save(filename string, c *Config) error {
|
||||
err := os.MkdirAll(filepath.Dir(filename), 0771)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
w, err := os.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer w.Close()
|
||||
|
||||
return s.Encoder.Encode(w, c)
|
||||
}
|
||||
|
||||
func (s *configService) Load(filename string, c *Config) error {
|
||||
r, err := os.Open(filename)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer r.Close()
|
||||
|
||||
return s.Decoder.Decode(r, c)
|
||||
}
|
||||
|
|
@ -1,64 +0,0 @@
|
|||
package github
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/url"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/github/gh-cli/git"
|
||||
)
|
||||
|
||||
var (
|
||||
GitHubHostEnv = os.Getenv("GITHUB_HOST")
|
||||
cachedHosts []string
|
||||
)
|
||||
|
||||
type GithubHostError struct {
|
||||
url *url.URL
|
||||
}
|
||||
|
||||
func (e *GithubHostError) Error() string {
|
||||
return fmt.Sprintf("Invalid GitHub URL: %s", e.url)
|
||||
}
|
||||
|
||||
func KnownGitHubHostsInclude(host string) bool {
|
||||
for _, hh := range knownGitHubHosts() {
|
||||
if hh == host {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
func knownGitHubHosts() []string {
|
||||
if cachedHosts != nil {
|
||||
return cachedHosts
|
||||
}
|
||||
|
||||
hosts := []string{}
|
||||
defaultHost := DefaultGitHubHost()
|
||||
hosts = append(hosts, defaultHost)
|
||||
hosts = append(hosts, "ssh.github.com")
|
||||
|
||||
ghHosts, _ := git.ConfigAll("hub.host")
|
||||
for _, ghHost := range ghHosts {
|
||||
ghHost = strings.TrimSpace(ghHost)
|
||||
if ghHost != "" {
|
||||
hosts = append(hosts, ghHost)
|
||||
}
|
||||
}
|
||||
|
||||
cachedHosts = hosts
|
||||
return hosts
|
||||
}
|
||||
|
||||
func DefaultGitHubHost() string {
|
||||
defaultHost := GitHubHostEnv
|
||||
if defaultHost == "" {
|
||||
defaultHost = GitHubHost
|
||||
}
|
||||
|
||||
return defaultHost
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue