xref: /openbsd-src/lib/libcrypto/ec/eck_prn.c (revision 3374c67d44f9b75b98444cbf63020f777792342e)
1 /* $OpenBSD: eck_prn.c,v 1.20 2022/11/19 07:29:29 tb Exp $ */
2 /*
3  * Written by Nils Larsch for the OpenSSL project.
4  */
5 /* ====================================================================
6  * Copyright (c) 1998-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  *    openssl-core@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  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60  * Portions originally developed by SUN MICROSYSTEMS, INC., and
61  * contributed to the OpenSSL project.
62  */
63 
64 #include <stdio.h>
65 #include <string.h>
66 
67 #include <openssl/bn.h>
68 #include <openssl/ec.h>
69 #include <openssl/err.h>
70 #include <openssl/evp.h>
71 
72 int
73 ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off)
74 {
75 	BIO *b;
76 	int ret;
77 
78 	if ((b = BIO_new(BIO_s_file())) == NULL) {
79 		ECerror(ERR_R_BUF_LIB);
80 		return (0);
81 	}
82 	BIO_set_fp(b, fp, BIO_NOCLOSE);
83 	ret = ECPKParameters_print(b, x, off);
84 	BIO_free(b);
85 	return (ret);
86 }
87 
88 int
89 EC_KEY_print_fp(FILE *fp, const EC_KEY *x, int off)
90 {
91 	BIO *b;
92 	int ret;
93 
94 	if ((b = BIO_new(BIO_s_file())) == NULL) {
95 		ECerror(ERR_R_BIO_LIB);
96 		return (0);
97 	}
98 	BIO_set_fp(b, fp, BIO_NOCLOSE);
99 	ret = EC_KEY_print(b, x, off);
100 	BIO_free(b);
101 	return (ret);
102 }
103 
104 int
105 ECParameters_print_fp(FILE *fp, const EC_KEY *x)
106 {
107 	BIO *b;
108 	int ret;
109 
110 	if ((b = BIO_new(BIO_s_file())) == NULL) {
111 		ECerror(ERR_R_BIO_LIB);
112 		return (0);
113 	}
114 	BIO_set_fp(b, fp, BIO_NOCLOSE);
115 	ret = ECParameters_print(b, x);
116 	BIO_free(b);
117 	return (ret);
118 }
119 
120 int
121 EC_KEY_print(BIO *bp, const EC_KEY *x, int off)
122 {
123 	EVP_PKEY *pk;
124 	int ret = 0;
125 
126 	if ((pk = EVP_PKEY_new()) == NULL)
127 		goto err;
128 
129 	if (!EVP_PKEY_set1_EC_KEY(pk, (EC_KEY *) x))
130 		goto err;
131 
132 	ret = EVP_PKEY_print_private(bp, pk, off, NULL);
133  err:
134 	EVP_PKEY_free(pk);
135 	return ret;
136 }
137 
138 int
139 ECParameters_print(BIO *bp, const EC_KEY *x)
140 {
141 	EVP_PKEY *pk;
142 	int ret = 0;
143 
144 	if ((pk = EVP_PKEY_new()) == NULL)
145 		goto err;
146 
147 	if (!EVP_PKEY_set1_EC_KEY(pk, (EC_KEY *) x))
148 		goto err;
149 
150 	ret = EVP_PKEY_print_params(bp, pk, 4, NULL);
151  err:
152 	EVP_PKEY_free(pk);
153 	return ret;
154 }
155 
156 static int
157 print_bin(BIO *fp, const char *str, const unsigned char *num,
158     size_t len, int off);
159 
160 int
161 ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off)
162 {
163 	unsigned char *buffer = NULL;
164 	size_t buf_len = 0, i;
165 	int ret = 0, reason = ERR_R_BIO_LIB;
166 	BN_CTX *ctx = NULL;
167 	const EC_POINT *point = NULL;
168 	BIGNUM *p = NULL, *a = NULL, *b = NULL, *gen = NULL, *order = NULL,
169 	*cofactor = NULL;
170 	const unsigned char *seed;
171 	size_t seed_len = 0;
172 	const char *nname;
173 
174 	static const char *gen_compressed = "Generator (compressed):";
175 	static const char *gen_uncompressed = "Generator (uncompressed):";
176 	static const char *gen_hybrid = "Generator (hybrid):";
177 
178 	if (!x) {
179 		reason = ERR_R_PASSED_NULL_PARAMETER;
180 		goto err;
181 	}
182 	ctx = BN_CTX_new();
183 	if (ctx == NULL) {
184 		reason = ERR_R_MALLOC_FAILURE;
185 		goto err;
186 	}
187 	if (EC_GROUP_get_asn1_flag(x)) {
188 		/* the curve parameter are given by an asn1 OID */
189 		int nid;
190 
191 		if (!BIO_indent(bp, off, 128))
192 			goto err;
193 
194 		nid = EC_GROUP_get_curve_name(x);
195 		if (nid == 0)
196 			goto err;
197 
198 		if (BIO_printf(bp, "ASN1 OID: %s", OBJ_nid2sn(nid)) <= 0)
199 			goto err;
200 		if (BIO_printf(bp, "\n") <= 0)
201 			goto err;
202 
203 		nname = EC_curve_nid2nist(nid);
204 		if (nname) {
205 			if (!BIO_indent(bp, off, 128))
206 				goto err;
207 			if (BIO_printf(bp, "NIST CURVE: %s\n", nname) <= 0)
208 				goto err;
209 		}
210 	} else {
211 		/* explicit parameters */
212 		int is_char_two = 0;
213 		point_conversion_form_t form;
214 		int tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(x));
215 
216 		if (tmp_nid == NID_X9_62_characteristic_two_field)
217 			is_char_two = 1;
218 
219 		if ((p = BN_new()) == NULL || (a = BN_new()) == NULL ||
220 		    (b = BN_new()) == NULL || (order = BN_new()) == NULL ||
221 		    (cofactor = BN_new()) == NULL) {
222 			reason = ERR_R_MALLOC_FAILURE;
223 			goto err;
224 		}
225 		if (!EC_GROUP_get_curve(x, p, a, b, ctx)) {
226 			reason = ERR_R_EC_LIB;
227 			goto err;
228 		}
229 
230 		if ((point = EC_GROUP_get0_generator(x)) == NULL) {
231 			reason = ERR_R_EC_LIB;
232 			goto err;
233 		}
234 		if (!EC_GROUP_get_order(x, order, NULL) ||
235 		    !EC_GROUP_get_cofactor(x, cofactor, NULL)) {
236 			reason = ERR_R_EC_LIB;
237 			goto err;
238 		}
239 		form = EC_GROUP_get_point_conversion_form(x);
240 
241 		if ((gen = EC_POINT_point2bn(x, point,
242 			    form, NULL, ctx)) == NULL) {
243 			reason = ERR_R_EC_LIB;
244 			goto err;
245 		}
246 		buf_len = (size_t) BN_num_bytes(p);
247 		if (buf_len < (i = (size_t) BN_num_bytes(a)))
248 			buf_len = i;
249 		if (buf_len < (i = (size_t) BN_num_bytes(b)))
250 			buf_len = i;
251 		if (buf_len < (i = (size_t) BN_num_bytes(gen)))
252 			buf_len = i;
253 		if (buf_len < (i = (size_t) BN_num_bytes(order)))
254 			buf_len = i;
255 		if (buf_len < (i = (size_t) BN_num_bytes(cofactor)))
256 			buf_len = i;
257 
258 		if ((seed = EC_GROUP_get0_seed(x)) != NULL)
259 			seed_len = EC_GROUP_get_seed_len(x);
260 
261 		buf_len += 10;
262 		if ((buffer = malloc(buf_len)) == NULL) {
263 			reason = ERR_R_MALLOC_FAILURE;
264 			goto err;
265 		}
266 		if (!BIO_indent(bp, off, 128))
267 			goto err;
268 
269 		/* print the 'short name' of the field type */
270 		if (BIO_printf(bp, "Field Type: %s\n", OBJ_nid2sn(tmp_nid))
271 		    <= 0)
272 			goto err;
273 
274 		if (is_char_two) {
275 			/* print the 'short name' of the base type OID */
276 			int basis_type = EC_GROUP_get_basis_type(x);
277 			if (basis_type == 0)
278 				goto err;
279 
280 			if (!BIO_indent(bp, off, 128))
281 				goto err;
282 
283 			if (BIO_printf(bp, "Basis Type: %s\n",
284 				OBJ_nid2sn(basis_type)) <= 0)
285 				goto err;
286 
287 			/* print the polynomial */
288 			if ((p != NULL) && !ASN1_bn_print(bp, "Polynomial:", p, buffer,
289 				off))
290 				goto err;
291 		} else {
292 			if ((p != NULL) && !ASN1_bn_print(bp, "Prime:", p, buffer, off))
293 				goto err;
294 		}
295 		if ((a != NULL) && !ASN1_bn_print(bp, "A:   ", a, buffer, off))
296 			goto err;
297 		if ((b != NULL) && !ASN1_bn_print(bp, "B:   ", b, buffer, off))
298 			goto err;
299 		if (form == POINT_CONVERSION_COMPRESSED) {
300 			if ((gen != NULL) && !ASN1_bn_print(bp, gen_compressed, gen,
301 				buffer, off))
302 				goto err;
303 		} else if (form == POINT_CONVERSION_UNCOMPRESSED) {
304 			if ((gen != NULL) && !ASN1_bn_print(bp, gen_uncompressed, gen,
305 				buffer, off))
306 				goto err;
307 		} else {	/* form == POINT_CONVERSION_HYBRID */
308 			if ((gen != NULL) && !ASN1_bn_print(bp, gen_hybrid, gen,
309 				buffer, off))
310 				goto err;
311 		}
312 		if ((order != NULL) && !ASN1_bn_print(bp, "Order: ", order,
313 			buffer, off))
314 			goto err;
315 		if ((cofactor != NULL) && !ASN1_bn_print(bp, "Cofactor: ", cofactor,
316 			buffer, off))
317 			goto err;
318 		if (seed && !print_bin(bp, "Seed:", seed, seed_len, off))
319 			goto err;
320 	}
321 	ret = 1;
322  err:
323 	if (!ret)
324 		ECerror(reason);
325 	BN_free(p);
326 	BN_free(a);
327 	BN_free(b);
328 	BN_free(gen);
329 	BN_free(order);
330 	BN_free(cofactor);
331 	BN_CTX_free(ctx);
332 	free(buffer);
333 	return (ret);
334 }
335 
336 static int
337 print_bin(BIO *fp, const char *name, const unsigned char *buf,
338     size_t len, int off)
339 {
340 	size_t i;
341 	char str[128];
342 
343 	if (buf == NULL)
344 		return 1;
345 	if (off) {
346 		if (off > 128)
347 			off = 128;
348 		memset(str, ' ', off);
349 		if (BIO_write(fp, str, off) <= 0)
350 			return 0;
351 	}
352 	if (BIO_printf(fp, "%s", name) <= 0)
353 		return 0;
354 
355 	for (i = 0; i < len; i++) {
356 		if ((i % 15) == 0) {
357 			str[0] = '\n';
358 			memset(&(str[1]), ' ', off + 4);
359 			if (BIO_write(fp, str, off + 1 + 4) <= 0)
360 				return 0;
361 		}
362 		if (BIO_printf(fp, "%02x%s", buf[i], ((i + 1) == len) ? "" : ":") <= 0)
363 			return 0;
364 	}
365 	if (BIO_write(fp, "\n", 1) <= 0)
366 		return 0;
367 
368 	return 1;
369 }
370