xref: /openbsd/lib/libcrypto/asn1/p5_pbe.c (revision 72c7c57a)
1 /* $OpenBSD: p5_pbe.c,v 1.27 2024/03/28 00:44:26 tb Exp $ */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project 1999.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58 
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <string.h>
62 
63 #include <openssl/asn1t.h>
64 #include <openssl/err.h>
65 #include <openssl/x509.h>
66 
67 #include "x509_local.h"
68 
69 /* PKCS#5 password based encryption structure */
70 
71 static const ASN1_TEMPLATE PBEPARAM_seq_tt[] = {
72 	{
73 		.offset = offsetof(PBEPARAM, salt),
74 		.field_name = "salt",
75 		.item = &ASN1_OCTET_STRING_it,
76 	},
77 	{
78 		.offset = offsetof(PBEPARAM, iter),
79 		.field_name = "iter",
80 		.item = &ASN1_INTEGER_it,
81 	},
82 };
83 
84 const ASN1_ITEM PBEPARAM_it = {
85 	.itype = ASN1_ITYPE_SEQUENCE,
86 	.utype = V_ASN1_SEQUENCE,
87 	.templates = PBEPARAM_seq_tt,
88 	.tcount = sizeof(PBEPARAM_seq_tt) / sizeof(ASN1_TEMPLATE),
89 	.size = sizeof(PBEPARAM),
90 	.sname = "PBEPARAM",
91 };
92 
93 
94 PBEPARAM *
95 d2i_PBEPARAM(PBEPARAM **a, const unsigned char **in, long len)
96 {
97 	return (PBEPARAM *)ASN1_item_d2i((ASN1_VALUE **)a, in, len,
98 	    &PBEPARAM_it);
99 }
100 
101 int
102 i2d_PBEPARAM(PBEPARAM *a, unsigned char **out)
103 {
104 	return ASN1_item_i2d((ASN1_VALUE *)a, out, &PBEPARAM_it);
105 }
106 
107 PBEPARAM *
108 PBEPARAM_new(void)
109 {
110 	return (PBEPARAM *)ASN1_item_new(&PBEPARAM_it);
111 }
112 
113 void
114 PBEPARAM_free(PBEPARAM *a)
115 {
116 	ASN1_item_free((ASN1_VALUE *)a, &PBEPARAM_it);
117 }
118 
119 
120 /* Set an algorithm identifier for a PKCS#5 PBE algorithm */
121 
122 int
123 PKCS5_pbe_set0_algor(X509_ALGOR *algor, int alg, int iter,
124     const unsigned char *salt, int saltlen)
125 {
126 	PBEPARAM *pbe = NULL;
127 	ASN1_STRING *pbe_str = NULL;
128 	unsigned char *sstr;
129 
130 	if ((pbe = PBEPARAM_new()) == NULL) {
131 		ASN1error(ERR_R_MALLOC_FAILURE);
132 		goto err;
133 	}
134 	if (iter <= 0)
135 		iter = PKCS5_DEFAULT_ITER;
136 	if (!ASN1_INTEGER_set(pbe->iter, iter)) {
137 		ASN1error(ERR_R_MALLOC_FAILURE);
138 		goto err;
139 	}
140 	if (!saltlen)
141 		saltlen = PKCS5_SALT_LEN;
142 	if (!ASN1_STRING_set(pbe->salt, NULL, saltlen)) {
143 		ASN1error(ERR_R_MALLOC_FAILURE);
144 		goto err;
145 	}
146 	sstr = ASN1_STRING_data(pbe->salt);
147 	if (salt)
148 		memcpy(sstr, salt, saltlen);
149 	else
150 		arc4random_buf(sstr, saltlen);
151 
152 	if (!ASN1_item_pack(pbe, &PBEPARAM_it, &pbe_str)) {
153 		ASN1error(ERR_R_MALLOC_FAILURE);
154 		goto err;
155 	}
156 
157 	PBEPARAM_free(pbe);
158 	pbe = NULL;
159 
160 	if (X509_ALGOR_set0(algor, OBJ_nid2obj(alg), V_ASN1_SEQUENCE, pbe_str))
161 		return 1;
162 
163  err:
164 	if (pbe != NULL)
165 		PBEPARAM_free(pbe);
166 	ASN1_STRING_free(pbe_str);
167 	return 0;
168 }
169 
170 /* Return an algorithm identifier for a PKCS#5 PBE algorithm */
171 
172 X509_ALGOR *
173 PKCS5_pbe_set(int alg, int iter, const unsigned char *salt, int saltlen)
174 {
175 	X509_ALGOR *ret;
176 	ret = X509_ALGOR_new();
177 	if (!ret) {
178 		ASN1error(ERR_R_MALLOC_FAILURE);
179 		return NULL;
180 	}
181 
182 	if (PKCS5_pbe_set0_algor(ret, alg, iter, salt, saltlen))
183 		return ret;
184 
185 	X509_ALGOR_free(ret);
186 	return NULL;
187 }
188