github.com/kbehouse/nsc@v0.0.6/cmd/root.go

/*
 * Copyright 2018-2021 The NATS Authors
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package cmd

import (
	"errors"
	"fmt"
	"io"
	"os"
	"path/filepath"
	"strings"

	"github.com/kbehouse/nsc/cmd/store"
	"github.com/mitchellh/go-homedir"
	cli "github.com/nats-io/cliprompts/v2"
	"github.com/nats-io/nats.go"
	"github.com/nats-io/nkeys"
	"github.com/spf13/cobra"
	"github.com/spf13/viper"
)

const TestEnv = "NSC_TEST"

var KeyPathFlag string
var InteractiveFlag bool
var NscCwdOnly bool
var quietMode bool

var cfgFile string

var ErrNoOperator = errors.New("set an operator -- 'nsc env -o operatorName'")

type InterceptorFn func(ctx ActionCtx, params interface{}) error

func GetStoreForOperator(operator string) (*store.Store, error) {
	config := GetConfig()
	if config.StoreRoot == "" {
		return nil, errors.New("no stores available")
	}
	if err := IsValidDir(config.StoreRoot); err != nil {
		return nil, err
	}

	if operator != "" {
		config.Operator = operator
	}

	if config.Operator == "" {
		config.SetDefaults()
		if config.Operator == "" {
			return nil, ErrNoOperator
		}
	}

	fp := filepath.Join(config.StoreRoot, config.Operator)
	ngsStore, err := store.LoadStore(fp)
	if err != nil {
		return nil, err
	}

	if config.Account != "" {
		ngsStore.DefaultAccount = config.Account
	}
	return ngsStore, nil
}

func GetStore() (*store.Store, error) {
	return GetStoreForOperator("")
}

func ResolveKeyFlag() (nkeys.KeyPair, error) {
	if KeyPathFlag != "" {
		kp, err := store.ResolveKey(KeyPathFlag)
		if err != nil {
			return nil, err
		}
		return kp, nil
	}
	return nil, nil
}

func GetRootCmd() *cobra.Command {
	return rootCmd
}

func EnterQuietMode() {
	quietMode = true
}

func SetQuietMode(tf bool) {
	quietMode = tf
}

func QuietMode() bool {
	return quietMode
}

var rootCmd = &cobra.Command{
	Use:   "nsc",
	Short: "nsc creates NATS operators, accounts, users, and manage their permissions.",
	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
		if store, _ := GetStore(); store != nil {
			if c, _ := store.ReadOperatorClaim(); c != nil && c.Version == 1 {
				if c.Version > 2 {
					return fmt.Errorf("the store %#q is at version %d. To upgrade nsc - type `%s update`",
						store.GetName(), c.Version, os.Args[0])
				} else if c.Version == 1 {
					allowCmdWithJWTV1Store := cmd.Name() == "upgrade-jwt" || cmd.Name() == "env" || cmd.Name() == "help" || cmd.Name() == "update"
					if !allowCmdWithJWTV1Store && cmd.Name() == "operator" {
						for _, v := range addCmd.Commands() {
							if v == cmd {
								allowCmdWithJWTV1Store = true
								break
							}
						}
					}
					if !allowCmdWithJWTV1Store {
						//lint:ignore ST1005 this message is shown to the user
						return fmt.Errorf(`This version of nsc only supports jwtV2. 
If you are using a managed service, check your provider for 
instructions on how to update your project. In most cases 
all you need to do is:
"%s add operator --force -u <url provided by your service>"

If your service is well known, such as Synadia's NGS:
"%s add operator --force -u synadia"

If you are the operator, and you have your operator key, to 
upgrade the v1 store %#q - type:
"%s upgrade-jwt"

Alternatively you can downgrade' %q to a compatible version using: 
"%s update --version 0.5.0"
`,
							os.Args[0], os.Args[0], store.GetName(), os.Args[0], os.Args[0], os.Args[0])
					}
				}
			}
		}
		if cmd.Name() == "migrate" && cmd.Parent().Name() == "keys" {
			return nil
		}
		// check if we need to perform any kind of migration
		needsUpdate, err := store.KeysNeedMigration()
		if err != nil {
			return err
		}
		if needsUpdate {
			cmd.SilenceUsage = true
			return fmt.Errorf("the keystore %#q needs migration - type `%s keys migrate` to update", AbbrevHomePaths(store.GetKeysDir()), os.Args[0])
		}

		return nil
	},
}

// Execute adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() {
	err := ExecuteWithWriter(rootCmd.OutOrStderr())
	if err != nil {
		os.Exit(1)
	}
}

// ExecuteWithWriter adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
// But writer is decided by the caller function
// returns error than os.Exit(1)
func ExecuteWithWriter(out io.Writer) error {
	cli.SetOutput(out)
	if err := GetRootCmd().Execute(); err != nil {
		return err
	}
	return nil
}

func SetEnvOptions() {
	if _, ok := os.LookupEnv(NscNoGitIgnoreEnv); ok {
		store.NscNotGitIgnore = true
	}
	if _, ok := os.LookupEnv(NscCwdOnlyEnv); ok {
		NscCwdOnly = true
	}
	if f, ok := os.LookupEnv(NscRootCasNatsEnv); ok {
		rootCAsFile = strings.TrimSpace(f)
		rootCAsNats = nats.RootCAs(rootCAsFile)
	}
	key, okKey := os.LookupEnv(NscTlsKeyNatsEnv)
	cert, okCert := os.LookupEnv(NscTlsCertNatsEnv)
	if okKey || okCert {
		tlsKeyNats = nats.ClientCert(cert, key)
	}
}

func init() {
	SetEnvOptions()
	cobra.OnInitialize(initConfig)
	HoistRootFlags(GetRootCmd())
}

// HoistRootFlags adds persistent flags that would be added by the cobra framework
// but are not because the unit tests are testing the command directly
func HoistRootFlags(cmd *cobra.Command) *cobra.Command {
	cmd.PersistentFlags().StringVarP(&KeyPathFlag, "private-key", "K", "", "Key used to sign. Can be specified as role (where applicable), public key (private portion is retrieved) or file path to a private key or private key ")
	cmd.PersistentFlags().BoolVarP(&InteractiveFlag, "interactive", "i", false, "ask questions for various settings")
	return cmd
}

// initConfig reads in config file and ENV variables if set.
func initConfig() {
	if cfgFile != "" {
		// Use config file from the flag.
		viper.SetConfigFile(cfgFile)
	} else {
		// Find home directory.
		home, err := homedir.Dir()
		if err != nil {
			fmt.Println(err)
			os.Exit(1)
		}

		// Search config in home directory with name ".nsc" (without extension).
		viper.AddConfigPath(home)
		viper.SetConfigName(".nsc")
	}

	viper.AutomaticEnv() // read in environment variables that match

	// If a config file is found, read it in.
	if err := viper.ReadInConfig(); err == nil {
		fmt.Println("Using config file:", viper.ConfigFileUsed())
	}
}