001/*
002 * nimbus-jose-jwt
003 *
004 * Copyright 2012-2016, Connect2id Ltd.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.jose.crypto;
019
020
021import java.util.Set;
022import javax.crypto.SecretKey;
023
024import com.nimbusds.jose.*;
025import com.nimbusds.jose.crypto.impl.*;
026import com.nimbusds.jose.util.Base64URL;
027import com.nimbusds.jose.util.StandardCharset;
028import net.jcip.annotations.ThreadSafe;
029
030
031/**
032 * Password-based decrypter of {@link com.nimbusds.jose.JWEObject JWE objects}.
033 * Expects a password.
034 *
035 * <p>See RFC 7518
036 * <a href="https://tools.ietf.org/html/rfc7518#section-4.8">section 4.8</a>
037 * for more information.
038 *
039 * <p>This class is thread-safe.
040 *
041 * <p>Supports the following key management algorithms:
042 *
043 * <ul>
044 *     <li>{@link com.nimbusds.jose.JWEAlgorithm#PBES2_HS256_A128KW}
045 *     <li>{@link com.nimbusds.jose.JWEAlgorithm#PBES2_HS384_A192KW}
046 *     <li>{@link com.nimbusds.jose.JWEAlgorithm#PBES2_HS512_A256KW}
047 * </ul>
048 *
049 * <p>Supports the following content encryption algorithms:
050 *
051 * <ul>
052 *     <li>{@link com.nimbusds.jose.EncryptionMethod#A128CBC_HS256}
053 *     <li>{@link com.nimbusds.jose.EncryptionMethod#A192CBC_HS384}
054 *     <li>{@link com.nimbusds.jose.EncryptionMethod#A256CBC_HS512}
055 *     <li>{@link com.nimbusds.jose.EncryptionMethod#A128GCM}
056 *     <li>{@link com.nimbusds.jose.EncryptionMethod#A192GCM}
057 *     <li>{@link com.nimbusds.jose.EncryptionMethod#A256GCM}
058 *     <li>{@link com.nimbusds.jose.EncryptionMethod#A128CBC_HS256_DEPRECATED}
059 *     <li>{@link com.nimbusds.jose.EncryptionMethod#A256CBC_HS512_DEPRECATED}
060 *     <li>{@link com.nimbusds.jose.EncryptionMethod#XC20P}
061 * </ul>
062 *
063 * @author Vladimir Dzhuvinov
064 * @author Egor Puzanov
065 * @version 2023-09-10
066 */
067@ThreadSafe
068public class PasswordBasedDecrypter extends PasswordBasedCryptoProvider implements JWEDecrypter, CriticalHeaderParamsAware {
069
070
071        /**
072         * The critical header policy.
073         */
074        private final CriticalHeaderParamsDeferral critPolicy = new CriticalHeaderParamsDeferral();
075
076
077        /**
078         * Creates a new password-based decrypter.
079         *
080         * @param password The password bytes. Must not be empty or
081         *                 {@code null}.
082         */
083        public PasswordBasedDecrypter(final byte[] password) {
084
085                super(password);
086        }
087
088
089        /**
090         * Creates a new password-based decrypter.
091         *
092         * @param password The password, as a UTF-8 encoded string. Must not be
093         *                 empty or {@code null}.
094         */
095        public PasswordBasedDecrypter(final String password) {
096
097                super(password.getBytes(StandardCharset.UTF_8));
098        }
099
100
101        @Override
102        public Set<String> getProcessedCriticalHeaderParams() {
103
104                return critPolicy.getProcessedCriticalHeaderParams();
105        }
106
107
108        @Override
109        public Set<String> getDeferredCriticalHeaderParams() {
110
111                return critPolicy.getProcessedCriticalHeaderParams();
112        }
113
114
115        /**
116         * Decrypts the specified cipher text of a {@link JWEObject JWE Object}.
117         *
118         * @param header       The JSON Web Encryption (JWE) header. Must
119         *                     specify a supported JWE algorithm and method.
120         *                     Must not be {@code null}.
121         * @param encryptedKey The encrypted key, {@code null} if not required
122         *                     by the JWE algorithm.
123         * @param iv           The initialisation vector, {@code null} if not
124         *                     required by the JWE algorithm.
125         * @param cipherText   The cipher text to decrypt. Must not be
126         *                     {@code null}.
127         * @param authTag      The authentication tag, {@code null} if not
128         *                     required.
129         *
130         * @return The clear text.
131         *
132         * @throws JOSEException If the JWE algorithm or method is not
133         *                       supported, if a critical header parameter is
134         *                       not supported or marked for deferral to the
135         *                       application, or if decryption failed for some
136         *                       other reason.
137         */
138        @Deprecated
139        public byte[] decrypt(final JWEHeader header,
140                       final Base64URL encryptedKey,
141                       final Base64URL iv,
142                       final Base64URL cipherText,
143                       final Base64URL authTag)
144                throws JOSEException {
145
146                return decrypt(header, encryptedKey, iv, cipherText, authTag, AAD.compute(header));
147        }
148
149
150        @Override
151        public byte[] decrypt(final JWEHeader header,
152                              final Base64URL encryptedKey,
153                              final Base64URL iv,
154                              final Base64URL cipherText,
155                              final Base64URL authTag,
156                              final byte[] aad)
157                throws JOSEException {
158
159                // Validate required JWE parts
160                if (encryptedKey == null) {
161                        throw new JOSEException("Missing JWE encrypted key");
162                }
163
164                if (iv == null) {
165                        throw new JOSEException("Missing JWE initialization vector (IV)");
166                }
167
168                if (authTag == null) {
169                        throw new JOSEException("Missing JWE authentication tag");
170                }
171
172                if (header.getPBES2Salt() == null) {
173                        throw new JOSEException("Missing JWE p2s header parameter");
174                }
175
176                final byte[] salt = header.getPBES2Salt().decode();
177
178                if (header.getPBES2Count() < 1) {
179                        throw new JOSEException("Missing JWE p2c header parameter");
180                }
181
182                final int iterationCount = header.getPBES2Count();
183
184                critPolicy.ensureHeaderPasses(header);
185
186                final JWEAlgorithm alg = JWEHeaderValidation.getAlgorithmAndEnsureNotNull(header);
187                final byte[] formattedSalt = PBKDF2.formatSalt(alg, salt);
188                final PRFParams prfParams = PRFParams.resolve(alg, getJCAContext().getMACProvider());
189                final SecretKey psKey = PBKDF2.deriveKey(getPassword(), formattedSalt, iterationCount, prfParams);
190
191                final SecretKey cek = AESKW.unwrapCEK(psKey, encryptedKey.decode(), getJCAContext().getKeyEncryptionProvider());
192
193                return ContentCryptoProvider.decrypt(header, aad, encryptedKey, iv, cipherText, authTag, cek, getJCAContext());
194        }
195}