openssl/providers/implementations/encode_decode/encoder_ec_priv.c

/*
 * Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <openssl/core_dispatch.h>
#include <openssl/core_names.h>
#include <openssl/err.h>
#include <openssl/pem.h>
#include <openssl/ec.h>
#include <openssl/types.h>
#include <openssl/params.h>
#include "prov/bio.h"
#include "prov/implementations.h"
#include "prov/provider_ctx.h"
#include "encoder_local.h"

static OSSL_FUNC_encoder_newctx_fn ec_priv_newctx;
static OSSL_FUNC_encoder_freectx_fn ec_priv_freectx;
static OSSL_FUNC_encoder_set_ctx_params_fn ec_priv_set_ctx_params;
static OSSL_FUNC_encoder_settable_ctx_params_fn ec_priv_settable_ctx_params;
static OSSL_FUNC_encoder_encode_data_fn ec_priv_der_data;
static OSSL_FUNC_encoder_encode_object_fn ec_priv_der;
static OSSL_FUNC_encoder_encode_data_fn ec_pem_priv_data;
static OSSL_FUNC_encoder_encode_object_fn ec_pem_priv;

static OSSL_FUNC_encoder_newctx_fn ec_print_newctx;
static OSSL_FUNC_encoder_freectx_fn ec_print_freectx;
static OSSL_FUNC_encoder_encode_data_fn ec_priv_print_data;
static OSSL_FUNC_encoder_encode_object_fn ec_priv_print;

/*
 * Context used for private key encoding.
 */
struct ec_priv_ctx_st {
    void *provctx;

    struct pkcs8_encrypt_ctx_st sc;
};

/* Private key : context */
static void *ec_priv_newctx(void *provctx)
{
    struct ec_priv_ctx_st *ctx = OPENSSL_zalloc(sizeof(*ctx));

    if (ctx != NULL) {
        ctx->provctx = provctx;

        /* -1 is the "whatever" indicator, i.e. the PKCS8 library default PBE */
        ctx->sc.pbe_nid = -1;
    }
    return ctx;
}

static void ec_priv_freectx(void *vctx)
{
    struct ec_priv_ctx_st *ctx = vctx;

    EVP_CIPHER_free(ctx->sc.cipher);
    OPENSSL_free(ctx->sc.cipher_pass);
    OPENSSL_free(ctx);
}

static const OSSL_PARAM *ec_priv_settable_ctx_params(ossl_unused void *provctx)
{
    static const OSSL_PARAM settables[] = {
        OSSL_PARAM_utf8_string(OSSL_ENCODER_PARAM_CIPHER, NULL, 0),
        OSSL_PARAM_octet_string(OSSL_ENCODER_PARAM_PASS, NULL, 0),
        OSSL_PARAM_END,
    };

    return settables;
}

static int ec_priv_set_ctx_params(void *vctx, const OSSL_PARAM params[])
{
    struct ec_priv_ctx_st *ctx = vctx;
    const OSSL_PARAM *p;

    if ((p = OSSL_PARAM_locate_const(params, OSSL_ENCODER_PARAM_CIPHER))
        != NULL) {
        const OSSL_PARAM *propsp =
            OSSL_PARAM_locate_const(params, OSSL_ENCODER_PARAM_PROPERTIES);
        const char *props = NULL;

        if (p->data_type != OSSL_PARAM_UTF8_STRING)
            return 0;
        if (propsp != NULL && propsp->data_type != OSSL_PARAM_UTF8_STRING)
            return 0;
        props = (propsp != NULL ? propsp->data : NULL);

        EVP_CIPHER_free(ctx->sc.cipher);
        ctx->sc.cipher_intent = p->data != NULL;
        if (p->data != NULL
            && ((ctx->sc.cipher = EVP_CIPHER_fetch(NULL, p->data, props))
                == NULL))
            return 0;
    }
    if ((p = OSSL_PARAM_locate_const(params, OSSL_ENCODER_PARAM_PASS))
        != NULL) {
        OPENSSL_free(ctx->sc.cipher_pass);
        ctx->sc.cipher_pass = NULL;
        if (!OSSL_PARAM_get_octet_string(p, &ctx->sc.cipher_pass, 0,
                                         &ctx->sc.cipher_pass_length))
            return 0;
    }
    return 1;
}

/* Private key : DER */
static int ec_priv_der_data(void *vctx, const OSSL_PARAM params[],
                            OSSL_CORE_BIO *out,
                            OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct ec_priv_ctx_st *ctx = vctx;
    OSSL_FUNC_keymgmt_new_fn *ec_new;
    OSSL_FUNC_keymgmt_free_fn *ec_free;
    OSSL_FUNC_keymgmt_import_fn *ec_import;
    int ok = 0;

    ec_get_new_free_import(&ec_new, &ec_free, &ec_import);

    if (ec_import != NULL) {
        EC_KEY *eckey;

        if ((eckey = ec_new(ctx->provctx)) != NULL
            && ec_import(eckey, OSSL_KEYMGMT_SELECT_ALL, params)
            && ec_priv_der(ctx, eckey, out, cb, cbarg))
            ok = 1;
        ec_free(eckey);
    }
    return ok;
}

static int ec_priv_der(void *vctx, void *eckey, OSSL_CORE_BIO *cout,
                       OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct ec_priv_ctx_st *ctx = vctx;
    BIO *out = bio_new_from_core_bio(ctx->provctx, cout);
    int ret;

    if (out == NULL)
        return 0;

    ctx->sc.cb = cb;
    ctx->sc.cbarg = cbarg;

    ret = ossl_prov_write_priv_der_from_obj(out, eckey, EVP_PKEY_EC,
                                            ossl_prov_prepare_ec_params,
                                            ossl_prov_ec_priv_to_der,
                                            &ctx->sc);
    BIO_free(out);

    return ret;
}

/* Private key : PEM */
static int ec_pem_priv_data(void *vctx, const OSSL_PARAM params[],
                            OSSL_CORE_BIO *out,
                            OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct ec_priv_ctx_st *ctx = vctx;
    OSSL_FUNC_keymgmt_new_fn *ec_new;
    OSSL_FUNC_keymgmt_free_fn *ec_free;
    OSSL_FUNC_keymgmt_import_fn *ec_import;
    int ok = 0;

    ec_get_new_free_import(&ec_new, &ec_free, &ec_import);

    if (ec_import != NULL) {
        EC_KEY *eckey;

        if ((eckey = ec_new(ctx->provctx)) != NULL
            && ec_import(eckey, OSSL_KEYMGMT_SELECT_ALL, params)
            && ec_pem_priv(ctx, eckey, out, cb, cbarg))
            ok = 1;
        ec_free(eckey);
    }
    return ok;
}

static int ec_pem_priv(void *vctx, void *eckey, OSSL_CORE_BIO *cout,
                       OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct ec_priv_ctx_st *ctx = vctx;
    BIO *out = bio_new_from_core_bio(ctx->provctx, cout);
    int ret;

    if (out == NULL)
        return 0;

    ctx->sc.cb = cb;
    ctx->sc.cbarg = cbarg;

    ret = ossl_prov_write_priv_pem_from_obj(out, eckey, EVP_PKEY_EC,
                                            ossl_prov_prepare_ec_params,
                                            ossl_prov_ec_priv_to_der,
                                            &ctx->sc);
    BIO_free(out);

    return ret;
}

/*
 * There's no specific print context, so we use the provider context
 */
static void *ec_print_newctx(void *provctx)
{
    return provctx;
}

static void ec_print_freectx(void *ctx)
{
}

static int ec_priv_print_data(void *vctx, const OSSL_PARAM params[],
                              OSSL_CORE_BIO *out,
                              OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct ec_priv_ctx_st *ctx = vctx;
    OSSL_FUNC_keymgmt_new_fn *ec_new;
    OSSL_FUNC_keymgmt_free_fn *ec_free;
    OSSL_FUNC_keymgmt_import_fn *ec_import;
    int ok = 0;

    ec_get_new_free_import(&ec_new, &ec_free, &ec_import);

    if (ec_import != NULL) {
        EC_KEY *eckey;

        if ((eckey = ec_new(ctx->provctx)) != NULL
            && ec_import(eckey, OSSL_KEYMGMT_SELECT_ALL, params)
            && ec_priv_print(ctx, eckey, out, cb, cbarg))
            ok = 1;
        ec_free(eckey);
    }
    return ok;
}

static int ec_priv_print(void *ctx, void *eckey, OSSL_CORE_BIO *cout,
                         OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    BIO *out = bio_new_from_core_bio(ctx, cout);
    int ret;

    if (out == NULL)
        return 0;

    ret = ossl_prov_print_eckey(out, eckey, ec_print_priv);
    BIO_free(out);

    return ret;
}

const OSSL_DISPATCH ec_priv_der_encoder_functions[] = {
    { OSSL_FUNC_ENCODER_NEWCTX, (void (*)(void))ec_priv_newctx },
    { OSSL_FUNC_ENCODER_FREECTX, (void (*)(void))ec_priv_freectx },
    { OSSL_FUNC_ENCODER_SET_CTX_PARAMS,
      (void (*)(void))ec_priv_set_ctx_params },
    { OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS,
      (void (*)(void))ec_priv_settable_ctx_params },
    { OSSL_FUNC_ENCODER_ENCODE_DATA, (void (*)(void))ec_priv_der_data },
    { OSSL_FUNC_ENCODER_ENCODE_OBJECT, (void (*)(void))ec_priv_der },
    { 0, NULL }
};

const OSSL_DISPATCH ec_priv_pem_encoder_functions[] = {
    { OSSL_FUNC_ENCODER_NEWCTX, (void (*)(void))ec_priv_newctx },
    { OSSL_FUNC_ENCODER_FREECTX, (void (*)(void))ec_priv_freectx },
    { OSSL_FUNC_ENCODER_SET_CTX_PARAMS,
      (void (*)(void))ec_priv_set_ctx_params },
    { OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS,
      (void (*)(void))ec_priv_settable_ctx_params },
    { OSSL_FUNC_ENCODER_ENCODE_DATA, (void (*)(void))ec_pem_priv_data },
    { OSSL_FUNC_ENCODER_ENCODE_OBJECT, (void (*)(void))ec_pem_priv },
    { 0, NULL }
};

const OSSL_DISPATCH ec_priv_text_encoder_functions[] = {
    { OSSL_FUNC_ENCODER_NEWCTX, (void (*)(void))ec_print_newctx },
    { OSSL_FUNC_ENCODER_FREECTX, (void (*)(void))ec_print_freectx },
    { OSSL_FUNC_ENCODER_ENCODE_OBJECT, (void (*)(void))ec_priv_print },
    { OSSL_FUNC_ENCODER_ENCODE_DATA,
      (void (*)(void))ec_priv_print_data },
    { 0, NULL }
};