ecp_nistp256.c: Fix exponent in comment
[openssl.git] / crypto / ec / eck_prn.c
1 /*
2  * Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4  *
5  * Licensed under the Apache License 2.0 (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  */
10
11 #include "internal/deprecated.h"
12
13 #include <stdio.h>
14 #include "internal/cryptlib.h"
15 #include <openssl/evp.h>
16 #include <openssl/ec.h>
17 #include <openssl/bn.h>
18
19 #ifndef OPENSSL_NO_DEPRECATED_3_0
20 # ifndef OPENSSL_NO_STDIO
21 int ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off)
22 {
23     BIO *b;
24     int ret;
25
26     if ((b = BIO_new(BIO_s_file())) == NULL) {
27         ERR_raise(ERR_LIB_EC, ERR_R_BUF_LIB);
28         return 0;
29     }
30     BIO_set_fp(b, fp, BIO_NOCLOSE);
31     ret = ECPKParameters_print(b, x, off);
32     BIO_free(b);
33     return ret;
34 }
35
36 int EC_KEY_print_fp(FILE *fp, const EC_KEY *x, int off)
37 {
38     BIO *b;
39     int ret;
40
41     if ((b = BIO_new(BIO_s_file())) == NULL) {
42         ERR_raise(ERR_LIB_EC, ERR_R_BIO_LIB);
43         return 0;
44     }
45     BIO_set_fp(b, fp, BIO_NOCLOSE);
46     ret = EC_KEY_print(b, x, off);
47     BIO_free(b);
48     return ret;
49 }
50
51 int ECParameters_print_fp(FILE *fp, const EC_KEY *x)
52 {
53     BIO *b;
54     int ret;
55
56     if ((b = BIO_new(BIO_s_file())) == NULL) {
57         ERR_raise(ERR_LIB_EC, ERR_R_BIO_LIB);
58         return 0;
59     }
60     BIO_set_fp(b, fp, BIO_NOCLOSE);
61     ret = ECParameters_print(b, x);
62     BIO_free(b);
63     return ret;
64 }
65 #endif /* OPENSSL_NO_STDIO */
66
67 static int print_bin(BIO *fp, const char *str, const unsigned char *num,
68                      size_t len, int off);
69
70 int ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off)
71 {
72     int ret = 0, reason = ERR_R_BIO_LIB;
73     BN_CTX *ctx = NULL;
74     const EC_POINT *point = NULL;
75     BIGNUM *p = NULL, *a = NULL, *b = NULL;
76     unsigned char *gen_buf = NULL;
77     const BIGNUM *order = NULL, *cofactor = NULL;
78     const unsigned char *seed;
79     size_t seed_len = 0, gen_buf_len = 0;
80
81     static const char *gen_compressed = "Generator (compressed):";
82     static const char *gen_uncompressed = "Generator (uncompressed):";
83     static const char *gen_hybrid = "Generator (hybrid):";
84
85     if (!x) {
86         reason = ERR_R_PASSED_NULL_PARAMETER;
87         goto err;
88     }
89
90     ctx = BN_CTX_new();
91     if (ctx == NULL) {
92         reason = ERR_R_BN_LIB;
93         goto err;
94     }
95
96     if (EC_GROUP_get_asn1_flag(x)) {
97         /* the curve parameter are given by an asn1 OID */
98         int nid;
99         const char *nname;
100
101         if (!BIO_indent(bp, off, 128))
102             goto err;
103
104         nid = EC_GROUP_get_curve_name(x);
105         if (nid == 0)
106             goto err;
107         if (BIO_printf(bp, "ASN1 OID: %s", OBJ_nid2sn(nid)) <= 0)
108             goto err;
109         if (BIO_printf(bp, "\n") <= 0)
110             goto err;
111         nname = EC_curve_nid2nist(nid);
112         if (nname) {
113             if (!BIO_indent(bp, off, 128))
114                 goto err;
115             if (BIO_printf(bp, "NIST CURVE: %s\n", nname) <= 0)
116                 goto err;
117         }
118     } else {
119         const char *form_str;
120         /* explicit parameters */
121         int is_char_two = 0;
122         point_conversion_form_t form;
123         int tmp_nid = EC_GROUP_get_field_type(x);
124
125         if (tmp_nid == NID_X9_62_characteristic_two_field)
126             is_char_two = 1;
127
128         if ((p = BN_new()) == NULL || (a = BN_new()) == NULL ||
129             (b = BN_new()) == NULL) {
130             reason = ERR_R_BN_LIB;
131             goto err;
132         }
133
134         if (!EC_GROUP_get_curve(x, p, a, b, ctx)) {
135             reason = ERR_R_EC_LIB;
136             goto err;
137         }
138
139         if ((point = EC_GROUP_get0_generator(x)) == NULL) {
140             reason = ERR_R_EC_LIB;
141             goto err;
142         }
143         order = EC_GROUP_get0_order(x);
144         cofactor = EC_GROUP_get0_cofactor(x);
145         if (order == NULL) {
146             reason = ERR_R_EC_LIB;
147             goto err;
148         }
149
150         form = EC_GROUP_get_point_conversion_form(x);
151
152         gen_buf_len = EC_POINT_point2buf(x, point, form, &gen_buf, ctx);
153         if (gen_buf_len == 0) {
154             reason = ERR_R_EC_LIB;
155             goto err;
156         }
157
158         if ((seed = EC_GROUP_get0_seed(x)) != NULL)
159             seed_len = EC_GROUP_get_seed_len(x);
160
161         if (!BIO_indent(bp, off, 128))
162             goto err;
163
164         /* print the 'short name' of the field type */
165         if (BIO_printf(bp, "Field Type: %s\n", OBJ_nid2sn(tmp_nid))
166             <= 0)
167             goto err;
168
169         if (is_char_two) {
170             /* print the 'short name' of the base type OID */
171             int basis_type = EC_GROUP_get_basis_type(x);
172             if (basis_type == 0)
173                 goto err;
174
175             if (!BIO_indent(bp, off, 128))
176                 goto err;
177
178             if (BIO_printf(bp, "Basis Type: %s\n",
179                            OBJ_nid2sn(basis_type)) <= 0)
180                 goto err;
181
182             /* print the polynomial */
183             if ((p != NULL) && !ASN1_bn_print(bp, "Polynomial:", p, NULL,
184                                               off))
185                 goto err;
186         } else {
187             if ((p != NULL) && !ASN1_bn_print(bp, "Prime:", p, NULL, off))
188                 goto err;
189         }
190         if ((a != NULL) && !ASN1_bn_print(bp, "A:   ", a, NULL, off))
191             goto err;
192         if ((b != NULL) && !ASN1_bn_print(bp, "B:   ", b, NULL, off))
193             goto err;
194
195         if (form == POINT_CONVERSION_COMPRESSED)
196             form_str = gen_compressed;
197         else if (form == POINT_CONVERSION_UNCOMPRESSED)
198             form_str = gen_uncompressed;
199         else
200             form_str = gen_hybrid;
201         if (gen_buf != NULL
202             && !print_bin(bp, form_str, gen_buf, gen_buf_len, off))
203             goto err;
204
205         if ((order != NULL) && !ASN1_bn_print(bp, "Order: ", order, NULL, off))
206             goto err;
207         if ((cofactor != NULL) && !ASN1_bn_print(bp, "Cofactor: ", cofactor,
208                                                  NULL, off))
209             goto err;
210         if (seed && !print_bin(bp, "Seed:", seed, seed_len, off))
211             goto err;
212     }
213     ret = 1;
214  err:
215     if (!ret)
216         ERR_raise(ERR_LIB_EC, reason);
217     BN_free(p);
218     BN_free(a);
219     BN_free(b);
220     OPENSSL_clear_free(gen_buf, gen_buf_len);
221     BN_CTX_free(ctx);
222     return ret;
223 }
224
225 static int print_bin(BIO *fp, const char *name, const unsigned char *buf,
226                      size_t len, int off)
227 {
228     size_t i;
229     char str[128 + 1 + 4];
230
231     if (buf == NULL)
232         return 1;
233     if (off > 0) {
234         if (off > 128)
235             off = 128;
236         memset(str, ' ', off);
237         if (BIO_write(fp, str, off) <= 0)
238             return 0;
239     } else {
240         off = 0;
241     }
242
243     if (BIO_printf(fp, "%s", name) <= 0)
244         return 0;
245
246     for (i = 0; i < len; i++) {
247         if ((i % 15) == 0) {
248             str[0] = '\n';
249             memset(&(str[1]), ' ', off + 4);
250             if (BIO_write(fp, str, off + 1 + 4) <= 0)
251                 return 0;
252         }
253         if (BIO_printf(fp, "%02x%s", buf[i], ((i + 1) == len) ? "" : ":") <=
254             0)
255             return 0;
256     }
257     if (BIO_write(fp, "\n", 1) <= 0)
258         return 0;
259
260     return 1;
261 }
262 #endif /* OPENSSL_NO_DEPRECATED_3_0 */