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 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
|
package key
import (
"bytes"
"crypto/ecdsa"
"crypto/ed25519"
"crypto/rsa"
"crypto/x509"
"encoding/json"
"encoding/pem"
"os"
"github.com/pkg/errors"
"github.com/smallstep/cli/command"
"github.com/smallstep/cli/crypto/pemutil"
"github.com/smallstep/cli/errs"
"github.com/smallstep/cli/flags"
"github.com/smallstep/cli/jose"
"github.com/smallstep/cli/ui"
"github.com/smallstep/cli/utils"
"github.com/urfave/cli"
"golang.org/x/crypto/ssh"
)
func formatCommand() cli.Command {
return cli.Command{
Name: "format",
Action: command.ActionFunc(formatAction),
Usage: `reformat a public or private key`,
UsageText: `**step crypto key format** <key-file> [**--out**=<path>]`,
Description: `**step crypto key format** prints or writes the key in
a different format.
By default PEM formated keys will be converted to DER with the following rules:
* ECDSA, RSA, AND Ed25519 public keys will use the DER-encoded PKIX format.
* ECDSA, AND RSA private keys will use the ASN.1, DER format.
* Ed25519 private keys will use the DER-encoded PKCS8 encoded form.
And DER encoded keys will be converted to PEM with the following rules:
* ECDSA, RSA, AND Ed25519 public keys will use the PEM-encoded PKIX format.
* ECDSA private keys will use the PEM-encoded format defined in RFC 5915 and
SEC1.
* RSA private keys will use the PEM-encoded PKCS#1 format.
* Ed25519 private keys will use the PEM-encoded PKCS#8 format.
The flags **--pkcs8**, **--pem**, **--der**, **--ssh**, and **--jwk** can be use
to change the previous defaults. For example we can use **--pkcs8** to save a
PKCS#1 RSA key to the PKCS#8 form. Or we can combine **--pem** and **--pkcs8**
to convert to PKCS#8 a PEM file.
## POSITIONAL ARGUMENTS
<key-file>
: Path to a file with a public or private key, or the public key of an
X.509 certificate.
## EXIT CODES
This command returns 0 on success and \>0 if any error occurs.
## EXAMPLES
Convert a PEM file to DER:
'''
$ step crypto key format key.pem
'''
Convert DER file to PEM:
'''
$ step crypto key format key.der
'''
Convert a PEM file to OpenSSH:
'''
$ step crypto key format --ssh key.pem
'''
Convert a PEM file to JWK:
'''
$ step crypto key format --jwk key.pem
'''
Convert PEM file to DER and write to disk:
'''
$ step crypto key format key.pem --out key.der
'''
Convert a PKCS#1 RSA private key to PKCS#8 using the PEM format:
'''
$ step crypto key format --pem --pkcs8 rsa.pem --out rsa-pkcs8.pem
'''
Convert PKCS#8 RSA private key to the PKCS#1 format:
'''
$ step crypto key format --pem rsa-pkcs8.pem --out rsa.pem
'''
Convert an ASN.1 DER format to the PEM-encoded PKCS#8 format:
'''
$ step crypto key format --pkcs8 key.der --out key-pkcs8.der
'''
Convert an ASN.1 DER format to the DER-encoded PKCS#8 format:
'''
$ step crypto key format --der --pkcs8 key.der --out key-pkcs8.der
'''`,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "pkcs8",
Usage: "Convert RSA and ECDSA private keys to PKCS#8 PEM/DER format.",
},
cli.BoolFlag{
Name: "pem",
Usage: `Uses PEM as the result encoding format. If neither **--pem** nor **--der** nor
**--ssh** nor **--jwk** are set it will always switch to the DER format.`,
},
cli.BoolFlag{
Name: "der",
Usage: `Uses DER as the result enconfig format. If neither **--pem** nor **--der** nor
**--ssh** nor **--jwk** are set it will always switch to the PEM format.`,
},
cli.BoolFlag{
Name: "ssh",
Usage: `Uses OpenSSH as the result encoding format.`,
},
cli.BoolFlag{
Name: "jwk",
Usage: `Uses JSON Web Key as the result encoding format.`,
},
cli.StringFlag{
Name: "out",
Usage: "Path to write the reformatted result.",
},
cli.StringFlag{
Name: "password-file",
Usage: "Location of file containing passphrase to decrypt private key.",
},
cli.BoolFlag{
Name: "no-password",
Usage: `Do not ask for a password to encrypt a private key with PEM format. Sensitive
key material will be written to disk unencrypted. This is not recommended.
Requires **--insecure** flag.`,
},
flags.Insecure,
flags.Force,
},
}
}
func formatAction(ctx *cli.Context) error {
if err := errs.MinMaxNumberOfArguments(ctx, 0, 1); err != nil {
return err
}
var keyFile string
switch ctx.NArg() {
case 0:
keyFile = "-"
case 1:
keyFile = ctx.Args().First()
default:
return errs.TooManyArguments(ctx)
}
var (
out = ctx.String("out")
toPEM = ctx.Bool("pem")
toDER = ctx.Bool("der")
toSSH = ctx.Bool("ssh")
toJWK = ctx.Bool("jwk")
noPassword = ctx.Bool("no-password")
insecure = ctx.Bool("insecure")
key interface{}
ob []byte
)
switch {
case toPEM && toDER:
return errs.IncompatibleFlagWithFlag(ctx, "pem", "der")
case toPEM && toSSH:
return errs.IncompatibleFlagWithFlag(ctx, "pem", "ssh")
case toPEM && toJWK:
return errs.IncompatibleFlagWithFlag(ctx, "pem", "jwk")
case toDER && toSSH:
return errs.IncompatibleFlagWithFlag(ctx, "der", "ssh")
case toDER && toJWK:
return errs.IncompatibleFlagWithFlag(ctx, "der", "jwk")
case toSSH && toJWK:
return errs.IncompatibleFlagWithFlag(ctx, "ssh", "jwk")
}
// --no-password requires --insecure
if noPassword && !insecure {
return errs.RequiredInsecureFlag(ctx, "no-password")
}
b, err := utils.ReadFile(keyFile)
if err != nil {
return errs.FileError(err, keyFile)
}
switch {
case bytes.HasPrefix(b, []byte("-----BEGIN ")): // PEM format:
opts := []pemutil.Options{pemutil.WithFilename(keyFile)}
if passFile := ctx.String("password-file"); passFile != "" {
opts = append(opts, pemutil.WithPasswordFile(passFile))
}
if key, err = pemutil.Parse(b, opts...); err != nil {
return err
}
// convert to DER if not specified
if !toPEM && !toDER && !toSSH && !toJWK {
toDER = true
}
case isSSHPublicKey(b):
if key, err = pemutil.ParseSSH(b); err != nil {
return err
}
// convert to PEM if not specified
if !toPEM && !toDER && !toSSH && !toJWK {
toPEM = true
}
case isJWK(b):
if key, err = parseJWK(ctx, b); err != nil {
return err
}
// convert to PEM if not specified
if !toPEM && !toDER && !toSSH && !toJWK {
toPEM = true
}
default: // assuming DER format
if key, err = pemutil.ParseDER(b); err != nil {
return err
}
// convert to PEM if not specified
if !toPEM && !toDER && !toSSH && !toJWK {
toPEM = true
}
}
// If it's a certificate grab it's public key
if cert, ok := key.(*x509.Certificate); ok {
key = cert.PublicKey
}
switch {
case toPEM:
if ob, err = convertToPEM(ctx, key); err != nil {
return err
}
case toDER:
if ob, err = convertToDER(ctx, key); err != nil {
return err
}
case toSSH:
if ob, err = convertToSSH(ctx, key); err != nil {
return err
}
case toJWK:
if ob, err = convertToJWK(ctx, key); err != nil {
return err
}
default:
return errors.New("error formatting key: it should not get here")
}
if out == "" {
os.Stdout.Write(ob)
} else {
info, err := os.Stat(keyFile)
if err != nil {
return errs.FileError(err, keyFile)
}
if err := utils.WriteFile(out, ob, info.Mode()); err != nil {
return errs.FileError(err, out)
}
ui.Printf("Your key has been saved in %s.\n", out)
}
return nil
}
func isSSHPublicKey(in []byte) bool {
switch {
case bytes.HasPrefix(in, []byte(ssh.KeyAlgoRSA)),
bytes.HasPrefix(in, []byte(ssh.KeyAlgoDSA)),
bytes.HasPrefix(in, []byte(ssh.KeyAlgoECDSA256)),
bytes.HasPrefix(in, []byte(ssh.KeyAlgoECDSA384)),
bytes.HasPrefix(in, []byte(ssh.KeyAlgoECDSA521)),
bytes.HasPrefix(in, []byte(ssh.KeyAlgoED25519)):
return true
default:
return false
}
}
func isJWK(in []byte) bool {
if bytes.HasPrefix(in, []byte("{")) {
return true
}
if _, err := jose.ParseEncrypted(string(in)); err == nil {
return true
}
return false
}
func parseJWK(ctx *cli.Context, b []byte) (interface{}, error) {
// Decrypt key if encrypted.
if _, err := jose.ParseEncrypted(string(b)); err == nil {
var opts []jose.Option
if passFile := ctx.String("password-file"); passFile != "" {
opts = append(opts, jose.WithPasswordFile(passFile))
}
b, err = jose.Decrypt("Please enter the password to decrypt the key", b, opts...)
if err != nil {
return nil, err
}
}
// Parse decrypted key
var jwk jose.JSONWebKey
if err := json.Unmarshal(b, &jwk); err != nil {
return nil, errors.Wrap(err, "error unmarshalling key")
}
if jwk.Key == nil {
return nil, errors.New("error parsing key: not found")
}
return jwk.Key, nil
}
func convertToPEM(ctx *cli.Context, key interface{}) (b []byte, err error) {
opts := []pemutil.Options{
pemutil.WithPKCS8(ctx.Bool("pkcs8")),
}
if !ctx.Bool("no-password") {
switch key.(type) {
case *ecdsa.PublicKey, *rsa.PublicKey, ed25519.PublicKey:
case *rsa.PrivateKey, *ecdsa.PrivateKey, ed25519.PrivateKey:
if passFile := ctx.String("password-file"); passFile != "" {
opts = append(opts, pemutil.WithPasswordFile(passFile))
} else {
opts = append(opts, pemutil.WithPasswordPrompt("Please enter the password to encrypt the private key"))
}
default:
return nil, errors.Errorf("unsupported key type %T", key)
}
}
block, err := pemutil.Serialize(key, opts...)
if err != nil {
return nil, err
}
return pem.EncodeToMemory(block), nil
}
func convertToDER(ctx *cli.Context, key interface{}) (b []byte, err error) {
switch k := key.(type) {
case *rsa.PrivateKey:
if ctx.Bool("pkcs8") {
b, err = pemutil.MarshalPKCS8PrivateKey(key)
} else {
b = x509.MarshalPKCS1PrivateKey(k)
}
case *ecdsa.PrivateKey:
if ctx.Bool("pkcs8") {
b, err = pemutil.MarshalPKCS8PrivateKey(key)
} else {
b, err = x509.MarshalECPrivateKey(k)
}
case ed25519.PrivateKey: // always PKCS#8
b, err = pemutil.MarshalPKCS8PrivateKey(key)
case *ecdsa.PublicKey, *rsa.PublicKey, ed25519.PublicKey: // always PKIX
b, err = pemutil.MarshalPKIXPublicKey(key)
default:
return nil, errors.Errorf("unsupported key type %T", key)
}
return
}
func convertToSSH(ctx *cli.Context, key interface{}) ([]byte, error) {
switch key.(type) {
case *ecdsa.PublicKey, *rsa.PublicKey, ed25519.PublicKey:
k, err := ssh.NewPublicKey(key)
if err != nil {
return nil, errors.Wrap(err, "error converting public key")
}
return ssh.MarshalAuthorizedKey(k), nil
case *rsa.PrivateKey, *ecdsa.PrivateKey, ed25519.PrivateKey:
opts := []pemutil.Options{
pemutil.WithOpenSSH(true),
}
if !ctx.Bool("no-password") {
if passFile := ctx.String("password-file"); passFile != "" {
opts = append(opts, pemutil.WithPasswordFile(passFile))
} else {
opts = append(opts, pemutil.WithPasswordPrompt("Please enter the password to encrypt the private key"))
}
}
block, err := pemutil.Serialize(key, opts...)
if err != nil {
return nil, err
}
return pem.EncodeToMemory(block), nil
default:
return nil, errors.Errorf("unsupported key type %T", key)
}
}
func convertToJWK(ctx *cli.Context, key interface{}) ([]byte, error) {
jwk := &jose.JSONWebKey{Key: key}
switch key.(type) {
case *ecdsa.PublicKey, *rsa.PublicKey, ed25519.PublicKey:
return json.Marshal(jwk)
case *rsa.PrivateKey, *ecdsa.PrivateKey, ed25519.PrivateKey:
if !ctx.Bool("no-password") {
var opts []jose.Option
if passFile := ctx.String("password-file"); passFile != "" {
opts = append(opts, jose.WithPasswordFile(passFile))
}
jwe, err := jose.EncryptJWK(jwk, opts...)
if err != nil {
return nil, err
}
return []byte(jwe.FullSerialize()), nil
}
return json.Marshal(jwk)
default:
return nil, errors.Errorf("unsupported key type %T", key)
}
}
|