gost_eng.c

/**********************************************************************
 *                          gost_eng.c                                *
 *             Copyright (c) 2005-2006 Cryptocom LTD                  *
 *         This file is distributed under the same license as OpenSSL *
 *                                                                    *
 *              Main file of GOST engine                              *
 *       for OpenSSL                                                  *
 *          Requires OpenSSL 0.9.9 for compilation                    *
 **********************************************************************/
#include <string.h>
#include <openssl/crypto.h>
#include <openssl/err.h>
#include <openssl/evp.h>
#include <openssl/engine.h>
#include <openssl/obj_mac.h>
#include "e_gost_err.h"
#include "gost_lcl.h"

#include "gost_grasshopper_cipher.h"

static const char* engine_gost_id = "gost";

static const char* engine_gost_name =
        "Reference implementation of GOST engine";

/* Symmetric cipher and digest function registrar */

static int gost_ciphers(ENGINE* e, const EVP_CIPHER** cipher,
                        const int** nids, int nid);

static int gost_digests(ENGINE* e, const EVP_MD** digest,
                        const int** nids, int ind);

static int gost_pkey_meths(ENGINE* e, EVP_PKEY_METHOD** pmeth,
                           const int** nids, int nid);

static int gost_pkey_asn1_meths(ENGINE* e, EVP_PKEY_ASN1_METHOD** ameth,
                                const int** nids, int nid);

static int gost_cipher_nids[] = {
        NID_id_Gost28147_89,
        NID_gost89_cnt,
        NID_gost89_cnt_12,
        NID_gost89_cbc,
        NID_grasshopper_ecb,
        NID_grasshopper_cbc,
        NID_grasshopper_cfb,
        NID_grasshopper_ofb,
        NID_grasshopper_ctr,
        NID_magma_cbc,
        NID_magma_ctr,
        NID_id_tc26_cipher_gostr3412_2015_kuznyechik_ctracpkm,
        0
};

static int gost_digest_nids(const int** nids) {
    static int digest_nids[8] = {0, 0, 0, 0, 0, 0, 0, 0};
    static int pos = 0;
    static int init = 0;

    if (!init) {
        const EVP_MD* md;
        if ((md = digest_gost()) != NULL)
            digest_nids[pos++] = EVP_MD_type(md);
        if ((md = imit_gost_cpa()) != NULL)
            digest_nids[pos++] = EVP_MD_type(md);
        if ((md = digest_gost2012_256()) != NULL)
            digest_nids[pos++] = EVP_MD_type(md);
        if ((md = digest_gost2012_512()) != NULL)
            digest_nids[pos++] = EVP_MD_type(md);
        if ((md = imit_gost_cp_12()) != NULL)
            digest_nids[pos++] = EVP_MD_type(md);
        if ((md = magma_omac()) != NULL)
            digest_nids[pos++] = EVP_MD_type(md);
        if ((md = grasshopper_omac()) != NULL)
            digest_nids[pos++] = EVP_MD_type(md);


        digest_nids[pos] = 0;
        init = 1;
    }
    *nids = digest_nids;
    return pos;
}

static int gost_pkey_meth_nids[] = {
        NID_id_GostR3410_2001,
        NID_id_Gost28147_89_MAC,
        NID_id_GostR3410_2012_256,
        NID_id_GostR3410_2012_512,
        NID_gost_mac_12,
        NID_magma_mac,
        NID_grasshopper_mac,
        0
};

static EVP_PKEY_METHOD* pmeth_GostR3410_2001 = NULL,
        * pmeth_GostR3410_2012_256 = NULL,
        * pmeth_GostR3410_2012_512 = NULL,
        * pmeth_Gost28147_MAC = NULL, * pmeth_Gost28147_MAC_12 = NULL,
        * pmeth_magma_mac = NULL,  * pmeth_grasshopper_mac = NULL;

static EVP_PKEY_ASN1_METHOD* ameth_GostR3410_2001 = NULL,
        * ameth_GostR3410_2012_256 = NULL,
        * ameth_GostR3410_2012_512 = NULL,
        * ameth_Gost28147_MAC = NULL, * ameth_Gost28147_MAC_12 = NULL,
        * ameth_magma_mac = NULL,  * ameth_grasshopper_mac = NULL;

static int gost_engine_init(ENGINE* e) {
    return 1;
}

static int gost_engine_finish(ENGINE* e) {
    return 1;
}

static int gost_engine_destroy(ENGINE* e) {
    digest_gost_destroy();
    digest_gost2012_256_destroy();
    digest_gost2012_512_destroy();

    imit_gost_cpa_destroy();
    imit_gost_cp_12_destroy();
    magma_omac_destroy();
    grasshopper_omac_destroy();
    grasshopper_omac_acpkm_destroy();

    cipher_gost_destroy();
    cipher_gost_grasshopper_destroy();

    gost_param_free();

    pmeth_GostR3410_2001 = NULL;
    pmeth_Gost28147_MAC = NULL;
    pmeth_GostR3410_2012_256 = NULL;
    pmeth_GostR3410_2012_512 = NULL;
    pmeth_Gost28147_MAC_12 = NULL;
    pmeth_magma_mac = NULL;
    pmeth_grasshopper_mac = NULL;

    ameth_GostR3410_2001 = NULL;
    ameth_Gost28147_MAC = NULL;
    ameth_GostR3410_2012_256 = NULL;
    ameth_GostR3410_2012_512 = NULL;
    ameth_Gost28147_MAC_12 = NULL;
    ameth_magma_mac = NULL;
    ameth_grasshopper_mac = NULL;

	ERR_unload_GOST_strings();
	
    return 1;
}

static int bind_gost(ENGINE* e, const char* id) {
    int ret = 0;
    if (id != NULL && strcmp(id, engine_gost_id) != 0)
        return 0;
    if (ameth_GostR3410_2001) {
        printf("GOST engine already loaded\n");
        goto end;
    }
    if (!ENGINE_set_id(e, engine_gost_id)) {
        printf("ENGINE_set_id failed\n");
        goto end;
    }
    if (!ENGINE_set_name(e, engine_gost_name)) {
        printf("ENGINE_set_name failed\n");
        goto end;
    }
    if (!ENGINE_set_digests(e, gost_digests)) {
        printf("ENGINE_set_digests failed\n");
        goto end;
    }
    if (!ENGINE_set_ciphers(e, gost_ciphers)) {
        printf("ENGINE_set_ciphers failed\n");
        goto end;
    }
    if (!ENGINE_set_pkey_meths(e, gost_pkey_meths)) {
        printf("ENGINE_set_pkey_meths failed\n");
        goto end;
    }
    if (!ENGINE_set_pkey_asn1_meths(e, gost_pkey_asn1_meths)) {
        printf("ENGINE_set_pkey_asn1_meths failed\n");
        goto end;
    }
    /* Control function and commands */
    if (!ENGINE_set_cmd_defns(e, gost_cmds)) {
        fprintf(stderr, "ENGINE_set_cmd_defns failed\n");
        goto end;
    }
    if (!ENGINE_set_ctrl_function(e, gost_control_func)) {
        fprintf(stderr, "ENGINE_set_ctrl_func failed\n");
        goto end;
    }
    if (!ENGINE_set_destroy_function(e, gost_engine_destroy)
        || !ENGINE_set_init_function(e, gost_engine_init)
        || !ENGINE_set_finish_function(e, gost_engine_finish)) {
        goto end;
    }

    if (!register_ameth_gost
            (NID_id_GostR3410_2001, &ameth_GostR3410_2001, "GOST2001",
             "GOST R 34.10-2001"))
        goto end;
    if (!register_ameth_gost
            (NID_id_GostR3410_2012_256, &ameth_GostR3410_2012_256, "GOST2012_256",
             "GOST R 34.10-2012 with 256 bit key"))
        goto end;
    if (!register_ameth_gost
            (NID_id_GostR3410_2012_512, &ameth_GostR3410_2012_512, "GOST2012_512",
             "GOST R 34.10-2012 with 512 bit key"))
        goto end;
    if (!register_ameth_gost(NID_id_Gost28147_89_MAC, &ameth_Gost28147_MAC,
                             "GOST-MAC", "GOST 28147-89 MAC"))
        goto end;
    if (!register_ameth_gost(NID_gost_mac_12, &ameth_Gost28147_MAC_12,
                             "GOST-MAC-12",
                             "GOST 28147-89 MAC with 2012 params"))
        goto end;
    if (!register_ameth_gost(NID_magma_mac, &ameth_magma_mac,
                             "MAGMA-MAC", "GOST R 34.13-2015 Magma MAC"))
        goto end;
    if (!register_ameth_gost(NID_grasshopper_mac, &ameth_grasshopper_mac,
                             "GRASSHOPPER-MAC", "GOST R 34.13-2015 Grasshopper MAC"))
        goto end;

    if (!register_pmeth_gost(NID_id_GostR3410_2001, &pmeth_GostR3410_2001, 0))
        goto end;

    if (!register_pmeth_gost
            (NID_id_GostR3410_2012_256, &pmeth_GostR3410_2012_256, 0))
        goto end;
    if (!register_pmeth_gost
            (NID_id_GostR3410_2012_512, &pmeth_GostR3410_2012_512, 0))
        goto end;
    if (!register_pmeth_gost
            (NID_id_Gost28147_89_MAC, &pmeth_Gost28147_MAC, 0))
        goto end;
    if (!register_pmeth_gost(NID_gost_mac_12, &pmeth_Gost28147_MAC_12, 0))
        goto end;
    if (!register_pmeth_gost(NID_magma_mac, &pmeth_magma_mac, 0))
        goto end;
    if (!register_pmeth_gost(NID_grasshopper_mac, &pmeth_grasshopper_mac, 0))
        goto end;
    if (!ENGINE_register_ciphers(e)
        || !ENGINE_register_digests(e)
        || !ENGINE_register_pkey_meths(e)
        /* These two actually should go in LIST_ADD command */
        || !EVP_add_cipher(cipher_gost())
        || !EVP_add_cipher(cipher_gost_cbc())
        || !EVP_add_cipher(cipher_gost_cpacnt())
        || !EVP_add_cipher(cipher_gost_cpcnt_12())
        || !EVP_add_cipher(cipher_gost_grasshopper_ecb())
        || !EVP_add_cipher(cipher_gost_grasshopper_cbc())
        || !EVP_add_cipher(cipher_gost_grasshopper_cfb())
        || !EVP_add_cipher(cipher_gost_grasshopper_ofb())
        || !EVP_add_cipher(cipher_gost_grasshopper_ctr())
        || !EVP_add_cipher(cipher_gost_grasshopper_ctracpkm())
        || !EVP_add_cipher(cipher_magma_cbc())
        || !EVP_add_cipher(cipher_magma_ctr())
        || !EVP_add_digest(digest_gost())
        || !EVP_add_digest(digest_gost2012_512())
        || !EVP_add_digest(digest_gost2012_256())
        || !EVP_add_digest(imit_gost_cpa())
        || !EVP_add_digest(imit_gost_cp_12())
        || !EVP_add_digest(magma_omac())
        || !EVP_add_digest(grasshopper_omac())
            ) {
        goto end;
    }

    ENGINE_register_all_complete();

    ERR_load_GOST_strings();
    ret = 1;
    end:
    return ret;
}

#ifndef OPENSSL_NO_DYNAMIC_ENGINE
IMPLEMENT_DYNAMIC_BIND_FN(bind_gost)
    IMPLEMENT_DYNAMIC_CHECK_FN()
#endif                          /* ndef OPENSSL_NO_DYNAMIC_ENGINE */

static int gost_digests(ENGINE* e, const EVP_MD** digest,
                        const int** nids, int nid) {
    int ok = 1;
    if (digest == NULL) {
        return gost_digest_nids(nids);
    }
    if (nid == NID_id_GostR3411_94) {
        *digest = digest_gost();
    } else if (nid == NID_id_Gost28147_89_MAC) {
        *digest = imit_gost_cpa();
    } else if (nid == NID_id_GostR3411_2012_256) {
        *digest = digest_gost2012_256();
    } else if (nid == NID_id_GostR3411_2012_512) {
        *digest = digest_gost2012_512();
    } else if (nid == NID_gost_mac_12) {
        *digest = imit_gost_cp_12();
    } else if (nid == NID_magma_mac) {
        *digest = magma_omac();
    } else if (nid == NID_grasshopper_mac) {
        *digest = grasshopper_omac();
    } else if (nid == NID_id_tc26_cipher_gostr3412_2015_kuznyechik_ctracpkm_omac) {
        *digest = grasshopper_omac_acpkm();
    } else {
        ok = 0;
        *digest = NULL;
    }
    return ok;
}

static int gost_ciphers(ENGINE* e, const EVP_CIPHER** cipher,
                        const int** nids, int nid) {
    int ok = 1;
    if (cipher == NULL) {
        *nids = gost_cipher_nids;
        return sizeof(gost_cipher_nids) / sizeof(gost_cipher_nids[0]) - 1;
    }

    if (nid == NID_id_Gost28147_89) {
        *cipher = cipher_gost();
    } else if (nid == NID_gost89_cnt) {
        *cipher = cipher_gost_cpacnt();
    } else if (nid == NID_gost89_cnt_12) {
        *cipher = cipher_gost_cpcnt_12();
    } else if (nid == NID_gost89_cbc) {
        *cipher = cipher_gost_cbc();
    } else if (nid == NID_grasshopper_ecb) {
        *cipher = cipher_gost_grasshopper_ecb();
    } else if (nid == NID_grasshopper_cbc) {
        *cipher = cipher_gost_grasshopper_cbc();
    } else if (nid == NID_grasshopper_cfb) {
        *cipher = cipher_gost_grasshopper_cfb();
    } else if (nid == NID_grasshopper_ofb) {
        *cipher = cipher_gost_grasshopper_ofb();
    } else if (nid == NID_grasshopper_ctr) {
        *cipher = cipher_gost_grasshopper_ctr();
    } else if (nid == NID_id_tc26_cipher_gostr3412_2015_kuznyechik_ctracpkm) {
        *cipher = cipher_gost_grasshopper_ctracpkm();
    } else if (nid == NID_magma_cbc) {
        *cipher = cipher_magma_cbc();
    } else if (nid == NID_magma_ctr) {
        *cipher = cipher_magma_ctr();
    } else {
        ok = 0;
        *cipher = NULL;
    }
    return ok;
}

static int gost_pkey_meths(ENGINE* e, EVP_PKEY_METHOD** pmeth,
                           const int** nids, int nid) {
    if (pmeth == NULL) {
        *nids = gost_pkey_meth_nids;
        return sizeof(gost_pkey_meth_nids) / sizeof(gost_pkey_meth_nids[0]) - 1;
    }

    switch (nid) {
        case NID_id_GostR3410_2001:
            *pmeth = pmeth_GostR3410_2001;
            return 1;
        case NID_id_GostR3410_2012_256:
            *pmeth = pmeth_GostR3410_2012_256;
            return 1;
        case NID_id_GostR3410_2012_512:
            *pmeth = pmeth_GostR3410_2012_512;
            return 1;
        case NID_id_Gost28147_89_MAC:
            *pmeth = pmeth_Gost28147_MAC;
            return 1;
        case NID_gost_mac_12:
            *pmeth = pmeth_Gost28147_MAC_12;
            return 1;
        case NID_magma_mac:
            *pmeth = pmeth_magma_mac;
            return 1;
        case NID_grasshopper_mac:
            *pmeth = pmeth_grasshopper_mac;
            return 1;

        default:;
    }

    *pmeth = NULL;
    return 0;
}

static int gost_pkey_asn1_meths(ENGINE* e, EVP_PKEY_ASN1_METHOD** ameth,
                                const int** nids, int nid) {
    if (ameth == NULL) {
        *nids = gost_pkey_meth_nids;
        return sizeof(gost_pkey_meth_nids) / sizeof(gost_pkey_meth_nids[0]) - 1;
    }

    switch (nid) {
        case NID_id_GostR3410_2001:
            *ameth = ameth_GostR3410_2001;
            return 1;
        case NID_id_GostR3410_2012_256:
            *ameth = ameth_GostR3410_2012_256;
            return 1;
        case NID_id_GostR3410_2012_512:
            *ameth = ameth_GostR3410_2012_512;
            return 1;
        case NID_id_Gost28147_89_MAC:
            *ameth = ameth_Gost28147_MAC;
            return 1;
        case NID_gost_mac_12:
            *ameth = ameth_Gost28147_MAC_12;
            return 1;
        case NID_magma_mac:
            *ameth = ameth_magma_mac;
            return 1;
        case NID_grasshopper_mac:
            *ameth = ameth_grasshopper_mac;
            return 1;

        default:;
    }

    *ameth = NULL;
    return 0;
}

#ifdef OPENSSL_NO_DYNAMIC_ENGINE

static ENGINE* engine_gost(void) {
    ENGINE* ret = ENGINE_new();
    if (!ret)
        return NULL;
    if (!bind_gost(ret, engine_gost_id)) {
        ENGINE_free(ret);
        return NULL;
    }
    return ret;
}

void ENGINE_load_gost(void) {
    ENGINE* toadd;
    if (pmeth_GostR3410_2001)
        return;
    toadd = engine_gost();
    if (!toadd)
        return;
    ENGINE_add(toadd);
    ENGINE_free(toadd);
    ERR_clear_error();
}

#endif