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
|
package jose
import (
"bytes"
"crypto"
"crypto/ecdsa"
"crypto/ed25519"
"crypto/elliptic"
"crypto/rsa"
"crypto/x509"
"encoding/base64"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"strings"
"time"
"github.com/pkg/errors"
"github.com/smallstep/cli/crypto/pemutil"
"github.com/smallstep/cli/ui"
jose "gopkg.in/square/go-jose.v2"
)
type keyType int
const (
jwkKeyType keyType = iota
pemKeyType
octKeyType
)
// MaxDecryptTries is the maximum number of attempts to decrypt a file.
const MaxDecryptTries = 3
// Decrypt returns the decrypted version of the given data if it's encrypted,
// it will return the raw data if it's not encrypted or the format is not
// valid.
func Decrypt(prompt string, data []byte, opts ...Option) ([]byte, error) {
ctx, err := new(context).apply(opts...)
if err != nil {
return nil, err
}
enc, err := jose.ParseEncrypted(string(data))
if err != nil {
return data, nil
}
// Decrypt flow
var pass []byte
for i := 0; i < MaxDecryptTries; i++ {
if len(ctx.password) == 0 {
pass, err = ui.PromptPassword(prompt, ctx.uiOptions...)
if err != nil {
return nil, err
}
} else {
pass = ctx.password
}
if data, err = enc.Decrypt(pass); err == nil {
return data, nil
}
}
return nil, errors.New("failed to decrypt JWK: invalid password")
}
func defKeyID(jwk *JSONWebKey) error {
var (
err error
hash []byte
)
hash, err = jwk.Thumbprint(crypto.SHA256)
if err != nil {
return errors.Wrap(err, "error generating JWK thumbprint")
}
jwk.KeyID = base64.RawURLEncoding.EncodeToString(hash)
return nil
}
// ParseKey returns a JSONWebKey from the given JWK file or a PEM file. For
// password protected keys, it will ask the user for a password.
// func ParseKey(filename, use, alg, kid string, subtle bool) (*JSONWebKey, error) {
func ParseKey(filename string, opts ...Option) (*JSONWebKey, error) {
ctx, err := new(context).apply(opts...)
if err != nil {
return nil, err
}
b, err := ioutil.ReadFile(filename)
if err != nil {
return nil, errors.Wrapf(err, "error reading %s", filename)
}
jwk := new(JSONWebKey)
switch guessKeyType(ctx, b) {
case jwkKeyType:
// Attempt to parse an encrypted file
prompt := fmt.Sprintf("Please enter the password to decrypt %s", filename)
if b, err = Decrypt(prompt, b, opts...); err != nil {
return nil, err
}
// Unmarshal the plain (or decrypted JWK)
if err = json.Unmarshal(b, jwk); err != nil {
return nil, errors.Errorf("error reading %s: unsupported format", filename)
}
// If KeyID not set by environment, then use the default.
// NOTE: we do not set this value by default in the case of jwkKeyType
// because it is assumed to have been left empty on purpose.
case pemKeyType:
jwk.Key, err = pemutil.ParseKey(b, pemutil.WithFilename(filename), pemutil.WithPassword(ctx.password))
if err != nil {
return nil, err
}
if len(ctx.kid) == 0 {
if err = defKeyID(jwk); err != nil {
return nil, err
}
}
case octKeyType:
jwk.Key = b
if len(ctx.kid) == 0 {
if err = defKeyID(jwk); err != nil {
return nil, err
}
}
}
// Validate key id
if ctx.kid != "" && jwk.KeyID != "" && ctx.kid != jwk.KeyID {
return nil, errors.Errorf("kid %s does not match the kid on %s", ctx.kid, filename)
}
if jwk.KeyID == "" {
jwk.KeyID = ctx.kid
}
if jwk.Use == "" {
jwk.Use = ctx.use
}
// Set the algorithm if empty
guessJWKAlgorithm(ctx, jwk)
// Validate alg: if the flag '--subtle' is passed we will allow to overwrite it
if !ctx.subtle && ctx.alg != "" && jwk.Algorithm != "" && ctx.alg != jwk.Algorithm {
return nil, errors.Errorf("alg %s does not match the alg on %s", ctx.alg, filename)
}
if ctx.subtle && ctx.alg != "" {
jwk.Algorithm = ctx.alg
}
return jwk, nil
}
// ReadJWKSet reads a JWK Set from a URL or filename. URLs must start with "https://".
func ReadJWKSet(filename string) ([]byte, error) {
if strings.HasPrefix(filename, "https://") {
resp, err := http.Get(filename)
if err != nil {
return nil, errors.Wrapf(err, "error retrieving %s", filename)
}
defer resp.Body.Close()
b, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, errors.Wrapf(err, "error retrieving %s", filename)
}
return b, nil
}
b, err := ioutil.ReadFile(filename)
if err != nil {
return nil, errors.Wrapf(err, "error reading %s", filename)
}
return b, nil
}
// ParseKeySet returns the JWK with the given key after parsing a JWKSet from
// a given file.
// func ParseKeySet(filename, alg, kid string, isSubtle bool) (*jose.JSONWebKey, error) {
func ParseKeySet(filename string, opts ...Option) (*jose.JSONWebKey, error) {
ctx, err := new(context).apply(opts...)
if err != nil {
return nil, err
}
b, err := ReadJWKSet(filename)
if err != nil {
return nil, err
}
// Attempt to parse an encrypted file
prompt := fmt.Sprintf("Please enter the password to decrypt %s", filename)
if b, err = Decrypt(prompt, b); err != nil {
return nil, err
}
// Unmarshal the plain or decrypted JWKSet
jwkSet := new(jose.JSONWebKeySet)
if err := json.Unmarshal(b, jwkSet); err != nil {
return nil, errors.Errorf("error reading %s: unsupported format", filename)
}
jwks := jwkSet.Key(ctx.kid)
switch len(jwks) {
case 0:
return nil, errors.Errorf("cannot find key with kid %s on %s", ctx.kid, filename)
case 1:
jwk := &jwks[0]
// Set the algorithm if empty
guessJWKAlgorithm(ctx, jwk)
// Validate alg: if the flag '--subtle' is passed we will allow the
// overwrite of the alg
if !ctx.subtle && ctx.alg != "" && jwk.Algorithm != "" && ctx.alg != jwk.Algorithm {
return nil, errors.Errorf("alg %s does not match the alg on %s", ctx.alg, filename)
}
if ctx.subtle && ctx.alg != "" {
jwk.Algorithm = ctx.alg
}
return jwk, nil
default:
return nil, errors.Errorf("multiple keys with kid %s have been found on %s", ctx.kid, filename)
}
}
func decodeCerts(l []interface{}) ([]*x509.Certificate, error) {
certs := make([]*x509.Certificate, len(l))
for i, j := range l {
certStr, ok := j.(string)
if !ok {
return nil, errors.Errorf("wrong type in x5c header list; expected string but %T", i)
}
certB, err := base64.StdEncoding.DecodeString(certStr)
if err != nil {
return nil, errors.Wrap(err, "error decoding base64 encoded x5c cert")
}
cert, err := x509.ParseCertificate(certB)
if err != nil {
return nil, errors.Wrap(err, "error parsing x5c cert")
}
certs[i] = cert
}
return certs, nil
}
// X5cInsecureKey is the key used to store the x5cInsecure cert chain in the JWT header.
var X5cInsecureKey = "x5cInsecure"
// GetX5cInsecureHeader extracts the x5cInsecure certificate chain from the token.
func GetX5cInsecureHeader(jwt *JSONWebToken) ([]*x509.Certificate, error) {
x5cVal, ok := jwt.Headers[0].ExtraHeaders[jose.HeaderKey(X5cInsecureKey)]
if !ok {
return nil, errors.New("ssh check-host token missing x5cInsecure header")
}
interfaces, ok := x5cVal.([]interface{})
if !ok {
return nil, errors.Errorf("ssh check-host token x5cInsecure header has wrong type; expected []string, but got %T", x5cVal)
}
chain, err := decodeCerts(interfaces)
if err != nil {
return nil, errors.Wrap(err, "error decoding x5cInsecure header certs")
}
return chain, nil
}
// ParseX5cInsecure parses an x5cInsecure token, validates the certificate chain
// in the token, and returns the JWT struct along with all the verified chains.
func ParseX5cInsecure(tok string, roots []*x509.Certificate) (*JSONWebToken, [][]*x509.Certificate, error) {
jwt, err := ParseSigned(tok)
if err != nil {
return nil, nil, errors.Wrapf(err, "error parsing x5cInsecure token")
}
chain, err := GetX5cInsecureHeader(jwt)
if err != nil {
return nil, nil, errors.Wrap(err, "error extracting x5cInsecure cert chain")
}
leaf := chain[0]
interPool := x509.NewCertPool()
for _, crt := range chain[1:] {
interPool.AddCert(crt)
}
rootPool := x509.NewCertPool()
for _, crt := range roots {
rootPool.AddCert(crt)
}
// Correctly parse and validate the x5c certificate chain.
verifiedChains, err := leaf.Verify(x509.VerifyOptions{
Roots: rootPool,
Intermediates: interPool,
// A hack so we skip validity period validation.
CurrentTime: leaf.NotAfter.Add(-1 * time.Minute),
})
if err != nil {
return nil, nil, errors.Wrap(err, "error verifying x5cInsecure certificate chain")
}
leaf = verifiedChains[0][0]
if leaf.KeyUsage&x509.KeyUsageDigitalSignature == 0 {
return nil, nil, errors.New("certificate used to sign x5cInsecure token cannot be used for digital signature")
}
return jwt, verifiedChains, nil
}
// guessKeyType returns the key type of the given data. Key types are JWK, PEM
// or oct.
func guessKeyType(ctx *context, data []byte) keyType {
switch ctx.alg {
// jwk or file with oct data
case "HS256", "HS384", "HS512":
// Encrypted JWK ?
if _, err := jose.ParseEncrypted(string(data)); err == nil {
return jwkKeyType
}
// JSON JWK ?
if err := json.Unmarshal(data, &JSONWebKey{}); err == nil {
return jwkKeyType
}
// Default to oct
return octKeyType
default:
// PEM or default to JWK
if bytes.HasPrefix(data, []byte("-----BEGIN ")) {
return pemKeyType
}
return jwkKeyType
}
}
// guessJWKAlgorithm set the algorithm if it's not set and we can guess it
func guessJWKAlgorithm(ctx *context, jwk *jose.JSONWebKey) {
if jwk.Algorithm == "" {
// Force default algorithm if passed.
if ctx.alg != "" {
jwk.Algorithm = ctx.alg
return
}
// Guess only fixed algorithms if no defaults is enabled
if ctx.noDefaults {
guessKnownJWKAlgorithm(ctx, jwk)
return
}
// Use defaults for each key type
switch k := jwk.Key.(type) {
case []byte:
if jwk.Use == "enc" {
jwk.Algorithm = string(DefaultOctKeyAlgorithm)
} else {
jwk.Algorithm = string(DefaultOctSigsAlgorithm)
}
case *ecdsa.PrivateKey:
if jwk.Use == "enc" {
jwk.Algorithm = string(DefaultECKeyAlgorithm)
} else {
jwk.Algorithm = getECAlgorithm(k.Curve)
}
case *ecdsa.PublicKey:
if jwk.Use == "enc" {
jwk.Algorithm = string(DefaultECKeyAlgorithm)
} else {
jwk.Algorithm = getECAlgorithm(k.Curve)
}
case *rsa.PrivateKey, *rsa.PublicKey:
if jwk.Use == "enc" {
jwk.Algorithm = string(DefaultRSAKeyAlgorithm)
} else {
jwk.Algorithm = string(DefaultRSASigAlgorithm)
}
// Ed25519 can only be used for signing operations
case ed25519.PrivateKey, ed25519.PublicKey:
jwk.Algorithm = EdDSA
}
}
}
// guessKnownJWKAlgorithm sets the algorithm for keys that only have one
// possible algorithm.
func guessKnownJWKAlgorithm(ctx *context, jwk *jose.JSONWebKey) {
if jwk.Algorithm == "" && jwk.Use != "enc" {
switch k := jwk.Key.(type) {
case *ecdsa.PrivateKey:
jwk.Algorithm = getECAlgorithm(k.Curve)
case *ecdsa.PublicKey:
jwk.Algorithm = getECAlgorithm(k.Curve)
case ed25519.PrivateKey, ed25519.PublicKey:
jwk.Algorithm = EdDSA
}
}
}
// getECAlgorithm returns the JWA algorithm name for the given elliptic curve.
// If the curve is not supported it will return an empty string.
//
// Supported curves are P-256, P-384, and P-521.
func getECAlgorithm(crv elliptic.Curve) string {
switch crv.Params().Name {
case P256:
return ES256
case P384:
return ES384
case P521:
return ES512
default:
return ""
}
}
|