providers/implementations/serializers/serializer_dsa_priv.c

   1 /*
   2  * Copyright 2019 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 <openssl/core_numbers.h>
  11 #include <openssl/core_names.h>
  12 #include <openssl/err.h>
  13 #include <openssl/pem.h>
  14 #include <openssl/dsa.h>
  15 #include <openssl/types.h>
  16 #include <openssl/params.h>
  17 #include "prov/bio.h"
  18 #include "prov/implementations.h"
  19 #include "serializer_local.h"
  20
  21 static OSSL_OP_serializer_newctx_fn dsa_priv_newctx;
  22 static OSSL_OP_serializer_freectx_fn dsa_priv_freectx;
  23 static OSSL_OP_serializer_set_ctx_params_fn dsa_priv_set_ctx_params;
  24 static OSSL_OP_serializer_settable_ctx_params_fn dsa_priv_settable_ctx_params;
  25 static OSSL_OP_serializer_serialize_data_fn dsa_priv_der_data;
  26 static OSSL_OP_serializer_serialize_object_fn dsa_priv_der;
  27 static OSSL_OP_serializer_serialize_data_fn dsa_pem_priv_data;
  28 static OSSL_OP_serializer_serialize_object_fn dsa_pem_priv;
  29
  30 static OSSL_OP_serializer_newctx_fn dsa_print_newctx;
  31 static OSSL_OP_serializer_freectx_fn dsa_print_freectx;
  32 static OSSL_OP_serializer_serialize_data_fn dsa_priv_print_data;
  33 static OSSL_OP_serializer_serialize_object_fn dsa_priv_print;
  34
  35  /*
  36  * Context used for private key serialization.
  37  */
  38 struct dsa_priv_ctx_st {
  39     void *provctx;
  40
  41     struct pkcs8_encrypt_ctx_st sc;
  42 };
  43
  44 /* Private key : context */
  45 static void *dsa_priv_newctx(void *provctx)
  46 {
  47     struct dsa_priv_ctx_st *ctx = OPENSSL_zalloc(sizeof(*ctx));
  48
  49     if (ctx != NULL) {
  50         ctx->provctx = provctx;
  51
  52         /* -1 is the "whatever" indicator, i.e. the PKCS8 library default PBE */
  53         ctx->sc.pbe_nid = -1;
  54     }
  55     return ctx;
  56 }
  57
  58 static void dsa_priv_freectx(void *vctx)
  59 {
  60     struct dsa_priv_ctx_st *ctx = vctx;
  61
  62     EVP_CIPHER_free(ctx->sc.cipher);
  63     OPENSSL_free(ctx->sc.cipher_pass);
  64     OPENSSL_free(ctx);
  65 }
  66
  67 static const OSSL_PARAM *dsa_priv_settable_ctx_params(void)
  68 {
  69     static const OSSL_PARAM settables[] = {
  70         OSSL_PARAM_utf8_string(OSSL_SERIALIZER_PARAM_CIPHER, NULL, 0),
  71         OSSL_PARAM_octet_string(OSSL_SERIALIZER_PARAM_PASS, NULL, 0),
  72         OSSL_PARAM_END,
  73     };
  74
  75     return settables;
  76 }
  77
  78 static int dsa_priv_set_ctx_params(void *vctx, const OSSL_PARAM params[])
  79 {
  80     struct dsa_priv_ctx_st *ctx = vctx;
  81     const OSSL_PARAM *p;
  82
  83     if ((p = OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_CIPHER))
  84         != NULL) {
  85         const OSSL_PARAM *propsp =
  86             OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_PROPERTIES);
  87         const char *props = NULL;
  88
  89         if (p->data_type != OSSL_PARAM_UTF8_STRING)
  90             return 0;
  91         if (propsp != NULL && propsp->data_type != OSSL_PARAM_UTF8_STRING)
  92             return 0;
  93         props = (propsp != NULL ? propsp->data : NULL);
  94
  95         EVP_CIPHER_free(ctx->sc.cipher);
  96         ctx->sc.cipher_intent = p->data != NULL;
  97         if (p->data != NULL
  98             && ((ctx->sc.cipher = EVP_CIPHER_fetch(NULL, p->data, props))
  99                 == NULL))
 100             return 0;
 101     }
 102     if ((p = OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_PASS))
 103         != NULL) {
 104         OPENSSL_free(ctx->sc.cipher_pass);
 105         ctx->sc.cipher_pass = NULL;
 106         if (!OSSL_PARAM_get_octet_string(p, &ctx->sc.cipher_pass, 0,
 107                                          &ctx->sc.cipher_pass_length))
 108             return 0;
 109     }
 110     return 1;
 111 }
 112
 113 /* Private key : DER */
 114 static int dsa_priv_der_data(void *vctx, const OSSL_PARAM params[], BIO *out,
 115                              OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
 116 {
 117     struct dsa_priv_ctx_st *ctx = vctx;
 118     OSSL_OP_keymgmt_new_fn *dsa_new = ossl_prov_get_keymgmt_dsa_new();
 119     OSSL_OP_keymgmt_free_fn *dsa_free = ossl_prov_get_keymgmt_dsa_free();
 120     OSSL_OP_keymgmt_import_fn *dsa_import = ossl_prov_get_keymgmt_dsa_import();
 121     int ok = 0;
 122
 123     if (dsa_import != NULL) {
 124         DSA *dsa;
 125
 126         if ((dsa = dsa_new(ctx->provctx)) != NULL
 127             && dsa_import(dsa, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
 128             && dsa_priv_der(ctx, dsa, out, cb, cbarg))
 129             ok = 1;
 130         dsa_free(dsa);
 131     }
 132     return ok;
 133 }
 134
 135 static int dsa_priv_der(void *vctx, void *dsa, BIO *out,
 136                         OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
 137 {
 138     struct dsa_priv_ctx_st *ctx = vctx;
 139
 140     ctx->sc.cb = cb;
 141     ctx->sc.cbarg = cbarg;
 142
 143     return ossl_prov_write_priv_der_from_obj(out, dsa, EVP_PKEY_DSA,
 144                                              ossl_prov_prepare_dsa_params,
 145                                              ossl_prov_dsa_priv_to_der,
 146                                              &ctx->sc);
 147 }
 148
 149 /* Private key : PEM */
 150 static int dsa_pem_priv_data(void *vctx, const OSSL_PARAM params[], BIO *out,
 151                              OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
 152 {
 153     struct dsa_priv_ctx_st *ctx = vctx;
 154     OSSL_OP_keymgmt_new_fn *dsa_new = ossl_prov_get_keymgmt_dsa_new();
 155     OSSL_OP_keymgmt_free_fn *dsa_free = ossl_prov_get_keymgmt_dsa_free();
 156     OSSL_OP_keymgmt_import_fn *dsa_import = ossl_prov_get_keymgmt_dsa_import();
 157     int ok = 0;
 158
 159     if (dsa_import != NULL) {
 160         DSA *dsa;
 161
 162         if ((dsa = dsa_new(ctx->provctx)) != NULL
 163             && dsa_import(dsa, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
 164             && dsa_pem_priv(ctx, dsa, out, cb, cbarg))
 165             ok = 1;
 166         dsa_free(dsa);
 167     }
 168     return ok;
 169 }
 170
 171 static int dsa_pem_priv(void *vctx, void *dsa, BIO *out,
 172                         OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
 173 {
 174     struct dsa_priv_ctx_st *ctx = vctx;
 175
 176     ctx->sc.cb = cb;
 177     ctx->sc.cbarg = cbarg;
 178
 179     return ossl_prov_write_priv_pem_from_obj(out, dsa, EVP_PKEY_DSA,
 180                                              ossl_prov_prepare_dsa_params,
 181                                              ossl_prov_dsa_priv_to_der,
 182                                              &ctx->sc);
 183 }
 184
 185 /*
 186  * There's no specific print context, so we use the provider context
 187  */
 188 static void *dsa_print_newctx(void *provctx)
 189 {
 190     return provctx;
 191 }
 192
 193 static void dsa_print_freectx(void *ctx)
 194 {
 195 }
 196
 197 static int dsa_priv_print_data(void *vctx, const OSSL_PARAM params[],
 198                                BIO *out,
 199                                OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
 200 {
 201     struct dsa_priv_ctx_st *ctx = vctx;
 202     OSSL_OP_keymgmt_new_fn *dsa_new = ossl_prov_get_keymgmt_dsa_new();
 203     OSSL_OP_keymgmt_free_fn *dsa_free = ossl_prov_get_keymgmt_dsa_free();
 204     OSSL_OP_keymgmt_import_fn *dsa_import = ossl_prov_get_keymgmt_dsa_import();
 205     int ok = 0;
 206
 207     if (dsa_import != NULL) {
 208         DSA *dsa;
 209
 210         if ((dsa = dsa_new(ctx->provctx)) != NULL
 211             && dsa_import(dsa, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
 212             && dsa_priv_print(ctx, dsa, out, cb, cbarg))
 213             ok = 1;
 214         dsa_free(dsa);
 215     }
 216     return ok;
 217 }
 218
 219 static int dsa_priv_print(void *ctx, void *dsa, BIO *out,
 220                           OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
 221 {
 222     return ossl_prov_print_dsa(out, dsa, dsa_print_priv);
 223 }
 224
 225 const OSSL_DISPATCH dsa_priv_der_serializer_functions[] = {
 226     { OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dsa_priv_newctx },
 227     { OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dsa_priv_freectx },
 228     { OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS,
 229       (void (*)(void))dsa_priv_set_ctx_params },
 230     { OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS,
 231       (void (*)(void))dsa_priv_settable_ctx_params },
 232     { OSSL_FUNC_SERIALIZER_SERIALIZE_DATA, (void (*)(void))dsa_priv_der_data },
 233     { OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dsa_priv_der },
 234     { 0, NULL }
 235 };
 236
 237 const OSSL_DISPATCH dsa_priv_pem_serializer_functions[] = {
 238     { OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dsa_priv_newctx },
 239     { OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dsa_priv_freectx },
 240     { OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS,
 241       (void (*)(void))dsa_priv_set_ctx_params },
 242     { OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS,
 243       (void (*)(void))dsa_priv_settable_ctx_params },
 244     { OSSL_FUNC_SERIALIZER_SERIALIZE_DATA, (void (*)(void))dsa_pem_priv_data },
 245     { OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dsa_pem_priv },
 246     { 0, NULL }
 247 };
 248
 249 const OSSL_DISPATCH dsa_priv_text_serializer_functions[] = {
 250     { OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dsa_print_newctx },
 251     { OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dsa_print_freectx },
 252     { OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dsa_priv_print },
 253     { OSSL_FUNC_SERIALIZER_SERIALIZE_DATA,
 254       (void (*)(void))dsa_priv_print_data },
 255     { 0, NULL }
 256 };