xref: /openbsd/lib/libcrypto/asn1/p8_pkey.c (revision e1608179)
1 /* $OpenBSD: p8_pkey.c,v 1.24 2024/04/09 13:55:02 beck Exp $ */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project 1999.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999-2005 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 <string.h>
61 
62 #include <openssl/asn1t.h>
63 #include <openssl/x509.h>
64 
65 #include "x509_local.h"
66 
67 /* Minor tweak to operation: zero private key data */
68 static int
pkey_cb(int operation,ASN1_VALUE ** pval,const ASN1_ITEM * it,void * exarg)69 pkey_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it, void *exarg)
70 {
71 	/* Since the structure must still be valid use ASN1_OP_FREE_PRE */
72 	if (operation == ASN1_OP_FREE_PRE) {
73 		PKCS8_PRIV_KEY_INFO *key = (PKCS8_PRIV_KEY_INFO *)*pval;
74 		if (key->pkey != NULL)
75 			explicit_bzero(key->pkey->data, key->pkey->length);
76 	}
77 	return 1;
78 }
79 
80 static const ASN1_AUX PKCS8_PRIV_KEY_INFO_aux = {
81 	.asn1_cb = pkey_cb,
82 };
83 static const ASN1_TEMPLATE PKCS8_PRIV_KEY_INFO_seq_tt[] = {
84 	{
85 		.offset = offsetof(PKCS8_PRIV_KEY_INFO, version),
86 		.field_name = "version",
87 		.item = &ASN1_INTEGER_it,
88 	},
89 	{
90 		.offset = offsetof(PKCS8_PRIV_KEY_INFO, pkeyalg),
91 		.field_name = "pkeyalg",
92 		.item = &X509_ALGOR_it,
93 	},
94 	{
95 		.offset = offsetof(PKCS8_PRIV_KEY_INFO, pkey),
96 		.field_name = "pkey",
97 		.item = &ASN1_OCTET_STRING_it,
98 	},
99 	{
100 		.flags = ASN1_TFLG_IMPLICIT | ASN1_TFLG_SET_OF | ASN1_TFLG_OPTIONAL,
101 		.offset = offsetof(PKCS8_PRIV_KEY_INFO, attributes),
102 		.field_name = "attributes",
103 		.item = &X509_ATTRIBUTE_it,
104 	},
105 };
106 
107 const ASN1_ITEM PKCS8_PRIV_KEY_INFO_it = {
108 	.itype = ASN1_ITYPE_SEQUENCE,
109 	.utype = V_ASN1_SEQUENCE,
110 	.templates = PKCS8_PRIV_KEY_INFO_seq_tt,
111 	.tcount = sizeof(PKCS8_PRIV_KEY_INFO_seq_tt) / sizeof(ASN1_TEMPLATE),
112 	.funcs = &PKCS8_PRIV_KEY_INFO_aux,
113 	.size = sizeof(PKCS8_PRIV_KEY_INFO),
114 	.sname = "PKCS8_PRIV_KEY_INFO",
115 };
116 
117 
118 PKCS8_PRIV_KEY_INFO *
d2i_PKCS8_PRIV_KEY_INFO(PKCS8_PRIV_KEY_INFO ** a,const unsigned char ** in,long len)119 d2i_PKCS8_PRIV_KEY_INFO(PKCS8_PRIV_KEY_INFO **a, const unsigned char **in, long len)
120 {
121 	return (PKCS8_PRIV_KEY_INFO *)ASN1_item_d2i((ASN1_VALUE **)a, in, len,
122 	    &PKCS8_PRIV_KEY_INFO_it);
123 }
124 LCRYPTO_ALIAS(d2i_PKCS8_PRIV_KEY_INFO);
125 
126 int
i2d_PKCS8_PRIV_KEY_INFO(PKCS8_PRIV_KEY_INFO * a,unsigned char ** out)127 i2d_PKCS8_PRIV_KEY_INFO(PKCS8_PRIV_KEY_INFO *a, unsigned char **out)
128 {
129 	return ASN1_item_i2d((ASN1_VALUE *)a, out, &PKCS8_PRIV_KEY_INFO_it);
130 }
131 LCRYPTO_ALIAS(i2d_PKCS8_PRIV_KEY_INFO);
132 
133 PKCS8_PRIV_KEY_INFO *
PKCS8_PRIV_KEY_INFO_new(void)134 PKCS8_PRIV_KEY_INFO_new(void)
135 {
136 	return (PKCS8_PRIV_KEY_INFO *)ASN1_item_new(&PKCS8_PRIV_KEY_INFO_it);
137 }
138 LCRYPTO_ALIAS(PKCS8_PRIV_KEY_INFO_new);
139 
140 void
PKCS8_PRIV_KEY_INFO_free(PKCS8_PRIV_KEY_INFO * a)141 PKCS8_PRIV_KEY_INFO_free(PKCS8_PRIV_KEY_INFO *a)
142 {
143 	ASN1_item_free((ASN1_VALUE *)a, &PKCS8_PRIV_KEY_INFO_it);
144 }
145 LCRYPTO_ALIAS(PKCS8_PRIV_KEY_INFO_free);
146 
147 int
PKCS8_pkey_set0(PKCS8_PRIV_KEY_INFO * priv,ASN1_OBJECT * aobj,int version,int ptype,void * pval,unsigned char * penc,int penclen)148 PKCS8_pkey_set0(PKCS8_PRIV_KEY_INFO *priv, ASN1_OBJECT *aobj, int version,
149     int ptype, void *pval, unsigned char *penc, int penclen)
150 {
151 	if (version >= 0) {
152 		if (!ASN1_INTEGER_set(priv->version, version))
153 			return 0;
154 	}
155 	if (!X509_ALGOR_set0(priv->pkeyalg, aobj, ptype, pval))
156 		return 0;
157 	if (penc != NULL)
158 		ASN1_STRING_set0(priv->pkey, penc, penclen);
159 	return 1;
160 }
161 LCRYPTO_ALIAS(PKCS8_pkey_set0);
162 
163 int
PKCS8_pkey_get0(const ASN1_OBJECT ** ppkalg,const unsigned char ** pk,int * ppklen,const X509_ALGOR ** pa,const PKCS8_PRIV_KEY_INFO * p8)164 PKCS8_pkey_get0(const ASN1_OBJECT **ppkalg, const unsigned char **pk,
165     int *ppklen, const X509_ALGOR **pa, const PKCS8_PRIV_KEY_INFO *p8)
166 {
167 	if (ppkalg != NULL)
168 		*ppkalg = p8->pkeyalg->algorithm;
169 	if (pk != NULL) {
170 		*pk = ASN1_STRING_data(p8->pkey);
171 		*ppklen = ASN1_STRING_length(p8->pkey);
172 	}
173 	if (pa != NULL)
174 		*pa = p8->pkeyalg;
175 	return 1;
176 }
177 LCRYPTO_ALIAS(PKCS8_pkey_get0);
178 
STACK_OF(X509_ATTRIBUTE)179 const STACK_OF(X509_ATTRIBUTE) *
180 PKCS8_pkey_get0_attrs(const PKCS8_PRIV_KEY_INFO *p8)
181 {
182 	return p8->attributes;
183 }
184 LCRYPTO_ALIAS(PKCS8_pkey_get0_attrs);
185 
186 int
PKCS8_pkey_add1_attr_by_NID(PKCS8_PRIV_KEY_INFO * p8,int nid,int type,const unsigned char * bytes,int len)187 PKCS8_pkey_add1_attr_by_NID(PKCS8_PRIV_KEY_INFO *p8, int nid, int type,
188     const unsigned char *bytes, int len)
189 {
190 	if (X509at_add1_attr_by_NID(&p8->attributes, nid, type, bytes,
191 	    len) != NULL)
192 		return 1;
193 	return 0;
194 }
195 LCRYPTO_ALIAS(PKCS8_pkey_add1_attr_by_NID);
196