1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
|
package step
import (
"fmt"
"log"
"os"
"os/user"
"path/filepath"
"runtime"
"strings"
"time"
)
// PathEnv defines the name of the environment variable that can overwrite
// the default configuration path.
const PathEnv = "STEPPATH"
// HomeEnv defines the name of the environment variable that can overwrite the
// default home directory.
const HomeEnv = "HOME"
var (
// version and buildTime are filled in during build by the Makefile
name = "Smallstep CLI"
buildTime = "N/A"
version = "N/A"
// stepBasePath will be populated in init() with the proper STEPPATH.
stepBasePath string
// homePath will be populated in init() with the proper HOME.
homePath string
)
func init() {
l := log.New(os.Stderr, "", 0)
// Get home path from environment or from the user object.
homePath = os.Getenv(HomeEnv)
if homePath == "" {
usr, err := user.Current()
if err == nil && usr.HomeDir != "" {
homePath = usr.HomeDir
} else {
l.Fatalf("Error obtaining home directory, please define environment variable %s.", HomeEnv)
}
}
// Get step path from environment or relative to home.
stepBasePath = os.Getenv(PathEnv)
if stepBasePath == "" {
stepBasePath = filepath.Join(homePath, ".step")
}
// cleanup
homePath = filepath.Clean(homePath)
stepBasePath = filepath.Clean(stepBasePath)
// Check for presence or attempt to create it if necessary.
//
// Some environments (e.g. third party docker images) might fail creating
// the directory, so this should not panic if it can't.
if fi, err := os.Stat(stepBasePath); err != nil {
os.MkdirAll(stepBasePath, 0700)
} else if !fi.IsDir() {
l.Fatalf("File '%s' is not a directory.", stepBasePath)
}
// Initialize context state.
Contexts().Init()
}
// BasePath returns the base path for the step configuration directory.
func BasePath() string {
return stepBasePath
}
// Path returns the path for the step configuration directory.
//
// 1. If the base step path has a current context configured, then this method
// returns the path to the authority configured in the context.
// 2. If the base step path does not have a current context configured this
// method returns the value defined by the environment variable STEPPATH, OR
// 3. If no environment variable is set, this method returns `$HOME/.step`.
func Path() string {
c := Contexts().GetCurrent()
if c == nil {
return BasePath()
}
return filepath.Join(BasePath(), "authorities", c.Authority)
}
// ProfilePath returns the path for the currently selected profile path.
//
// 1. If the base step path has a current context configured, then this method
// returns the path to the profile configured in the context.
// 2. If the base step path does not have a current context configured this
// method returns the value defined by the environment variable STEPPATH, OR
// 3. If no environment variable is set, this method returns `$HOME/.step`.
func ProfilePath() string {
c := Contexts().GetCurrent()
if c == nil {
return BasePath()
}
return filepath.Join(BasePath(), "profiles", c.Profile)
}
// IdentityPath returns the location of the identity directory.
func IdentityPath() string {
return filepath.Join(Path(), "identity")
}
// IdentityFile returns the location of the identity file.
func IdentityFile() string {
return filepath.Join(Path(), "config", "identity.json")
}
// DefaultsFile returns the location of the defaults file at the base of the
// authority path.
func DefaultsFile() string {
return filepath.Join(Path(), "config", "defaults.json")
}
// ProfileDefaultsFile returns the location of the defaults file at the base
// of the profile path.
func ProfileDefaultsFile() string {
return filepath.Join(ProfilePath(), "config", "defaults.json")
}
// ConfigPath returns the location of the $(step path)/config directory.
func ConfigPath() string {
return filepath.Join(Path(), "config")
}
// ProfileConfigPath returns the location of the $(step path --profile)/config directory.
func ProfileConfigPath() string {
return filepath.Join(ProfilePath(), "config")
}
// CaConfigFile returns the location of the ca.json file -- configuration for
// connecting to the CA.
func CaConfigFile() string {
return filepath.Join(Path(), "config", "ca.json")
}
// ContextsFile returns the location of the config file.
func ContextsFile() string {
return filepath.Join(BasePath(), "contexts.json")
}
// CurrentContextFile returns the path to the file containing the current context.
func CurrentContextFile() string {
return filepath.Join(BasePath(), "current-context.json")
}
// Home returns the user home directory using the environment variable HOME or
// the os/user package.
func Home() string {
return homePath
}
// Abs returns the given path relative to the STEPPATH if it's not an
// absolute path, relative to the home directory using the special string "~/",
// or relative to the working directory using "./"
//
// Relative paths like 'certs/root_ca.crt' will be converted to
// '$STEPPATH/certs/root_ca.crt', but paths like './certs/root_ca.crt' will be
// relative to the current directory. Home relative paths like
// ~/certs/root_ca.crt will be converted to '$HOME/certs/root_ca.crt'. And
// absolute paths like '/certs/root_ca.crt' will remain the same.
func Abs(path string) string {
if filepath.IsAbs(path) {
return path
}
// Windows accept both \ and /
slashed := filepath.ToSlash(path)
switch {
case strings.HasPrefix(slashed, "~/"):
return filepath.Join(homePath, path[2:])
case strings.HasPrefix(slashed, "./"), strings.HasPrefix(slashed, "../"):
if abs, err := filepath.Abs(path); err == nil {
return abs
}
return path
default:
return filepath.Join(Path(), path)
}
}
// Set updates the name, version, and build time
func Set(n, v, t string) {
name = n
version = v
buildTime = t
}
// Version returns the current version of the binary
func Version() string {
out := version
if version == "N/A" {
out = "0000000-dev"
}
return fmt.Sprintf("%s/%s (%s/%s)",
name, out, runtime.GOOS, runtime.GOARCH)
}
// ReleaseDate returns the time of when the binary was built
func ReleaseDate() string {
out := buildTime
if buildTime == "N/A" {
out = time.Now().UTC().Format("2006-01-02 15:04 MST")
}
return out
}
|