1068b7b901d88d4da1e77e4642ef37381d960891
[oweals/openssl.git] / crypto / sm2 / sm2_pmeth.c
1 /*
2  * Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include "internal/cryptlib.h"
11 #include <openssl/asn1t.h>
12 #include <openssl/ec.h>
13 #include <openssl/evp.h>
14 #include "crypto/evp.h"
15 #include "crypto/sm2.h"
16 #include "crypto/sm2err.h"
17
18 /* EC pkey context structure */
19
20 typedef struct {
21     /* message digest */
22     const EVP_MD *md;
23     /* Distinguishing Identifier, ISO/IEC 15946-3 */
24     uint8_t *id;
25     size_t id_len;
26     /* id_set indicates if the 'id' field is set (1) or not (0) */
27     int id_set;
28 } SM2_PKEY_CTX;
29
30 static int pkey_sm2_init(EVP_PKEY_CTX *ctx)
31 {
32     SM2_PKEY_CTX *smctx;
33
34     if ((smctx = OPENSSL_zalloc(sizeof(*smctx))) == NULL) {
35         SM2err(SM2_F_PKEY_SM2_INIT, ERR_R_MALLOC_FAILURE);
36         return 0;
37     }
38
39     ctx->data = smctx;
40     return 1;
41 }
42
43 static void pkey_sm2_cleanup(EVP_PKEY_CTX *ctx)
44 {
45     SM2_PKEY_CTX *smctx = ctx->data;
46
47     if (smctx != NULL) {
48         OPENSSL_free(smctx->id);
49         OPENSSL_free(smctx);
50         ctx->data = NULL;
51     }
52 }
53
54 static int pkey_sm2_copy(EVP_PKEY_CTX *dst, const EVP_PKEY_CTX *src)
55 {
56     SM2_PKEY_CTX *dctx, *sctx;
57
58     if (!pkey_sm2_init(dst))
59         return 0;
60     sctx = src->data;
61     dctx = dst->data;
62     if (sctx->id != NULL) {
63         dctx->id = OPENSSL_malloc(sctx->id_len);
64         if (dctx->id == NULL) {
65             SM2err(SM2_F_PKEY_SM2_COPY, ERR_R_MALLOC_FAILURE);
66             pkey_sm2_cleanup(dst);
67             return 0;
68         }
69         memcpy(dctx->id, sctx->id, sctx->id_len);
70     }
71     dctx->id_len = sctx->id_len;
72     dctx->id_set = sctx->id_set;
73     dctx->md = sctx->md;
74
75     return 1;
76 }
77
78 static int pkey_sm2_sign(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
79                          const unsigned char *tbs, size_t tbslen)
80 {
81     int ret;
82     unsigned int sltmp;
83     EC_KEY *ec = ctx->pkey->pkey.ec;
84     const int sig_sz = ECDSA_size(ctx->pkey->pkey.ec);
85
86     if (sig_sz <= 0) {
87         return 0;
88     }
89
90     if (sig == NULL) {
91         *siglen = (size_t)sig_sz;
92         return 1;
93     }
94
95     if (*siglen < (size_t)sig_sz) {
96         SM2err(SM2_F_PKEY_SM2_SIGN, SM2_R_BUFFER_TOO_SMALL);
97         return 0;
98     }
99
100     ret = sm2_sign(tbs, tbslen, sig, &sltmp, ec);
101
102     if (ret <= 0)
103         return ret;
104     *siglen = (size_t)sltmp;
105     return 1;
106 }
107
108 static int pkey_sm2_verify(EVP_PKEY_CTX *ctx,
109                            const unsigned char *sig, size_t siglen,
110                            const unsigned char *tbs, size_t tbslen)
111 {
112     EC_KEY *ec = ctx->pkey->pkey.ec;
113
114     return sm2_verify(tbs, tbslen, sig, siglen, ec);
115 }
116
117 static int pkey_sm2_encrypt(EVP_PKEY_CTX *ctx,
118                             unsigned char *out, size_t *outlen,
119                             const unsigned char *in, size_t inlen)
120 {
121     EC_KEY *ec = ctx->pkey->pkey.ec;
122     SM2_PKEY_CTX *dctx = ctx->data;
123     const EVP_MD *md = (dctx->md == NULL) ? EVP_sm3() : dctx->md;
124
125     if (out == NULL) {
126         if (!sm2_ciphertext_size(ec, md, inlen, outlen))
127             return -1;
128         else
129             return 1;
130     }
131
132     return sm2_encrypt(ec, md, in, inlen, out, outlen);
133 }
134
135 static int pkey_sm2_decrypt(EVP_PKEY_CTX *ctx,
136                             unsigned char *out, size_t *outlen,
137                             const unsigned char *in, size_t inlen)
138 {
139     EC_KEY *ec = ctx->pkey->pkey.ec;
140     SM2_PKEY_CTX *dctx = ctx->data;
141     const EVP_MD *md = (dctx->md == NULL) ? EVP_sm3() : dctx->md;
142
143     if (out == NULL) {
144         if (!sm2_plaintext_size(ec, md, inlen, outlen))
145             return -1;
146         else
147             return 1;
148     }
149
150     return sm2_decrypt(ec, md, in, inlen, out, outlen);
151 }
152
153 static int pkey_sm2_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
154 {
155     SM2_PKEY_CTX *smctx = ctx->data;
156     uint8_t *tmp_id;
157
158     switch (type) {
159     case EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID:
160         /*
161          * This control could be removed, which would signal it being
162          * unsupported.  However, that means that when the caller uses
163          * the correct curve, it may interpret the unsupported signal
164          * as an error, so it's better to accept the control, check the
165          * value and return a corresponding value.
166          */
167         if (p1 != NID_sm2) {
168             SM2err(SM2_F_PKEY_SM2_CTRL, SM2_R_INVALID_CURVE);
169             return 0;
170         }
171         return 1;
172
173     case EVP_PKEY_CTRL_MD:
174         smctx->md = p2;
175         return 1;
176
177     case EVP_PKEY_CTRL_GET_MD:
178         *(const EVP_MD **)p2 = smctx->md;
179         return 1;
180
181     case EVP_PKEY_CTRL_SET1_ID:
182         if (p1 > 0) {
183             tmp_id = OPENSSL_malloc(p1);
184             if (tmp_id == NULL) {
185                 SM2err(SM2_F_PKEY_SM2_CTRL, ERR_R_MALLOC_FAILURE);
186                 return 0;
187             }
188             memcpy(tmp_id, p2, p1);
189             OPENSSL_free(smctx->id);
190             smctx->id = tmp_id;
191         } else {
192             /* set null-ID */
193             OPENSSL_free(smctx->id);
194             smctx->id = NULL;
195         }
196         smctx->id_len = (size_t)p1;
197         smctx->id_set = 1;
198         return 1;
199
200     case EVP_PKEY_CTRL_GET1_ID:
201         memcpy(p2, smctx->id, smctx->id_len);
202         return 1;
203
204     case EVP_PKEY_CTRL_GET1_ID_LEN:
205         *(size_t *)p2 = smctx->id_len;
206         return 1;
207
208     case EVP_PKEY_CTRL_DIGESTINIT:
209         /* nothing to be inited, this is to suppress the error... */
210         return 1;
211
212     default:
213         return -2;
214     }
215 }
216
217 static int pkey_sm2_ctrl_str(EVP_PKEY_CTX *ctx,
218                              const char *type, const char *value)
219 {
220     uint8_t *hex_id;
221     long hex_len = 0;
222     int ret = 0;
223
224     if (strcmp(type, "ec_paramgen_curve") == 0) {
225         int nid = NID_undef;
226
227         if (((nid = EC_curve_nist2nid(value)) == NID_undef)
228             && ((nid = OBJ_sn2nid(value)) == NID_undef)
229             && ((nid = OBJ_ln2nid(value)) == NID_undef)) {
230             SM2err(SM2_F_PKEY_SM2_CTRL_STR, SM2_R_INVALID_CURVE);
231             return 0;
232         }
233         return EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid);
234     } else if (strcmp(type, "ec_param_enc") == 0) {
235         int param_enc;
236
237         if (strcmp(value, "explicit") == 0)
238             param_enc = 0;
239         else if (strcmp(value, "named_curve") == 0)
240             param_enc = OPENSSL_EC_NAMED_CURVE;
241         else
242             return -2;
243         return EVP_PKEY_CTX_set_ec_param_enc(ctx, param_enc);
244     } else if (strcmp(type, "sm2_id") == 0) {
245         return pkey_sm2_ctrl(ctx, EVP_PKEY_CTRL_SET1_ID,
246                              (int)strlen(value), (void *)value);
247     } else if (strcmp(type, "sm2_hex_id") == 0) {
248         /*
249          * TODO(3.0): reconsider the name "sm2_hex_id", OR change
250          * OSSL_PARAM_construct_from_text() / OSSL_PARAM_allocate_from_text()
251          * to handle infix "_hex_"
252          */
253         hex_id = OPENSSL_hexstr2buf((const char *)value, &hex_len);
254         if (hex_id == NULL) {
255             SM2err(SM2_F_PKEY_SM2_CTRL_STR, ERR_R_PASSED_INVALID_ARGUMENT);
256             return 0;
257         }
258         ret = pkey_sm2_ctrl(ctx, EVP_PKEY_CTRL_SET1_ID, (int)hex_len,
259                             (void *)hex_id);
260         OPENSSL_free(hex_id);
261         return ret;
262     }
263
264     return -2;
265 }
266
267 static int pkey_sm2_digest_custom(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
268 {
269     uint8_t z[EVP_MAX_MD_SIZE];
270     SM2_PKEY_CTX *smctx = ctx->data;
271     EC_KEY *ec = ctx->pkey->pkey.ec;
272     const EVP_MD *md = EVP_MD_CTX_md(mctx);
273     int mdlen = EVP_MD_size(md);
274
275     if (!smctx->id_set) {
276         /*
277          * An ID value must be set. The specifications are not clear whether a
278          * NULL is allowed. We only allow it if set explicitly for maximum
279          * flexibility.
280          */
281         SM2err(SM2_F_PKEY_SM2_DIGEST_CUSTOM, SM2_R_ID_NOT_SET);
282         return 0;
283     }
284
285     if (mdlen < 0) {
286         SM2err(SM2_F_PKEY_SM2_DIGEST_CUSTOM, SM2_R_INVALID_DIGEST);
287         return 0;
288     }
289
290     /* get hashed prefix 'z' of tbs message */
291     if (!sm2_compute_z_digest(z, md, smctx->id, smctx->id_len, ec))
292         return 0;
293
294     return EVP_DigestUpdate(mctx, z, (size_t)mdlen);
295 }
296
297 static int pkey_sm2_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
298 {
299     EC_KEY *ec = NULL;
300     int ret;
301
302     ec = EC_KEY_new_by_curve_name(NID_sm2);
303     if (ec == NULL)
304         return 0;
305     if (!ossl_assert(ret = EVP_PKEY_assign_EC_KEY(pkey, ec)))
306         EC_KEY_free(ec);
307     return ret;
308 }
309
310 static int pkey_sm2_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
311 {
312     EC_KEY *ec = NULL;
313
314     ec = EC_KEY_new_by_curve_name(NID_sm2);
315     if (ec == NULL)
316         return 0;
317     if (!ossl_assert(EVP_PKEY_assign_EC_KEY(pkey, ec))) {
318         EC_KEY_free(ec);
319         return 0;
320     }
321     /* Note: if error is returned, we count on caller to free pkey->pkey.ec */
322     if (ctx->pkey != NULL
323         && !EVP_PKEY_copy_parameters(pkey, ctx->pkey))
324         return 0;
325
326     return EC_KEY_generate_key(ec);
327 }
328
329 static const EVP_PKEY_METHOD sm2_pkey_meth = {
330     EVP_PKEY_SM2,
331     0,
332     pkey_sm2_init,
333     pkey_sm2_copy,
334     pkey_sm2_cleanup,
335
336     0,
337     pkey_sm2_paramgen,
338
339     0,
340     pkey_sm2_keygen,
341
342     0,
343     pkey_sm2_sign,
344
345     0,
346     pkey_sm2_verify,
347
348     0, 0,
349
350     0, 0, 0, 0,
351
352     0,
353     pkey_sm2_encrypt,
354
355     0,
356     pkey_sm2_decrypt,
357
358     0,
359     0,
360     pkey_sm2_ctrl,
361     pkey_sm2_ctrl_str,
362
363     0, 0,
364
365     0, 0, 0,
366
367     pkey_sm2_digest_custom
368 };
369
370 const EVP_PKEY_METHOD *sm2_pkey_method(void)
371 {
372     return &sm2_pkey_meth;
373 }