credentials.go

package cli

import (
	"fmt"
	"net/http"
	"os"
	"path"
	"strings"

	"github.com/olekukonko/tablewriter"
	"github.com/rs/zerolog"
	"github.com/spf13/cobra"
	"github.com/spf13/viper"
	"gopkg.in/h2non/gentleman.v2/context"
)

// AuthHandler describes a handler that can be called on a request to inject
// auth information and is agnostic to the type of auth.
type AuthHandler interface {
	// ProfileKeys returns the key names for fields to store in the profile.
	ProfileKeys() []string

	// OnRequest gets run before the request goes out on the wire.
	OnRequest(log *zerolog.Logger, request *http.Request) error
}

// AuthHandlers is the map of registered auth type names to handlers
var AuthHandlers = make(map[string]AuthHandler)

var authInitialized bool
var authCommand *cobra.Command
var authAddCommand *cobra.Command

// initAuth sets up basic commands and the credentials file so that new auth
// handlers can be registered. This is safe to call many times.
func initAuth() {
	if authInitialized {
		return
	}
	authInitialized = true

	// Set up the credentials file
	InitCredentialsFile()

	// Add base auth commands
	authCommand = &cobra.Command{
		Use:   "auth",
		Short: "Authentication settings",
	}
	Root.AddCommand(authCommand)

	authAddCommand = &cobra.Command{
		Use:     "add-profile",
		Aliases: []string{"add"},
		Short:   "Add user profile for authentication",
	}
	authCommand.AddCommand(authAddCommand)

	authCommand.AddCommand(&cobra.Command{
		Use:     "list-profiles",
		Aliases: []string{"ls"},
		Short:   "List available configured authentication profiles",
		Args:    cobra.NoArgs,
		Run: func(cmd *cobra.Command, args []string) {
			profiles := Creds.GetStringMap("profiles")

			if profiles != nil {
				// Use a map as a set to find the available auth type names.
				types := make(map[string]bool)
				for _, v := range profiles {
					if typeName := v.(map[string]interface{})["type"]; typeName != nil {
						types[typeName.(string)] = true
					}
				}

				// For each type name, draw a table with the relevant profile keys
				for typeName := range types {
					handler := AuthHandlers[typeName]
					if handler == nil {
						continue
					}

					listKeys := handler.ProfileKeys()

					table := tablewriter.NewWriter(os.Stdout)
					table.SetHeader(append([]string{fmt.Sprintf("%s Profile Name", typeName)}, listKeys...))

					for name, p := range profiles {
						profile := p.(map[string]interface{})
						if ptype := profile["type"]; ptype == nil || ptype.(string) != typeName {
							continue
						}

						row := []string{name}
						for _, key := range listKeys {
							row = append(row, profile[strings.Replace(key, "-", "_", -1)].(string))
						}
						table.Append(row)
					}
					table.Render()
				}
			} else {
				fmt.Printf("No profiles configured. Use `%s auth add-profile` to add one.\n", Root.CommandPath())
			}
		},
	})

	// Install auth middleware
	Client.UseRequest(func(ctx *context.Context, h context.Handler) {
		profile := GetProfile()

		handler := AuthHandlers[profile["type"]]
		if handler == nil {
			h.Error(ctx, fmt.Errorf("no handler for auth type %s", profile["type"]))
			return
		}

		if err := handler.OnRequest(ctx.Get("log").(*zerolog.Logger), ctx.Request); err != nil {
			h.Error(ctx, err)
			return
		}

		h.Next(ctx)
	})
}

// UseAuth registers a new auth handler for a given type name. For backward-
// compatibility, the auth type name can be a blank string. It is recommended
// to always pass a value for the type name.
func UseAuth(typeName string, handler AuthHandler) {
	// Initialize auth system if it isn't already set up.
	initAuth()

	// Register the handler by its type.
	AuthHandlers[typeName] = handler

	// Set up the add-profile command.
	keys := handler.ProfileKeys()

	use := " [flags] <name>"
	for _, name := range keys {
		use += " <" + strings.Replace(name, "_", "-", -1) + ">"
	}

	run := func(cmd *cobra.Command, args []string) {
		name := strings.Replace(args[0], ".", "-", -1)
		Creds.Set("profiles."+name+".type", typeName)

		for i, key := range keys {
			// Replace periods in the name since Viper will create nested structures
			// in the config and this isn't what we want!
			Creds.Set("profiles."+name+"."+strings.Replace(key, "-", "_", -1), args[i+1])
		}

		filename := path.Join(viper.GetString("config-directory"), "credentials.json")
		if err := Creds.WriteConfigAs(filename); err != nil {
			panic(err)
		}
	}

	if typeName == "" {
		// Backward-compatibility use-case without an explicit type. Set up the
		// `add-profile` command as the only way to authenticate.
		if authAddCommand.Run != nil {
			// This fallback code path was already used, so we must be registering
			// a *second* anonymous auth type, which is not allowed.
			panic("register auth type names to use multi-auth")
		}

		authAddCommand.Use = "add-profile" + use
		authAddCommand.Short = "Add a new named authentication profile"
		authAddCommand.Args = cobra.ExactArgs(1 + len(keys))
		authAddCommand.Run = run
	} else {
		// Add a new type-specific `add-profile` subcommand.
		authAddCommand.AddCommand(&cobra.Command{
			Use:   typeName + use,
			Short: "Add a new named " + typeName + " authentication profile",
			Args:  cobra.ExactArgs(1 + len(keys)),
			Run:   run,
		})
	}
}

// CredentialsFile holds credential-related information.
type CredentialsFile struct {
	*viper.Viper
	keys     []string
	listKeys []string
}

// Creds represents a configuration file storing credential-related information.
// Use this only after `InitCredentials` has been called.
var Creds *CredentialsFile

// GetProfile returns the current profile's configuration.
func GetProfile() map[string]string {
	return Creds.GetStringMapString("profiles." + strings.Replace(viper.GetString("profile"), ".", "-", -1))
}

// ProfileKeys lets you specify authentication profile keys to be used in
// the credentials file.
// This is deprecated and you should use `cli.UseAuth` instead.
func ProfileKeys(keys ...string) func(*CredentialsFile) error {
	return func(cf *CredentialsFile) error {
		cf.keys = keys
		return nil
	}
}

// ProfileListKeys sets which keys will be shown in the table when calling
// the `auth list-profiles` command.
// This is deprecated and you should use `cli.UseAuth` instead.
func ProfileListKeys(keys ...string) func(*CredentialsFile) error {
	return func(cf *CredentialsFile) error {
		cf.listKeys = keys
		return nil
	}
}

// InitCredentialsFile sets up the creds file and `profile` global parameter.
func InitCredentialsFile() {
	// Setup a credentials file, kept separate from configuration which might
	// get checked into source control.
	Creds = &CredentialsFile{viper.New(), []string{}, []string{}}

	Creds.SetConfigName("credentials")
	Creds.AddConfigPath("$HOME/." + viper.GetString("app-name") + "/")
	Creds.ReadInConfig()

	// Register a new `--profile` flag.
	AddGlobalFlag("profile", "", "Credentials profile to use for authentication", "default")
}

// InitCredentials sets up the profile/auth commands. Must be called *after* you
// have called `cli.Init()`.
//
//  // Initialize an API key
//  cli.InitCredentials(cli.ProfileKeys("api-key"))
// This is deprecated and you should use `cli.UseAuth` instead.
func InitCredentials(options ...func(*CredentialsFile) error) {
	InitCredentialsFile()

	for _, option := range options {
		option(Creds)
	}

	// Register auth management commands to create and list profiles.
	cmd := &cobra.Command{
		Use:   "auth",
		Short: "Authentication settings",
	}
	Root.AddCommand(cmd)

	use := "add-profile [flags] <name>"
	for _, name := range Creds.keys {
		use += " <" + strings.Replace(name, "_", "-", -1) + ">"
	}

	cmd.AddCommand(&cobra.Command{
		Use:     use,
		Aliases: []string{"add"},
		Short:   "Add a new named authentication profile",
		Args:    cobra.ExactArgs(1 + len(Creds.keys)),
		Run: func(cmd *cobra.Command, args []string) {
			for i, key := range Creds.keys {
				// Replace periods in the name since Viper will create nested structures
				// in the config and this isn't what we want!
				name := strings.Replace(args[0], ".", "-", -1)
				Creds.Set("profiles."+name+"."+strings.Replace(key, "-", "_", -1), args[i+1])
			}

			filename := path.Join(viper.GetString("config-directory"), "credentials.json")
			if err := Creds.WriteConfigAs(filename); err != nil {
				panic(err)
			}
		},
	})

	cmd.AddCommand(&cobra.Command{
		Use:     "list-profiles",
		Aliases: []string{"ls"},
		Short:   "List available configured authentication profiles",
		Args:    cobra.NoArgs,
		Run: func(cmd *cobra.Command, args []string) {
			profiles := Creds.GetStringMap("profiles")
			if profiles != nil {
				table := tablewriter.NewWriter(os.Stdout)
				table.SetHeader(append([]string{"Profile Name"}, Creds.listKeys...))

				for name, profile := range profiles {
					row := []string{name}
					for _, key := range Creds.listKeys {
						row = append(row, profile.(map[string]interface{})[strings.Replace(key, "-", "_", -1)].(string))
					}
					table.Append(row)
				}
				table.Render()
			} else {
				fmt.Printf("No profiles configured. Use `%s auth add-profile` to add one.\n", Root.CommandPath())
			}
		},
	})
}