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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
|
package flags
import (
"encoding/json"
"fmt"
"net/url"
"path/filepath"
"strings"
"time"
"github.com/pkg/errors"
"github.com/smallstep/certificates/api"
"github.com/smallstep/cli/config"
"github.com/smallstep/cli/errs"
"github.com/smallstep/cli/utils"
"github.com/urfave/cli"
)
var (
// KTY is the flag to set the key type.
KTY = cli.StringFlag{
Name: "kty",
Value: "EC",
Usage: `The <kty> to build the certificate upon.
If unset, default is EC.
: <kty> is a case-sensitive string and must be one of:
**EC**
: Create an **elliptic curve** keypair
**OKP**
: Create an octet key pair (for **"Ed25519"** curve)
**RSA**
: Create an **RSA** keypair`,
}
// Size is the flag to set the key size.
Size = cli.IntFlag{
Name: "size",
Usage: `The <size> (in bits) of the key for RSA and oct key types. RSA keys require a
minimum key size of 2048 bits. If unset, default is 2048 bits for RSA keys and 128 bits for oct keys.`,
}
// Curve is the flag to se the key curve.
Curve = cli.StringFlag{
Name: "crv, curve",
Usage: `The elliptic <curve> to use for EC and OKP key types. Corresponds
to the **"crv"** JWK parameter. Valid curves are defined in JWA [RFC7518]. If
unset, default is P-256 for EC keys and Ed25519 for OKP keys.
: <curve> is a case-sensitive string and must be one of:
**P-256**
: NIST P-256 Curve
**P-384**
: NIST P-384 Curve
**P-521**
: NIST P-521 Curve
**Ed25519**
: Ed25519 Curve`,
}
// Subtle is the flag required for delicate operations.
Subtle = cli.BoolFlag{
Name: "subtle",
}
// Insecure is the flag required on insecure operations
Insecure = cli.BoolFlag{
Name: "insecure",
}
// K8sSATokenPathFlag is an optional flag that allows modification of the
// kubernetes service account token path.
K8sSATokenPathFlag = cli.StringFlag{
Name: "k8ssa-token-path",
Usage: `Configure the <file> from which to read the kubernetes service account token.`,
Value: `/var/run/secrets/kubernetes.io/serviceaccount/token`,
}
// Force is a cli.Flag used to overwrite files.
Force = cli.BoolFlag{
Name: "f,force",
Usage: "Force the overwrite of files without asking.",
}
// DryRun is a cli.Flag used to avoid the writing of files.
DryRun = cli.BoolFlag{
Name: "dry-run",
Usage: "Executes the command without changing any file.",
}
// PasswordFile is a cli.Flag used to pass a file to encrypt or decrypt a
// private key.
PasswordFile = cli.StringFlag{
Name: "password-file",
Usage: `The path to the <file> containing the password to encrypt or decrypt the private key.`,
}
// NoPassword is a cli.Flag used to avoid using a password to encrypt private
// keys.
NoPassword = cli.BoolFlag{
Name: "no-password",
Usage: `Do not ask for a password to encrypt a private key. Sensitive key material will
be written to disk unencrypted. This is not recommended. Requires **--insecure** flag.`,
}
// Token is a cli.Flag used to pass the CA token.
Token = cli.StringFlag{
Name: "token",
Usage: `The one-time <token> used to authenticate with the CA in order to create the
certificate.`,
}
// NotBefore is a cli.Flag used to pass the start period of the certificate
// validity.
NotBefore = cli.StringFlag{
Name: "not-before",
Usage: `The <time|duration> when the certificate validity period starts. If a <time> is
used it is expected to be in RFC 3339 format. If a <duration> is used, it is a
sequence of decimal numbers, each with optional fraction and a unit suffix, such
as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms",
"s", "m", "h".`,
}
// NotAfter is a cli.Flag used to pass the end period of the certificate
// validity.
NotAfter = cli.StringFlag{
Name: "not-after",
Usage: `The <time|duration> when the certificate validity period ends. If a <time> is
used it is expected to be in RFC 3339 format. If a <duration> is used, it is a
sequence of decimal numbers, each with optional fraction and a unit suffix, such
as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms",
"s", "m", "h".`,
}
// Provisioner is a cli.Flag used to pass the CA provisioner to use.
Provisioner = cli.StringFlag{
Name: "provisioner,issuer",
Usage: "The provisioner <name> to use.",
}
// ProvisionerPasswordFile is a cli.Flag used to pass the password file to
// decrypt the generating key.
ProvisionerPasswordFile = cli.StringFlag{
Name: "provisioner-password-file",
Usage: `The path to the <file> containing the password to decrypt the one-time token
generating key.`,
}
// ProvisionerPasswordFileWithAlias is a cli.Flag that allows multiple
// alias flag names for the ProvisionerPasswordFile.
ProvisionerPasswordFileWithAlias = cli.StringFlag{
Name: "provisioner-password-file,password-file",
Usage: `The path to the <file> containing the password to decrypt the one-time token
generating key.`,
}
// CaURL is a cli.Flag used to pass the CA url.
CaURL = cli.StringFlag{
Name: "ca-url",
Usage: "<URI> of the targeted Step Certificate Authority.",
}
// Root is a cli.Flag used to pass the path of the root certificate to use.
Root = cli.StringFlag{
Name: "root",
Usage: "The path to the PEM <file> used as the root certificate authority.",
}
// Offline is a cli.Flag used to activate the offline flow.
Offline = cli.BoolFlag{
Name: "offline",
Usage: `Creates a certificate without contacting the certificate authority. Offline mode
uses the configuration, certificates, and keys created with **step ca init**,
but can accept a different configuration file using **--ca-config** flag.`,
}
// CaConfig is a cli.Flag used to pass the CA configuration file.
CaConfig = cli.StringFlag{
Name: "ca-config",
Usage: `The <path> to the certificate authority configuration file. Defaults to
$STEPPATH/config/ca.json`,
Value: filepath.Join(config.StepPath(), "config", "ca.json"),
}
// X5cCert is a cli.Flag used to pass the x5c header certificate for a JWT.
X5cCert = cli.StringFlag{
Name: "x5c-cert",
Usage: "Certificate (<chain>) in PEM format to store in the 'x5c' header of a JWT.",
}
// X5cKey is a cli.Flag used to pass the private key (corresponding to the x5c-cert)
// that is used to sign the token.
X5cKey = cli.StringFlag{
Name: "x5c-key",
Usage: `Private key <path>, used to sign a JWT, corresponding to the certificate that will
be stored in the 'x5c' header.`,
}
// X5tCert is a cli.Flag used to pass the x5t header certificate thumbprint
// for a JWS or JWT.
X5tCert = cli.StringFlag{
Name: "x5t-cert",
Usage: "Certificate <path> in PEM format to use for the 'x5t' header of a JWS or JWT",
}
// X5tKey is a cli.Flag used to pass the private key (corresponding to the x5t-cert)
// that is used to sign the token.
X5tKey = cli.StringFlag{
Name: "x5t-key",
Usage: `Private key <path>, used to sign a JWT, corresponding to the certificate used for
the 'x5t' header.`,
}
// SSHPOPCert is a cli.Flag used to pass the sshpop header certificate for a JWT.
SSHPOPCert = cli.StringFlag{
Name: "sshpop-cert",
Usage: "Certificate (<chain>) in PEM format to store in the 'sshpop' header of a JWT.",
}
// SSHPOPKey is a cli.Flag used to pass the private key (corresponding to the sshpop-cert)
// that is used to sign the token.
SSHPOPKey = cli.StringFlag{
Name: "sshpop-key",
Usage: `Private key <path>, used to sign a JWT, corresponding to the certificate that will
be stored in the 'sshpop' header.`,
}
// Team is a cli.Flag used to pass the team ID.
Team = cli.StringFlag{
Name: "team",
Usage: "The team <ID> used to bootstrap the environment.",
}
// TeamURL is a cli.Flag used to pass the team URL.
TeamURL = cli.StringFlag{
Name: "team-url",
Usage: `The <url> step queries to retrieve initial team configuration. Only used with
the **--team** option. If the url contains <\<\>> placeholders, they are replaced with the team ID.`,
}
// RedirectURL is a cli.Flag used to pass the OAuth redirect URL.
RedirectURL = cli.StringFlag{
Name: "redirect-url",
Usage: "Terminal OAuth redirect <url>.",
}
// ServerName is a cli.Flag used to set the TLS Server Name Indication in
// request to a server.
ServerName = cli.StringFlag{
Name: "servername",
Usage: `TLS Server Name Indication that should be sent to request a specific certificate from the server.`,
}
// TemplateSet is a cli.Flag used to send key-value pairs to the ca.
TemplateSet = cli.StringSliceFlag{
Name: "set",
Usage: "The <key=value> pair with template data variables to send to the CA. Use the **--set** flag multiple times to add multiple variables.",
}
// TemplateSetFile is a cli.Flag used to send a JSON file to the CA.
TemplateSetFile = cli.StringFlag{
Name: "set-file",
Usage: "The <path> of a JSON file with the template data to send to the CA.",
}
// Identity is a cli.Flag used to be able to define the identity argument in
// defaults.json.
Identity = cli.StringFlag{
Name: "identity",
Usage: `The certificate identity. It is usually passed as a positional argument, but a
flag exists so it can be configured in $STEPPATH/config/defaults.json.`,
}
)
// ParseTimeOrDuration is a helper that returns the time or the current time
// with an extra duration. It's used in flags like --not-before, --not-after.
func ParseTimeOrDuration(s string) (time.Time, bool) {
if s == "" {
return time.Time{}, true
}
var t time.Time
if err := t.UnmarshalText([]byte(s)); err != nil {
d, err := time.ParseDuration(s)
if err != nil {
return time.Time{}, false
}
t = time.Now().Add(d)
}
return t, true
}
// ParseTimeDuration parses the not-before and not-after flags as a timeDuration
func ParseTimeDuration(ctx *cli.Context) (notBefore api.TimeDuration, notAfter api.TimeDuration, err error) {
var zero api.TimeDuration
notBefore, err = api.ParseTimeDuration(ctx.String("not-before"))
if err != nil {
return zero, zero, errs.InvalidFlagValue(ctx, "not-before", ctx.String("not-before"), "")
}
notAfter, err = api.ParseTimeDuration(ctx.String("not-after"))
if err != nil {
return zero, zero, errs.InvalidFlagValue(ctx, "not-after", ctx.String("not-after"), "")
}
return
}
// ParseTemplateData parses the set and and set-file flags and returns a json
// message to be used in certificate templates.
func ParseTemplateData(ctx *cli.Context) (json.RawMessage, error) {
data := make(map[string]interface{})
if path := ctx.String("set-file"); path != "" {
b, err := utils.ReadFile(path)
if err != nil {
return nil, err
}
if err := json.Unmarshal(b, &data); err != nil {
return nil, errors.Wrapf(err, "error unmarshaling %s", path)
}
}
keyValues := ctx.StringSlice("set")
for _, s := range keyValues {
i := strings.Index(s, "=")
if i == -1 {
return nil, errs.InvalidFlagValue(ctx, "set", s, "")
}
key, value := s[:i], s[i+1:]
// If the value is not json, use the raw string.
var v interface{}
if err := json.Unmarshal([]byte(value), &v); err == nil {
data[key] = v
} else {
data[key] = value
}
}
if len(data) == 0 {
return nil, nil
}
return json.Marshal(data)
}
// ParseCaURL gets and parses the ca-url from the command context.
// - Require non-empty value.
// - Prepend an 'https' scheme if the URL does not have a scheme.
// - Error if the URL scheme is not implicitly or explicitly 'https'.
func ParseCaURL(ctx *cli.Context) (string, error) {
caURL := ctx.String("ca-url")
if len(caURL) == 0 {
return "", errs.RequiredFlag(ctx, "ca-url")
}
return parseCaURL(ctx, caURL)
}
// ParseCaURLIfExists gets and parses the ca-url from the command context, if
// one is present.
// - Allow empty value.
// - Prepend an 'https' scheme if the URL does not have a scheme.
// - Error if the URL scheme is not implicitly or explicitly 'https'.
func ParseCaURLIfExists(ctx *cli.Context) (string, error) {
caURL := ctx.String("ca-url")
if len(caURL) == 0 {
return "", nil
}
return parseCaURL(ctx, caURL)
}
func parseCaURL(ctx *cli.Context, caURL string) (string, error) {
if !strings.Contains(caURL, "://") {
caURL = "https://" + caURL
}
u, err := url.Parse(caURL)
if err != nil {
return "", errs.InvalidFlagValueMsg(ctx, "ca-url", caURL, "invalid URL")
}
if u.Scheme != "https" {
return "", errs.InvalidFlagValueMsg(ctx, "ca-url", caURL, "must have https scheme")
}
return fmt.Sprintf("%s://%s", u.Scheme, u.Host), nil
}
|