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 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
|
//go:generate ../tools/cmd/genjwe.sh
// Package jwe implements JWE as described in https://tools.ietf.org/html/rfc7516
package jwe
import (
"bytes"
"context"
"crypto/ecdsa"
"crypto/rsa"
"fmt"
"io"
"sync"
"github.com/lestrrat-go/blackmagic"
"github.com/lestrrat-go/jwx/v2/internal/base64"
"github.com/lestrrat-go/jwx/v2/internal/json"
"github.com/lestrrat-go/jwx/v2/internal/keyconv"
"github.com/lestrrat-go/jwx/v2/jwk"
"github.com/lestrrat-go/jwx/v2/jwa"
"github.com/lestrrat-go/jwx/v2/jwe/internal/aescbc"
"github.com/lestrrat-go/jwx/v2/jwe/internal/content_crypt"
"github.com/lestrrat-go/jwx/v2/jwe/internal/keyenc"
"github.com/lestrrat-go/jwx/v2/jwe/internal/keygen"
"github.com/lestrrat-go/jwx/v2/x25519"
)
var muSettings sync.RWMutex
var maxPBES2Count = 10000
var maxDecompressBufferSize int64 = 10 * 1024 * 1024 // 10MB
func Settings(options ...GlobalOption) {
muSettings.Lock()
defer muSettings.Unlock()
//nolint:forcetypeassert
for _, option := range options {
switch option.Ident() {
case identMaxPBES2Count{}:
maxPBES2Count = option.Value().(int)
case identMaxDecompressBufferSize{}:
maxDecompressBufferSize = option.Value().(int64)
case identMaxBufferSize{}:
aescbc.SetMaxBufferSize(option.Value().(int64))
}
}
}
const (
fmtInvalid = iota
fmtCompact
fmtJSON
fmtJSONPretty
fmtMax
)
var _ = fmtInvalid
var _ = fmtMax
var registry = json.NewRegistry()
type keyEncrypterWrapper struct {
encrypter KeyEncrypter
}
func (w *keyEncrypterWrapper) Algorithm() jwa.KeyEncryptionAlgorithm {
return w.encrypter.Algorithm()
}
func (w *keyEncrypterWrapper) EncryptKey(cek []byte) (keygen.ByteSource, error) {
encrypted, err := w.encrypter.EncryptKey(cek)
if err != nil {
return nil, err
}
return keygen.ByteKey(encrypted), nil
}
type recipientBuilder struct {
alg jwa.KeyEncryptionAlgorithm
key interface{}
headers Headers
}
func (b *recipientBuilder) Build(cek []byte, calg jwa.ContentEncryptionAlgorithm, cc *content_crypt.Generic) (Recipient, []byte, error) {
var enc keyenc.Encrypter
// we need the raw key for later use
rawKey := b.key
var keyID string
if ke, ok := b.key.(KeyEncrypter); ok {
enc = &keyEncrypterWrapper{encrypter: ke}
if kider, ok := enc.(KeyIDer); ok {
keyID = kider.KeyID()
}
} else if jwkKey, ok := b.key.(jwk.Key); ok {
// Meanwhile, grab the kid as well
keyID = jwkKey.KeyID()
var raw interface{}
if err := jwkKey.Raw(&raw); err != nil {
return nil, nil, fmt.Errorf(`failed to retrieve raw key out of %T: %w`, b.key, err)
}
rawKey = raw
}
if enc == nil {
switch b.alg {
case jwa.RSA1_5:
var pubkey rsa.PublicKey
if err := keyconv.RSAPublicKey(&pubkey, rawKey); err != nil {
return nil, nil, fmt.Errorf(`failed to generate public key from key (%T): %w`, rawKey, err)
}
v, err := keyenc.NewRSAPKCSEncrypt(b.alg, &pubkey)
if err != nil {
return nil, nil, fmt.Errorf(`failed to create RSA PKCS encrypter: %w`, err)
}
enc = v
case jwa.RSA_OAEP, jwa.RSA_OAEP_256, jwa.RSA_OAEP_384, jwa.RSA_OAEP_512:
var pubkey rsa.PublicKey
if err := keyconv.RSAPublicKey(&pubkey, rawKey); err != nil {
return nil, nil, fmt.Errorf(`failed to generate public key from key (%T): %w`, rawKey, err)
}
v, err := keyenc.NewRSAOAEPEncrypt(b.alg, &pubkey)
if err != nil {
return nil, nil, fmt.Errorf(`failed to create RSA OAEP encrypter: %w`, err)
}
enc = v
case jwa.A128KW, jwa.A192KW, jwa.A256KW,
jwa.A128GCMKW, jwa.A192GCMKW, jwa.A256GCMKW,
jwa.PBES2_HS256_A128KW, jwa.PBES2_HS384_A192KW, jwa.PBES2_HS512_A256KW:
sharedkey, ok := rawKey.([]byte)
if !ok {
return nil, nil, fmt.Errorf(`invalid key: []byte required (%T)`, rawKey)
}
var err error
switch b.alg {
case jwa.A128KW, jwa.A192KW, jwa.A256KW:
enc, err = keyenc.NewAES(b.alg, sharedkey)
case jwa.PBES2_HS256_A128KW, jwa.PBES2_HS384_A192KW, jwa.PBES2_HS512_A256KW:
enc, err = keyenc.NewPBES2Encrypt(b.alg, sharedkey)
default:
enc, err = keyenc.NewAESGCMEncrypt(b.alg, sharedkey)
}
if err != nil {
return nil, nil, fmt.Errorf(`failed to create key wrap encrypter: %w`, err)
}
// NOTE: there was formerly a restriction, introduced
// in PR #26, which disallowed certain key/content
// algorithm combinations. This seemed bogus, and
// interop with the jose tool demonstrates it.
case jwa.ECDH_ES, jwa.ECDH_ES_A128KW, jwa.ECDH_ES_A192KW, jwa.ECDH_ES_A256KW:
var keysize int
switch b.alg {
case jwa.ECDH_ES:
// https://tools.ietf.org/html/rfc7518#page-15
// In Direct Key Agreement mode, the output of the Concat KDF MUST be a
// key of the same length as that used by the "enc" algorithm.
keysize = cc.KeySize()
case jwa.ECDH_ES_A128KW:
keysize = 16
case jwa.ECDH_ES_A192KW:
keysize = 24
case jwa.ECDH_ES_A256KW:
keysize = 32
}
switch key := rawKey.(type) {
case x25519.PublicKey:
var apu, apv []byte
if hdrs := b.headers; hdrs != nil {
apu = hdrs.AgreementPartyUInfo()
apv = hdrs.AgreementPartyVInfo()
}
v, err := keyenc.NewECDHESEncrypt(b.alg, calg, keysize, rawKey, apu, apv)
if err != nil {
return nil, nil, fmt.Errorf(`failed to create ECDHS key wrap encrypter: %w`, err)
}
enc = v
default:
var pubkey ecdsa.PublicKey
if err := keyconv.ECDSAPublicKey(&pubkey, rawKey); err != nil {
return nil, nil, fmt.Errorf(`failed to generate public key from key (%T): %w`, key, err)
}
var apu, apv []byte
if hdrs := b.headers; hdrs != nil {
apu = hdrs.AgreementPartyUInfo()
apv = hdrs.AgreementPartyVInfo()
}
v, err := keyenc.NewECDHESEncrypt(b.alg, calg, keysize, &pubkey, apu, apv)
if err != nil {
return nil, nil, fmt.Errorf(`failed to create ECDHS key wrap encrypter: %w`, err)
}
enc = v
}
case jwa.DIRECT:
sharedkey, ok := rawKey.([]byte)
if !ok {
return nil, nil, fmt.Errorf("invalid key: []byte required")
}
enc, _ = keyenc.NewNoop(b.alg, sharedkey)
default:
return nil, nil, fmt.Errorf(`invalid key encryption algorithm (%s)`, b.alg)
}
}
r := NewRecipient()
if hdrs := b.headers; hdrs != nil {
_ = r.SetHeaders(hdrs)
}
if err := r.Headers().Set(AlgorithmKey, b.alg); err != nil {
return nil, nil, fmt.Errorf(`failed to set header: %w`, err)
}
if keyID != "" {
if err := r.Headers().Set(KeyIDKey, keyID); err != nil {
return nil, nil, fmt.Errorf(`failed to set header: %w`, err)
}
}
var rawCEK []byte
enckey, err := enc.EncryptKey(cek)
if err != nil {
return nil, nil, fmt.Errorf(`failed to encrypt key: %w`, err)
}
if enc.Algorithm() == jwa.ECDH_ES || enc.Algorithm() == jwa.DIRECT {
rawCEK = enckey.Bytes()
} else {
if err := r.SetEncryptedKey(enckey.Bytes()); err != nil {
return nil, nil, fmt.Errorf(`failed to set encrypted key: %w`, err)
}
}
if hp, ok := enckey.(populater); ok {
if err := hp.Populate(r.Headers()); err != nil {
return nil, nil, fmt.Errorf(`failed to populate: %w`, err)
}
}
return r, rawCEK, nil
}
// Encrypt generates a JWE message for the given payload and returns
// it in serialized form, which can be in either compact or
// JSON format. Default is compact.
//
// You must pass at least one key to `jwe.Encrypt()` by using `jwe.WithKey()`
// option.
//
// jwe.Encrypt(payload, jwe.WithKey(alg, key))
// jwe.Encrypt(payload, jws.WithJSON(), jws.WithKey(alg1, key1), jws.WithKey(alg2, key2))
//
// Note that in the second example the `jws.WithJSON()` option is
// specified as well. This is because the compact serialization
// format does not support multiple recipients, and users must
// specifically ask for the JSON serialization format.
//
// Read the documentation for `jwe.WithKey()` to learn more about the
// possible values that can be used for `alg` and `key`.
//
// Look for options that return `jwe.EncryptOption` or `jws.EncryptDecryptOption`
// for a complete list of options that can be passed to this function.
func Encrypt(payload []byte, options ...EncryptOption) ([]byte, error) {
return encrypt(payload, nil, options...)
}
// EncryptStatic is exactly like Encrypt, except it accepts a static
// content encryption key (CEK). It is separated out from the main
// Encrypt function such that the latter does not accidentally use a static
// CEK.
//
// DO NOT attempt to use this function unless you completely understand the
// security implications to using static CEKs. You have been warned.
//
// This function is currently considered EXPERIMENTAL, and is subject to
// future changes across minor/micro versions.
func EncryptStatic(payload, cek []byte, options ...EncryptOption) ([]byte, error) {
if len(cek) <= 0 {
return nil, fmt.Errorf(`jwe.EncryptStatic: empty CEK`)
}
return encrypt(payload, cek, options...)
}
// encrypt is separate, so it can receive cek from outside.
// (but we don't want to receive it in the options slice)
func encrypt(payload, cek []byte, options ...EncryptOption) ([]byte, error) {
// default content encryption algorithm
calg := jwa.A256GCM
// default compression is "none"
compression := jwa.NoCompress
// default format is compact serialization
format := fmtCompact
// builds each "recipient" with encrypted_key and headers
var builders []*recipientBuilder
var protected Headers
var mergeProtected bool
var useRawCEK bool
for _, option := range options {
//nolint:forcetypeassert
switch option.Ident() {
case identKey{}:
data := option.Value().(*withKey)
v, ok := data.alg.(jwa.KeyEncryptionAlgorithm)
if !ok {
return nil, fmt.Errorf(`jwe.Encrypt: expected alg to be jwa.KeyEncryptionAlgorithm, but got %T`, data.alg)
}
switch v {
case jwa.DIRECT, jwa.ECDH_ES:
useRawCEK = true
}
builders = append(builders, &recipientBuilder{
alg: v,
key: data.key,
headers: data.headers,
})
case identContentEncryptionAlgorithm{}:
calg = option.Value().(jwa.ContentEncryptionAlgorithm)
case identCompress{}:
compression = option.Value().(jwa.CompressionAlgorithm)
case identMergeProtectedHeaders{}:
mergeProtected = option.Value().(bool)
case identProtectedHeaders{}:
v := option.Value().(Headers)
if !mergeProtected || protected == nil {
protected = v
} else {
ctx := context.TODO()
merged, err := protected.Merge(ctx, v)
if err != nil {
return nil, fmt.Errorf(`jwe.Encrypt: failed to merge headers: %w`, err)
}
protected = merged
}
case identSerialization{}:
format = option.Value().(int)
}
}
// We need to have at least one builder
switch l := len(builders); {
case l == 0:
return nil, fmt.Errorf(`jwe.Encrypt: missing key encryption builders: use jwe.WithKey() to specify one`)
case l > 1:
if format == fmtCompact {
return nil, fmt.Errorf(`jwe.Encrypt: cannot use compact serialization when multiple recipients exist (check the number of WithKey() argument, or use WithJSON())`)
}
}
if useRawCEK {
if len(builders) != 1 {
return nil, fmt.Errorf(`jwe.Encrypt: multiple recipients for ECDH-ES/DIRECT mode supported`)
}
}
// There is exactly one content encrypter.
contentcrypt, err := content_crypt.NewGeneric(calg)
if err != nil {
return nil, fmt.Errorf(`jwe.Encrypt: failed to create AES encrypter: %w`, err)
}
if len(cek) <= 0 {
generator := keygen.NewRandom(contentcrypt.KeySize())
bk, err := generator.Generate()
if err != nil {
return nil, fmt.Errorf(`jwe.Encrypt: failed to generate key: %w`, err)
}
cek = bk.Bytes()
}
recipients := make([]Recipient, len(builders))
for i, builder := range builders {
// some builders require hint from the contentcrypt object
r, rawCEK, err := builder.Build(cek, calg, contentcrypt)
if err != nil {
return nil, fmt.Errorf(`jwe.Encrypt: failed to create recipient #%d: %w`, i, err)
}
recipients[i] = r
// Kinda feels weird, but if useRawCEK == true, we asserted earlier
// that len(builders) == 1, so this is OK
if useRawCEK {
cek = rawCEK
}
}
if protected == nil {
protected = NewHeaders()
}
if err := protected.Set(ContentEncryptionKey, calg); err != nil {
return nil, fmt.Errorf(`jwe.Encrypt: failed to set "enc" in protected header: %w`, err)
}
if compression != jwa.NoCompress {
payload, err = compress(payload)
if err != nil {
return nil, fmt.Errorf(`jwe.Encrypt: failed to compress payload before encryption: %w`, err)
}
if err := protected.Set(CompressionKey, compression); err != nil {
return nil, fmt.Errorf(`jwe.Encrypt: failed to set "zip" in protected header: %w`, err)
}
}
// If there's only one recipient, you want to include that in the
// protected header
if len(recipients) == 1 {
h, err := protected.Merge(context.TODO(), recipients[0].Headers())
if err != nil {
return nil, fmt.Errorf(`jwe.Encrypt: failed to merge protected headers: %w`, err)
}
protected = h
}
aad, err := protected.Encode()
if err != nil {
return nil, fmt.Errorf(`failed to base64 encode protected headers: %w`, err)
}
iv, ciphertext, tag, err := contentcrypt.Encrypt(cek, payload, aad)
if err != nil {
return nil, fmt.Errorf(`failed to encrypt payload: %w`, err)
}
msg := NewMessage()
if err := msg.Set(CipherTextKey, ciphertext); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, CipherTextKey, err)
}
if err := msg.Set(InitializationVectorKey, iv); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, InitializationVectorKey, err)
}
if err := msg.Set(ProtectedHeadersKey, protected); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, ProtectedHeadersKey, err)
}
if err := msg.Set(RecipientsKey, recipients); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, RecipientsKey, err)
}
if err := msg.Set(TagKey, tag); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, TagKey, err)
}
switch format {
case fmtCompact:
return Compact(msg)
case fmtJSON:
return json.Marshal(msg)
case fmtJSONPretty:
return json.MarshalIndent(msg, "", " ")
default:
return nil, fmt.Errorf(`jwe.Encrypt: invalid serialization`)
}
}
type decryptCtx struct {
msg *Message
aad []byte
cek *[]byte
computedAad []byte
keyProviders []KeyProvider
protectedHeaders Headers
maxDecompressBufferSize int64
}
// Decrypt takes encrypted payload, and information required to decrypt the
// payload (e.g. the key encryption algorithm and the corresponding
// key to decrypt the JWE message) in its optional arguments. See
// the examples and list of options that return a DecryptOption for possible
// values. Upon successful decryptiond returns the decrypted payload.
//
// The JWE message can be either compact or full JSON format.
//
// When using `jwe.WithKeyEncryptionAlgorithm()`, you can pass a `jwa.KeyAlgorithm`
// for convenience: this is mainly to allow you to directly pass the result of `(jwk.Key).Algorithm()`.
// However, do note that while `(jwk.Key).Algorithm()` could very well contain key encryption
// algorithms, it could also contain other types of values, such as _signature algorithms_.
// In order for `jwe.Decrypt` to work properly, the `alg` parameter must be of type
// `jwa.KeyEncryptionAlgorithm` or otherwise it will cause an error.
//
// When using `jwe.WithKey()`, the value must be a private key.
// It can be either in its raw format (e.g. *rsa.PrivateKey) or a jwk.Key
//
// When the encrypted message is also compressed, the decompressed payload must be
// smaller than the size specified by the `jwe.WithMaxDecompressBufferSize` setting,
// which defaults to 10MB. If the decompressed payload is larger than this size,
// an error is returned.
//
// You can opt to change the MaxDecompressBufferSize setting globally, or on a
// per-call basis by passing the `jwe.WithMaxDecompressBufferSize` option to
// either `jwe.Settings()` or `jwe.Decrypt()`:
//
// jwe.Settings(jwe.WithMaxDecompressBufferSize(10*1024*1024)) // changes value globally
// jwe.Decrypt(..., jwe.WithMaxDecompressBufferSize(250*1024)) // changes just for this call
func Decrypt(buf []byte, options ...DecryptOption) ([]byte, error) {
var keyProviders []KeyProvider
var keyUsed interface{}
var cek *[]byte
var dst *Message
perCallMaxDecompressBufferSize := maxDecompressBufferSize
//nolint:forcetypeassert
for _, option := range options {
switch option.Ident() {
case identMessage{}:
dst = option.Value().(*Message)
case identKeyProvider{}:
keyProviders = append(keyProviders, option.Value().(KeyProvider))
case identKeyUsed{}:
keyUsed = option.Value()
case identKey{}:
pair := option.Value().(*withKey)
alg, ok := pair.alg.(jwa.KeyEncryptionAlgorithm)
if !ok {
return nil, fmt.Errorf(`WithKey() option must be specified using jwa.KeyEncryptionAlgorithm (got %T)`, pair.alg)
}
keyProviders = append(keyProviders, &staticKeyProvider{
alg: alg,
key: pair.key,
})
case identCEK{}:
cek = option.Value().(*[]byte)
case identMaxDecompressBufferSize{}:
perCallMaxDecompressBufferSize = option.Value().(int64)
}
}
if len(keyProviders) < 1 {
return nil, fmt.Errorf(`jwe.Decrypt: no key providers have been provided (see jwe.WithKey(), jwe.WithKeySet(), and jwe.WithKeyProvider()`)
}
msg, err := parseJSONOrCompact(buf, true)
if err != nil {
return nil, fmt.Errorf(`failed to parse buffer for Decrypt: %w`, err)
}
// Process things that are common to the message
ctx := context.TODO()
h, err := msg.protectedHeaders.Clone(ctx)
if err != nil {
return nil, fmt.Errorf(`failed to copy protected headers: %w`, err)
}
h, err = h.Merge(ctx, msg.unprotectedHeaders)
if err != nil {
return nil, fmt.Errorf(`failed to merge headers for message decryption: %w`, err)
}
var aad []byte
if aadContainer := msg.authenticatedData; aadContainer != nil {
aad = base64.Encode(aadContainer)
}
var computedAad []byte
if len(msg.rawProtectedHeaders) > 0 {
computedAad = msg.rawProtectedHeaders
} else {
// this is probably not required once msg.Decrypt is deprecated
var err error
computedAad, err = msg.protectedHeaders.Encode()
if err != nil {
return nil, fmt.Errorf(`failed to encode protected headers: %w`, err)
}
}
// for each recipient, attempt to match the key providers
// if we have no recipients, pretend like we only have one
recipients := msg.recipients
if len(recipients) == 0 {
r := NewRecipient()
if err := r.SetHeaders(msg.protectedHeaders); err != nil {
return nil, fmt.Errorf(`failed to set headers to recipient: %w`, err)
}
recipients = append(recipients, r)
}
var dctx decryptCtx
dctx.aad = aad
dctx.computedAad = computedAad
dctx.msg = msg
dctx.keyProviders = keyProviders
dctx.protectedHeaders = h
dctx.cek = cek
dctx.maxDecompressBufferSize = perCallMaxDecompressBufferSize
var lastError error
for _, recipient := range recipients {
decrypted, err := dctx.try(ctx, recipient, keyUsed)
if err != nil {
lastError = err
continue
}
if dst != nil {
*dst = *msg
dst.rawProtectedHeaders = nil
dst.storeProtectedHeaders = false
}
return decrypted, nil
}
return nil, fmt.Errorf(`jwe.Decrypt: failed to decrypt any of the recipients (last error = %w)`, lastError)
}
func (dctx *decryptCtx) try(ctx context.Context, recipient Recipient, keyUsed interface{}) ([]byte, error) {
var tried int
var lastError error
for i, kp := range dctx.keyProviders {
var sink algKeySink
if err := kp.FetchKeys(ctx, &sink, recipient, dctx.msg); err != nil {
return nil, fmt.Errorf(`key provider %d failed: %w`, i, err)
}
for _, pair := range sink.list {
tried++
// alg is converted here because pair.alg is of type jwa.KeyAlgorithm.
// this may seem ugly, but we're trying to avoid declaring separate
// structs for `alg jwa.KeyEncryptionAlgorithm` and `alg jwa.SignatureAlgorithm`
//nolint:forcetypeassert
alg := pair.alg.(jwa.KeyEncryptionAlgorithm)
key := pair.key
decrypted, err := dctx.decryptContent(ctx, alg, key, recipient)
if err != nil {
lastError = err
continue
}
if keyUsed != nil {
if err := blackmagic.AssignIfCompatible(keyUsed, key); err != nil {
return nil, fmt.Errorf(`failed to assign used key (%T) to %T: %w`, key, keyUsed, err)
}
}
return decrypted, nil
}
}
return nil, fmt.Errorf(`jwe.Decrypt: tried %d keys, but failed to match any of the keys with recipient (last error = %s)`, tried, lastError)
}
func (dctx *decryptCtx) decryptContent(ctx context.Context, alg jwa.KeyEncryptionAlgorithm, key interface{}, recipient Recipient) ([]byte, error) {
if jwkKey, ok := key.(jwk.Key); ok {
var raw interface{}
if err := jwkKey.Raw(&raw); err != nil {
return nil, fmt.Errorf(`failed to retrieve raw key from %T: %w`, key, err)
}
key = raw
}
dec := newDecrypter(alg, dctx.msg.protectedHeaders.ContentEncryption(), key).
AuthenticatedData(dctx.aad).
ComputedAuthenticatedData(dctx.computedAad).
InitializationVector(dctx.msg.initializationVector).
Tag(dctx.msg.tag).
CEK(dctx.cek)
if recipient.Headers().Algorithm() != alg {
// algorithms don't match
return nil, fmt.Errorf(`jwe.Decrypt: key and recipient algorithms do not match`)
}
h2, err := dctx.protectedHeaders.Clone(ctx)
if err != nil {
return nil, fmt.Errorf(`jwe.Decrypt: failed to copy headers (1): %w`, err)
}
h2, err = h2.Merge(ctx, recipient.Headers())
if err != nil {
return nil, fmt.Errorf(`failed to copy headers (2): %w`, err)
}
switch alg {
case jwa.ECDH_ES, jwa.ECDH_ES_A128KW, jwa.ECDH_ES_A192KW, jwa.ECDH_ES_A256KW:
epkif, ok := h2.Get(EphemeralPublicKeyKey)
if !ok {
return nil, fmt.Errorf(`failed to get 'epk' field`)
}
switch epk := epkif.(type) {
case jwk.ECDSAPublicKey:
var pubkey ecdsa.PublicKey
if err := epk.Raw(&pubkey); err != nil {
return nil, fmt.Errorf(`failed to get public key: %w`, err)
}
dec.PublicKey(&pubkey)
case jwk.OKPPublicKey:
var pubkey interface{}
if err := epk.Raw(&pubkey); err != nil {
return nil, fmt.Errorf(`failed to get public key: %w`, err)
}
dec.PublicKey(pubkey)
default:
return nil, fmt.Errorf("unexpected 'epk' type %T for alg %s", epkif, alg)
}
if apu := h2.AgreementPartyUInfo(); len(apu) > 0 {
dec.AgreementPartyUInfo(apu)
}
if apv := h2.AgreementPartyVInfo(); len(apv) > 0 {
dec.AgreementPartyVInfo(apv)
}
case jwa.A128GCMKW, jwa.A192GCMKW, jwa.A256GCMKW:
ivB64, ok := h2.Get(InitializationVectorKey)
if ok {
ivB64Str, ok := ivB64.(string)
if !ok {
return nil, fmt.Errorf("unexpected type for 'iv': %T", ivB64)
}
iv, err := base64.DecodeString(ivB64Str)
if err != nil {
return nil, fmt.Errorf(`failed to b64-decode 'iv': %w`, err)
}
dec.KeyInitializationVector(iv)
}
tagB64, ok := h2.Get(TagKey)
if ok {
tagB64Str, ok := tagB64.(string)
if !ok {
return nil, fmt.Errorf("unexpected type for 'tag': %T", tagB64)
}
tag, err := base64.DecodeString(tagB64Str)
if err != nil {
return nil, fmt.Errorf(`failed to b64-decode 'tag': %w`, err)
}
dec.KeyTag(tag)
}
case jwa.PBES2_HS256_A128KW, jwa.PBES2_HS384_A192KW, jwa.PBES2_HS512_A256KW:
saltB64, ok := h2.Get(SaltKey)
if !ok {
return nil, fmt.Errorf(`failed to get 'p2s' field`)
}
saltB64Str, ok := saltB64.(string)
if !ok {
return nil, fmt.Errorf("unexpected type for 'p2s': %T", saltB64)
}
count, ok := h2.Get(CountKey)
if !ok {
return nil, fmt.Errorf(`failed to get 'p2c' field`)
}
// check if WithUseNumber is effective, because it will change the
// type of the underlying value (#1140)
var countFlt float64
if json.UseNumber() {
num, ok := count.(json.Number)
if !ok {
return nil, fmt.Errorf("unexpected type for 'p2c': %T", count)
}
v, err := num.Float64()
if err != nil {
return nil, fmt.Errorf("failed to convert 'p2c' to float64: %w", err)
}
countFlt = v
} else {
v, ok := count.(float64)
if !ok {
return nil, fmt.Errorf("unexpected type for 'p2c': %T", count)
}
countFlt = v
}
muSettings.RLock()
maxCount := maxPBES2Count
muSettings.RUnlock()
if countFlt > float64(maxCount) {
return nil, fmt.Errorf("invalid 'p2c' value")
}
salt, err := base64.DecodeString(saltB64Str)
if err != nil {
return nil, fmt.Errorf(`failed to b64-decode 'salt': %w`, err)
}
dec.KeySalt(salt)
dec.KeyCount(int(countFlt))
}
plaintext, err := dec.Decrypt(recipient, dctx.msg.cipherText, dctx.msg)
if err != nil {
return nil, fmt.Errorf(`jwe.Decrypt: decryption failed: %w`, err)
}
if h2.Compression() == jwa.Deflate {
buf, err := uncompress(plaintext, dctx.maxDecompressBufferSize)
if err != nil {
return nil, fmt.Errorf(`jwe.Derypt: failed to uncompress payload: %w`, err)
}
plaintext = buf
}
if plaintext == nil {
return nil, fmt.Errorf(`failed to find matching recipient`)
}
return plaintext, nil
}
// Parse parses the JWE message into a Message object. The JWE message
// can be either compact or full JSON format.
//
// Parse() currently does not take any options, but the API accepts it
// in anticipation of future addition.
func Parse(buf []byte, _ ...ParseOption) (*Message, error) {
return parseJSONOrCompact(buf, false)
}
func parseJSONOrCompact(buf []byte, storeProtectedHeaders bool) (*Message, error) {
buf = bytes.TrimSpace(buf)
if len(buf) == 0 {
return nil, fmt.Errorf(`empty buffer`)
}
if buf[0] == '{' {
return parseJSON(buf, storeProtectedHeaders)
}
return parseCompact(buf, storeProtectedHeaders)
}
// ParseString is the same as Parse, but takes a string.
func ParseString(s string) (*Message, error) {
return Parse([]byte(s))
}
// ParseReader is the same as Parse, but takes an io.Reader.
func ParseReader(src io.Reader) (*Message, error) {
buf, err := io.ReadAll(src)
if err != nil {
return nil, fmt.Errorf(`failed to read from io.Reader: %w`, err)
}
return Parse(buf)
}
func parseJSON(buf []byte, storeProtectedHeaders bool) (*Message, error) {
m := NewMessage()
m.storeProtectedHeaders = storeProtectedHeaders
if err := json.Unmarshal(buf, &m); err != nil {
return nil, fmt.Errorf(`failed to parse JSON: %w`, err)
}
return m, nil
}
func parseCompact(buf []byte, storeProtectedHeaders bool) (*Message, error) {
parts := bytes.Split(buf, []byte{'.'})
if len(parts) != 5 {
return nil, fmt.Errorf(`compact JWE format must have five parts (%d)`, len(parts))
}
hdrbuf, err := base64.Decode(parts[0])
if err != nil {
return nil, fmt.Errorf(`failed to parse first part of compact form: %w`, err)
}
protected := NewHeaders()
if err := json.Unmarshal(hdrbuf, protected); err != nil {
return nil, fmt.Errorf(`failed to parse header JSON: %w`, err)
}
ivbuf, err := base64.Decode(parts[2])
if err != nil {
return nil, fmt.Errorf(`failed to base64 decode iv: %w`, err)
}
ctbuf, err := base64.Decode(parts[3])
if err != nil {
return nil, fmt.Errorf(`failed to base64 decode content: %w`, err)
}
tagbuf, err := base64.Decode(parts[4])
if err != nil {
return nil, fmt.Errorf(`failed to base64 decode tag: %w`, err)
}
m := NewMessage()
if err := m.Set(CipherTextKey, ctbuf); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, CipherTextKey, err)
}
if err := m.Set(InitializationVectorKey, ivbuf); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, InitializationVectorKey, err)
}
if err := m.Set(ProtectedHeadersKey, protected); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, ProtectedHeadersKey, err)
}
if err := m.makeDummyRecipient(string(parts[1]), protected); err != nil {
return nil, fmt.Errorf(`failed to setup recipient: %w`, err)
}
if err := m.Set(TagKey, tagbuf); err != nil {
return nil, fmt.Errorf(`failed to set %s: %w`, TagKey, err)
}
if storeProtectedHeaders {
// This is later used for decryption.
m.rawProtectedHeaders = parts[0]
}
return m, nil
}
// RegisterCustomField allows users to specify that a private field
// be decoded as an instance of the specified type. This option has
// a global effect.
//
// For example, suppose you have a custom field `x-birthday`, which
// you want to represent as a string formatted in RFC3339 in JSON,
// but want it back as `time.Time`.
//
// In that case you would register a custom field as follows
//
// jwe.RegisterCustomField(`x-birthday`, timeT)
//
// Then `hdr.Get("x-birthday")` will still return an `interface{}`,
// but you can convert its type to `time.Time`
//
// bdayif, _ := hdr.Get(`x-birthday`)
// bday := bdayif.(time.Time)
func RegisterCustomField(name string, object interface{}) {
registry.Register(name, object)
}
|