1 /**********************************************************************
3 * Main file of GOST engine *
5 * Copyright (c) 2005-2006 Cryptocom LTD *
6 * Copyright (c) 2020 Chikunov Vitaly <vt@altlinux.org> *
8 * This file is distributed under the same license as OpenSSL *
10 **********************************************************************/
12 #include <openssl/crypto.h>
13 #include <openssl/err.h>
14 #include <openssl/evp.h>
15 #include <openssl/engine.h>
16 #include <openssl/obj_mac.h>
17 #include "e_gost_err.h"
20 #include "gost_grasshopper_cipher.h"
22 static const char* engine_gost_id = "gost";
24 static const char* engine_gost_name =
25 "Reference implementation of GOST engine";
27 /* Symmetric cipher and digest function registrar */
29 static int gost_ciphers(ENGINE* e, const EVP_CIPHER** cipher,
30 const int** nids, int nid);
32 static int gost_digests(ENGINE* e, const EVP_MD** digest,
33 const int** nids, int nid);
35 static int gost_pkey_meths(ENGINE* e, EVP_PKEY_METHOD** pmeth,
36 const int** nids, int nid);
38 static int gost_pkey_asn1_meths(ENGINE* e, EVP_PKEY_ASN1_METHOD** ameth,
39 const int** nids, int nid);
41 static EVP_PKEY_METHOD* pmeth_GostR3410_2001 = NULL,
42 * pmeth_GostR3410_2012_256 = NULL,
43 * pmeth_GostR3410_2012_512 = NULL,
44 * pmeth_Gost28147_MAC = NULL, * pmeth_Gost28147_MAC_12 = NULL,
45 * pmeth_magma_mac = NULL, * pmeth_grasshopper_mac = NULL,
46 * pmeth_magma_mac_acpkm = NULL, * pmeth_grasshopper_mac_acpkm = NULL;
48 static EVP_PKEY_ASN1_METHOD* ameth_GostR3410_2001 = NULL,
49 * ameth_GostR3410_2012_256 = NULL,
50 * ameth_GostR3410_2012_512 = NULL,
51 * ameth_Gost28147_MAC = NULL, * ameth_Gost28147_MAC_12 = NULL,
52 * ameth_magma_mac = NULL, * ameth_grasshopper_mac = NULL,
53 * ameth_magma_mac_acpkm = NULL, * ameth_grasshopper_mac_acpkm = NULL;
55 static struct gost_digest_minfo {
57 EVP_MD *(*digest)(void);
58 void (*destroy)(void);
61 } gost_digest_array[] = {
68 NID_id_Gost28147_89_MAC,
70 imit_gost_cpa_destroy,
73 NID_id_GostR3411_2012_256,
75 digest_gost2012_256_destroy,
76 SN_id_GostR3411_2012_256,
80 NID_id_GostR3411_2012_512,
82 digest_gost2012_512_destroy,
83 SN_id_GostR3411_2012_512,
89 imit_gost_cp_12_destroy,
99 grasshopper_omac_destroy,
102 NID_id_tc26_cipher_gostr3412_2015_kuznyechik_ctracpkm_omac,
103 grasshopper_omac_acpkm,
104 grasshopper_omac_acpkm_destroy,
109 static struct gost_cipher_minfo {
111 const EVP_CIPHER *(*cipher)(void);
112 } gost_cipher_array[] = {
123 cipher_gost_cpcnt_12,
131 cipher_gost_grasshopper_ecb,
135 cipher_gost_grasshopper_cbc,
139 cipher_gost_grasshopper_cfb,
143 cipher_gost_grasshopper_ofb,
147 cipher_gost_grasshopper_ctr,
158 NID_id_tc26_cipher_gostr3412_2015_kuznyechik_ctracpkm,
159 cipher_gost_grasshopper_ctracpkm,
164 static struct gost_meth_minfo {
166 EVP_PKEY_METHOD **pmeth;
167 EVP_PKEY_ASN1_METHOD **ameth;
170 } gost_meth_array[] = {
172 NID_id_GostR3410_2001,
173 &pmeth_GostR3410_2001,
174 &ameth_GostR3410_2001,
179 NID_id_Gost28147_89_MAC,
180 &pmeth_Gost28147_MAC,
181 &ameth_Gost28147_MAC,
186 NID_id_GostR3410_2012_256,
187 &pmeth_GostR3410_2012_256,
188 &ameth_GostR3410_2012_256,
190 "GOST R 34.10-2012 with 256 bit key",
193 NID_id_GostR3410_2012_512,
194 &pmeth_GostR3410_2012_512,
195 &ameth_GostR3410_2012_512,
197 "GOST R 34.10-2012 with 512 bit key",
201 &pmeth_Gost28147_MAC_12,
202 &ameth_Gost28147_MAC_12,
204 "GOST 28147-89 MAC with 2012 params",
211 "GOST R 34.13-2015 Magma MAC",
215 &pmeth_grasshopper_mac,
216 &ameth_grasshopper_mac,
218 "GOST R 34.13-2015 Grasshopper MAC",
221 NID_id_tc26_cipher_gostr3412_2015_magma_ctracpkm_omac,
222 &pmeth_magma_mac_acpkm,
223 &ameth_magma_mac_acpkm,
224 "ID-TC26-CIPHER-GOSTR3412-2015-MAGMA-CTRACPKM-OMAC",
225 "GOST R 34.13-2015 Magma MAC ACPKM",
228 NID_id_tc26_cipher_gostr3412_2015_kuznyechik_ctracpkm_omac,
229 &pmeth_grasshopper_mac_acpkm,
230 &ameth_grasshopper_mac_acpkm,
231 "ID-TC26-CIPHER-GOSTR3412-2015-KUZNYECHIK-CTRACPKM-OMAC",
232 "GOST R 34.13-2015 Grasshopper MAC ACPKM",
238 # define OSSL_NELEM(x) (sizeof(x)/sizeof((x)[0]))
241 /* `- 1' because of terminating zero element */
242 static int known_digest_nids[OSSL_NELEM(gost_digest_array) - 1];
243 static int known_cipher_nids[OSSL_NELEM(gost_cipher_array) - 1];
244 static int known_meths_nids[OSSL_NELEM(gost_meth_array) - 1];
246 static int gost_engine_init(ENGINE* e) {
250 static int gost_engine_finish(ENGINE* e) {
254 static int gost_engine_destroy(ENGINE* e) {
255 struct gost_digest_minfo *dinfo = gost_digest_array;
256 for (; dinfo->nid; dinfo++) {
258 EVP_delete_digest_alias(dinfo->alias);
262 cipher_gost_destroy();
263 cipher_gost_grasshopper_destroy();
267 struct gost_meth_minfo *minfo = gost_meth_array;
268 for (; minfo->nid; minfo++) {
269 *minfo->pmeth = NULL;
270 *minfo->ameth = NULL;
273 ERR_unload_GOST_strings();
278 static int bind_gost(ENGINE* e, const char* id) {
280 if (id != NULL && strcmp(id, engine_gost_id) != 0)
282 if (ameth_GostR3410_2001) {
283 printf("GOST engine already loaded\n");
286 if (!ENGINE_set_id(e, engine_gost_id)) {
287 printf("ENGINE_set_id failed\n");
290 if (!ENGINE_set_name(e, engine_gost_name)) {
291 printf("ENGINE_set_name failed\n");
294 if (!ENGINE_set_digests(e, gost_digests)) {
295 printf("ENGINE_set_digests failed\n");
298 if (!ENGINE_set_ciphers(e, gost_ciphers)) {
299 printf("ENGINE_set_ciphers failed\n");
302 if (!ENGINE_set_pkey_meths(e, gost_pkey_meths)) {
303 printf("ENGINE_set_pkey_meths failed\n");
306 if (!ENGINE_set_pkey_asn1_meths(e, gost_pkey_asn1_meths)) {
307 printf("ENGINE_set_pkey_asn1_meths failed\n");
310 /* Control function and commands */
311 if (!ENGINE_set_cmd_defns(e, gost_cmds)) {
312 fprintf(stderr, "ENGINE_set_cmd_defns failed\n");
315 if (!ENGINE_set_ctrl_function(e, gost_control_func)) {
316 fprintf(stderr, "ENGINE_set_ctrl_func failed\n");
319 if (!ENGINE_set_destroy_function(e, gost_engine_destroy)
320 || !ENGINE_set_init_function(e, gost_engine_init)
321 || !ENGINE_set_finish_function(e, gost_engine_finish)) {
325 struct gost_meth_minfo *minfo = gost_meth_array;
326 for (; minfo->nid; minfo++) {
328 /* This skip looks temporary. */
329 if (minfo->nid == NID_id_tc26_cipher_gostr3412_2015_magma_ctracpkm_omac)
332 if (!register_ameth_gost(minfo->nid, minfo->ameth, minfo->pemstr,
335 if (!register_pmeth_gost(minfo->nid, minfo->pmeth, 0))
339 if (!ENGINE_register_ciphers(e)
340 || !ENGINE_register_digests(e)
341 || !ENGINE_register_pkey_meths(e))
344 struct gost_cipher_minfo *cinfo = gost_cipher_array;
345 for (; cinfo->nid; cinfo++)
346 if (!EVP_add_cipher(cinfo->cipher()))
349 struct gost_digest_minfo *dinfo = gost_digest_array;
350 for (; dinfo->nid; dinfo++) {
351 if (!EVP_add_digest(dinfo->digest()))
354 !EVP_add_digest_alias(dinfo->sn, dinfo->alias))
358 ENGINE_register_all_complete();
360 ERR_load_GOST_strings();
366 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
367 IMPLEMENT_DYNAMIC_BIND_FN(bind_gost)
368 IMPLEMENT_DYNAMIC_CHECK_FN()
369 #endif /* ndef OPENSSL_NO_DYNAMIC_ENGINE */
371 /* ENGINE_DIGESTS_PTR callback installed by ENGINE_set_digests */
372 static int gost_digests(ENGINE *e, const EVP_MD **digest,
373 const int **nids, int nid)
375 struct gost_digest_minfo *info = gost_digest_array;
378 int *n = known_digest_nids;
381 for (; info->nid; info++)
383 return OSSL_NELEM(known_digest_nids);
386 for (; info->nid; info++)
387 if (nid == info->nid) {
388 *digest = info->digest();
395 /* ENGINE_CIPHERS_PTR callback installed by ENGINE_set_ciphers */
396 static int gost_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
397 const int **nids, int nid)
399 struct gost_cipher_minfo *info = gost_cipher_array;
402 int *n = known_cipher_nids;
405 for (; info->nid; info++)
407 return OSSL_NELEM(known_cipher_nids);
410 for (; info->nid; info++)
411 if (nid == info->nid) {
412 *cipher = info->cipher();
419 static int gost_meth_nids(const int **nids)
421 struct gost_meth_minfo *info = gost_meth_array;
422 int *n = known_meths_nids;
425 for (; info->nid; info++)
427 return OSSL_NELEM(known_meths_nids);
430 /* ENGINE_PKEY_METHS_PTR installed by ENGINE_set_pkey_meths */
431 static int gost_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
432 const int **nids, int nid)
434 struct gost_meth_minfo *info;
437 return gost_meth_nids(nids);
439 for (info = gost_meth_array; info->nid; info++)
440 if (nid == info->nid) {
441 *pmeth = *info->pmeth;
448 /* ENGINE_PKEY_ASN1_METHS_PTR installed by ENGINE_set_pkey_asn1_meths */
449 static int gost_pkey_asn1_meths(ENGINE *e, EVP_PKEY_ASN1_METHOD **ameth,
450 const int **nids, int nid)
452 struct gost_meth_minfo *info;
455 return gost_meth_nids(nids);
457 for (info = gost_meth_array; info->nid; info++)
458 if (nid == info->nid) {
459 *ameth = *info->ameth;
466 #ifdef OPENSSL_NO_DYNAMIC_ENGINE
468 static ENGINE* engine_gost(void) {
469 ENGINE* ret = ENGINE_new();
472 if (!bind_gost(ret, engine_gost_id)) {
479 void ENGINE_load_gost(void) {
481 if (pmeth_GostR3410_2001)
483 toadd = engine_gost();