1 /* crypto/cms/cms_pwri.c */
3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
6 /* ====================================================================
7 * Copyright (c) 2009 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
55 #include "internal/cryptlib.h"
56 #include <openssl/asn1t.h>
57 #include <openssl/pem.h>
58 #include <openssl/x509v3.h>
59 #include <openssl/err.h>
60 #include <openssl/cms.h>
61 #include <openssl/rand.h>
62 #include <openssl/aes.h>
64 #include "internal/asn1_int.h"
66 int CMS_RecipientInfo_set0_password(CMS_RecipientInfo *ri,
67 unsigned char *pass, ossl_ssize_t passlen)
69 CMS_PasswordRecipientInfo *pwri;
70 if (ri->type != CMS_RECIPINFO_PASS) {
71 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_PASSWORD, CMS_R_NOT_PWRI);
77 if (pass && passlen < 0)
78 passlen = strlen((char *)pass);
79 pwri->passlen = passlen;
83 CMS_RecipientInfo *CMS_add0_recipient_password(CMS_ContentInfo *cms,
84 int iter, int wrap_nid,
88 const EVP_CIPHER *kekciph)
90 CMS_RecipientInfo *ri = NULL;
91 CMS_EnvelopedData *env;
92 CMS_PasswordRecipientInfo *pwri;
93 EVP_CIPHER_CTX *ctx = NULL;
94 X509_ALGOR *encalg = NULL;
95 unsigned char iv[EVP_MAX_IV_LENGTH];
98 env = cms_get0_enveloped(cms);
103 wrap_nid = NID_id_alg_PWRI_KEK;
106 pbe_nid = NID_id_pbkdf2;
108 /* Get from enveloped data */
110 kekciph = env->encryptedContentInfo->cipher;
112 if (kekciph == NULL) {
113 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_PASSWORD, CMS_R_NO_CIPHER);
116 if (wrap_nid != NID_id_alg_PWRI_KEK) {
117 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_PASSWORD,
118 CMS_R_UNSUPPORTED_KEY_ENCRYPTION_ALGORITHM);
122 /* Setup algorithm identifier for cipher */
123 encalg = X509_ALGOR_new();
124 if (encalg == NULL) {
127 ctx = EVP_CIPHER_CTX_new();
129 if (EVP_EncryptInit_ex(ctx, kekciph, NULL, NULL, NULL) <= 0) {
130 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_PASSWORD, ERR_R_EVP_LIB);
134 ivlen = EVP_CIPHER_CTX_iv_length(ctx);
137 if (RAND_bytes(iv, ivlen) <= 0)
139 if (EVP_EncryptInit_ex(ctx, NULL, NULL, NULL, iv) <= 0) {
140 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_PASSWORD, ERR_R_EVP_LIB);
143 encalg->parameter = ASN1_TYPE_new();
144 if (!encalg->parameter) {
145 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_PASSWORD, ERR_R_MALLOC_FAILURE);
148 if (EVP_CIPHER_param_to_asn1(ctx, encalg->parameter) <= 0) {
149 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_PASSWORD,
150 CMS_R_CIPHER_PARAMETER_INITIALISATION_ERROR);
155 encalg->algorithm = OBJ_nid2obj(EVP_CIPHER_CTX_type(ctx));
157 EVP_CIPHER_CTX_free(ctx);
160 /* Initialize recipient info */
161 ri = M_ASN1_new_of(CMS_RecipientInfo);
165 ri->d.pwri = M_ASN1_new_of(CMS_PasswordRecipientInfo);
166 if (ri->d.pwri == NULL)
168 ri->type = CMS_RECIPINFO_PASS;
171 /* Since this is overwritten, free up empty structure already there */
172 X509_ALGOR_free(pwri->keyEncryptionAlgorithm);
173 pwri->keyEncryptionAlgorithm = X509_ALGOR_new();
174 if (pwri->keyEncryptionAlgorithm == NULL)
176 pwri->keyEncryptionAlgorithm->algorithm = OBJ_nid2obj(wrap_nid);
177 pwri->keyEncryptionAlgorithm->parameter = ASN1_TYPE_new();
178 if (pwri->keyEncryptionAlgorithm->parameter == NULL)
181 if (!ASN1_item_pack(encalg, ASN1_ITEM_rptr(X509_ALGOR),
182 &pwri->keyEncryptionAlgorithm->parameter->
185 pwri->keyEncryptionAlgorithm->parameter->type = V_ASN1_SEQUENCE;
187 X509_ALGOR_free(encalg);
190 /* Setup PBE algorithm */
192 pwri->keyDerivationAlgorithm = PKCS5_pbkdf2_set(iter, NULL, 0, -1, -1);
194 if (!pwri->keyDerivationAlgorithm)
197 CMS_RecipientInfo_set0_password(ri, pass, passlen);
200 if (!sk_CMS_RecipientInfo_push(env->recipientInfos, ri))
206 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_PASSWORD, ERR_R_MALLOC_FAILURE);
208 EVP_CIPHER_CTX_free(ctx);
210 M_ASN1_free_of(ri, CMS_RecipientInfo);
211 X509_ALGOR_free(encalg);
217 * This is an implementation of the key wrapping mechanism in RFC3211, at
218 * some point this should go into EVP.
221 static int kek_unwrap_key(unsigned char *out, size_t *outlen,
222 const unsigned char *in, size_t inlen,
225 size_t blocklen = EVP_CIPHER_CTX_block_size(ctx);
228 if (inlen < 2 * blocklen) {
232 if (inlen % blocklen) {
236 tmp = OPENSSL_malloc(inlen);
239 /* setup IV by decrypting last two blocks */
240 if (!EVP_DecryptUpdate(ctx, tmp + inlen - 2 * blocklen, &outl,
241 in + inlen - 2 * blocklen, blocklen * 2)
243 * Do a decrypt of last decrypted block to set IV to correct value
244 * output it to start of buffer so we don't corrupt decrypted block
245 * this works because buffer is at least two block lengths long.
247 || !EVP_DecryptUpdate(ctx, tmp, &outl,
248 tmp + inlen - blocklen, blocklen)
249 /* Can now decrypt first n - 1 blocks */
250 || !EVP_DecryptUpdate(ctx, tmp, &outl, in, inlen - blocklen)
252 /* Reset IV to original value */
253 || !EVP_DecryptInit_ex(ctx, NULL, NULL, NULL, NULL)
255 || !EVP_DecryptUpdate(ctx, tmp, &outl, tmp, inlen))
257 /* Check check bytes */
258 if (((tmp[1] ^ tmp[4]) & (tmp[2] ^ tmp[5]) & (tmp[3] ^ tmp[6])) != 0xff) {
259 /* Check byte failure */
262 if (inlen < (size_t)(tmp[0] - 4)) {
263 /* Invalid length value */
266 *outlen = (size_t)tmp[0];
267 memcpy(out, tmp + 4, *outlen);
270 OPENSSL_clear_free(tmp, inlen);
275 static int kek_wrap_key(unsigned char *out, size_t *outlen,
276 const unsigned char *in, size_t inlen,
279 size_t blocklen = EVP_CIPHER_CTX_block_size(ctx);
283 * First decide length of output buffer: need header and round up to
284 * multiple of block length.
286 olen = (inlen + 4 + blocklen - 1) / blocklen;
288 if (olen < 2 * blocklen) {
298 out[0] = (unsigned char)inlen;
299 out[1] = in[0] ^ 0xFF;
300 out[2] = in[1] ^ 0xFF;
301 out[3] = in[2] ^ 0xFF;
302 memcpy(out + 4, in, inlen);
303 /* Add random padding to end */
305 && RAND_bytes(out + 4 + inlen, olen - 4 - inlen) <= 0)
308 if (!EVP_EncryptUpdate(ctx, out, &dummy, out, olen)
309 || !EVP_EncryptUpdate(ctx, out, &dummy, out, olen))
318 /* Encrypt/Decrypt content key in PWRI recipient info */
320 int cms_RecipientInfo_pwri_crypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri,
323 CMS_EncryptedContentInfo *ec;
324 CMS_PasswordRecipientInfo *pwri;
326 X509_ALGOR *algtmp, *kekalg = NULL;
327 EVP_CIPHER_CTX *kekctx;
328 const EVP_CIPHER *kekcipher;
329 unsigned char *key = NULL;
332 ec = cms->d.envelopedData->encryptedContentInfo;
335 kekctx = EVP_CIPHER_CTX_new();
338 CMSerr(CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT, CMS_R_NO_PASSWORD);
341 algtmp = pwri->keyEncryptionAlgorithm;
343 if (!algtmp || OBJ_obj2nid(algtmp->algorithm) != NID_id_alg_PWRI_KEK) {
344 CMSerr(CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT,
345 CMS_R_UNSUPPORTED_KEY_ENCRYPTION_ALGORITHM);
349 kekalg = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(X509_ALGOR),
352 if (kekalg == NULL) {
353 CMSerr(CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT,
354 CMS_R_INVALID_KEY_ENCRYPTION_PARAMETER);
358 kekcipher = EVP_get_cipherbyobj(kekalg->algorithm);
361 CMSerr(CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT, CMS_R_UNKNOWN_CIPHER);
365 /* Fixup cipher based on AlgorithmIdentifier to set IV etc */
366 if (!EVP_CipherInit_ex(kekctx, kekcipher, NULL, NULL, NULL, en_de))
368 EVP_CIPHER_CTX_set_padding(kekctx, 0);
369 if (EVP_CIPHER_asn1_to_param(kekctx, kekalg->parameter) < 0) {
370 CMSerr(CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT,
371 CMS_R_CIPHER_PARAMETER_INITIALISATION_ERROR);
375 algtmp = pwri->keyDerivationAlgorithm;
377 /* Finish password based key derivation to setup key in "ctx" */
379 if (EVP_PBE_CipherInit(algtmp->algorithm,
380 (char *)pwri->pass, pwri->passlen,
381 algtmp->parameter, kekctx, en_de) < 0) {
382 CMSerr(CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT, ERR_R_EVP_LIB);
386 /* Finally wrap/unwrap the key */
390 if (!kek_wrap_key(NULL, &keylen, ec->key, ec->keylen, kekctx))
393 key = OPENSSL_malloc(keylen);
398 if (!kek_wrap_key(key, &keylen, ec->key, ec->keylen, kekctx))
400 pwri->encryptedKey->data = key;
401 pwri->encryptedKey->length = keylen;
403 key = OPENSSL_malloc(pwri->encryptedKey->length);
406 CMSerr(CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT, ERR_R_MALLOC_FAILURE);
409 if (!kek_unwrap_key(key, &keylen,
410 pwri->encryptedKey->data,
411 pwri->encryptedKey->length, kekctx)) {
412 CMSerr(CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT, CMS_R_UNWRAP_FAILURE);
425 EVP_CIPHER_CTX_free(kekctx);
429 X509_ALGOR_free(kekalg);