crypto/dh/dh_ameth.c

   1 /*
   2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   3  * 2006.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #include <stdio.h>
  60 #include "cryptlib.h"
  61 #include <openssl/x509.h>
  62 #include <openssl/asn1.h>
  63 #include <openssl/dh.h>
  64 #include <openssl/bn.h>
  65 #include "asn1_locl.h"
  66
  67 static void int_dh_free(EVP_PKEY *pkey)
  68 {
  69     DH_free(pkey->pkey.dh);
  70 }
  71
  72 static int dh_pub_decode(EVP_PKEY *pkey, X509_PUBKEY *pubkey)
  73 {
  74     const unsigned char *p, *pm;
  75     int pklen, pmlen;
  76     int ptype;
  77     void *pval;
  78     ASN1_STRING *pstr;
  79     X509_ALGOR *palg;
  80     ASN1_INTEGER *public_key = NULL;
  81
  82     DH *dh = NULL;
  83
  84     if (!X509_PUBKEY_get0_param(NULL, &p, &pklen, &palg, pubkey))
  85         return 0;
  86     X509_ALGOR_get0(NULL, &ptype, &pval, palg);
  87
  88     if (ptype != V_ASN1_SEQUENCE) {
  89         DHerr(DH_F_DH_PUB_DECODE, DH_R_PARAMETER_ENCODING_ERROR);
  90         goto err;
  91     }
  92
  93     pstr = pval;
  94     pm = pstr->data;
  95     pmlen = pstr->length;
  96
  97     if (!(dh = d2i_DHparams(NULL, &pm, pmlen))) {
  98         DHerr(DH_F_DH_PUB_DECODE, DH_R_DECODE_ERROR);
  99         goto err;
 100     }
 101
 102     if (!(public_key = d2i_ASN1_INTEGER(NULL, &p, pklen))) {
 103         DHerr(DH_F_DH_PUB_DECODE, DH_R_DECODE_ERROR);
 104         goto err;
 105     }
 106
 107     /* We have parameters now set public key */
 108     if (!(dh->pub_key = ASN1_INTEGER_to_BN(public_key, NULL))) {
 109         DHerr(DH_F_DH_PUB_DECODE, DH_R_BN_DECODE_ERROR);
 110         goto err;
 111     }
 112
 113     ASN1_INTEGER_free(public_key);
 114     EVP_PKEY_assign_DH(pkey, dh);
 115     return 1;
 116
 117  err:
 118     if (public_key)
 119         ASN1_INTEGER_free(public_key);
 120     if (dh)
 121         DH_free(dh);
 122     return 0;
 123
 124 }
 125
 126 static int dh_pub_encode(X509_PUBKEY *pk, const EVP_PKEY *pkey)
 127 {
 128     DH *dh;
 129     void *pval = NULL;
 130     int ptype;
 131     unsigned char *penc = NULL;
 132     int penclen;
 133     ASN1_STRING *str;
 134     ASN1_INTEGER *pub_key = NULL;
 135
 136     dh = pkey->pkey.dh;
 137
 138     str = ASN1_STRING_new();
 139     str->length = i2d_DHparams(dh, &str->data);
 140     if (str->length <= 0) {
 141         DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
 142         goto err;
 143     }
 144     pval = str;
 145     ptype = V_ASN1_SEQUENCE;
 146
 147     pub_key = BN_to_ASN1_INTEGER(dh->pub_key, NULL);
 148     if (!pub_key)
 149         goto err;
 150
 151     penclen = i2d_ASN1_INTEGER(pub_key, &penc);
 152
 153     ASN1_INTEGER_free(pub_key);
 154
 155     if (penclen <= 0) {
 156         DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
 157         goto err;
 158     }
 159
 160     if (X509_PUBKEY_set0_param(pk, OBJ_nid2obj(EVP_PKEY_DH),
 161                                ptype, pval, penc, penclen))
 162         return 1;
 163
 164  err:
 165     if (penc)
 166         OPENSSL_free(penc);
 167     if (pval)
 168         ASN1_STRING_free(pval);
 169
 170     return 0;
 171 }
 172
 173 /*
 174  * PKCS#8 DH is defined in PKCS#11 of all places. It is similar to DH in that
 175  * the AlgorithmIdentifier contains the paramaters, the private key is
 176  * explcitly included and the pubkey must be recalculated.
 177  */
 178
 179 static int dh_priv_decode(EVP_PKEY *pkey, PKCS8_PRIV_KEY_INFO *p8)
 180 {
 181     const unsigned char *p, *pm;
 182     int pklen, pmlen;
 183     int ptype;
 184     void *pval;
 185     ASN1_STRING *pstr;
 186     X509_ALGOR *palg;
 187     ASN1_INTEGER *privkey = NULL;
 188
 189     DH *dh = NULL;
 190
 191     if (!PKCS8_pkey_get0(NULL, &p, &pklen, &palg, p8))
 192         return 0;
 193
 194     X509_ALGOR_get0(NULL, &ptype, &pval, palg);
 195
 196     if (ptype != V_ASN1_SEQUENCE)
 197         goto decerr;
 198
 199     if (!(privkey = d2i_ASN1_INTEGER(NULL, &p, pklen)))
 200         goto decerr;
 201
 202     pstr = pval;
 203     pm = pstr->data;
 204     pmlen = pstr->length;
 205     if (!(dh = d2i_DHparams(NULL, &pm, pmlen)))
 206         goto decerr;
 207     /* We have parameters now set private key */
 208     if (!(dh->priv_key = ASN1_INTEGER_to_BN(privkey, NULL))) {
 209         DHerr(DH_F_DH_PRIV_DECODE, DH_R_BN_ERROR);
 210         goto dherr;
 211     }
 212     /* Calculate public key */
 213     if (!DH_generate_key(dh))
 214         goto dherr;
 215
 216     EVP_PKEY_assign_DH(pkey, dh);
 217
 218     ASN1_INTEGER_free(privkey);
 219
 220     return 1;
 221
 222  decerr:
 223     DHerr(DH_F_DH_PRIV_DECODE, EVP_R_DECODE_ERROR);
 224  dherr:
 225     DH_free(dh);
 226     return 0;
 227 }
 228
 229 static int dh_priv_encode(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pkey)
 230 {
 231     ASN1_STRING *params = NULL;
 232     ASN1_INTEGER *prkey = NULL;
 233     unsigned char *dp = NULL;
 234     int dplen;
 235
 236     params = ASN1_STRING_new();
 237
 238     if (!params) {
 239         DHerr(DH_F_DH_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
 240         goto err;
 241     }
 242
 243     params->length = i2d_DHparams(pkey->pkey.dh, &params->data);
 244     if (params->length <= 0) {
 245         DHerr(DH_F_DH_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
 246         goto err;
 247     }
 248     params->type = V_ASN1_SEQUENCE;
 249
 250     /* Get private key into integer */
 251     prkey = BN_to_ASN1_INTEGER(pkey->pkey.dh->priv_key, NULL);
 252
 253     if (!prkey) {
 254         DHerr(DH_F_DH_PRIV_ENCODE, DH_R_BN_ERROR);
 255         goto err;
 256     }
 257
 258     dplen = i2d_ASN1_INTEGER(prkey, &dp);
 259
 260     ASN1_INTEGER_free(prkey);
 261     prkey = NULL;
 262
 263     if (!PKCS8_pkey_set0(p8, OBJ_nid2obj(NID_dhKeyAgreement), 0,
 264                          V_ASN1_SEQUENCE, params, dp, dplen))
 265         goto err;
 266
 267     return 1;
 268
 269  err:
 270     if (dp != NULL)
 271         OPENSSL_free(dp);
 272     if (params != NULL)
 273         ASN1_STRING_free(params);
 274     if (prkey != NULL)
 275         ASN1_INTEGER_free(prkey);
 276     return 0;
 277 }
 278
 279 static void update_buflen(const BIGNUM *b, size_t *pbuflen)
 280 {
 281     size_t i;
 282     if (!b)
 283         return;
 284     if (*pbuflen < (i = (size_t)BN_num_bytes(b)))
 285         *pbuflen = i;
 286 }
 287
 288 static int dh_param_decode(EVP_PKEY *pkey,
 289                            const unsigned char **pder, int derlen)
 290 {
 291     DH *dh;
 292     if (!(dh = d2i_DHparams(NULL, pder, derlen))) {
 293         DHerr(DH_F_DH_PARAM_DECODE, ERR_R_DH_LIB);
 294         return 0;
 295     }
 296     EVP_PKEY_assign_DH(pkey, dh);
 297     return 1;
 298 }
 299
 300 static int dh_param_encode(const EVP_PKEY *pkey, unsigned char **pder)
 301 {
 302     return i2d_DHparams(pkey->pkey.dh, pder);
 303 }
 304
 305 static int do_dh_print(BIO *bp, const DH *x, int indent,
 306                        ASN1_PCTX *ctx, int ptype)
 307 {
 308     unsigned char *m = NULL;
 309     int reason = ERR_R_BUF_LIB, ret = 0;
 310     size_t buf_len = 0;
 311
 312     const char *ktype = NULL;
 313
 314     BIGNUM *priv_key, *pub_key;
 315
 316     if (ptype == 2)
 317         priv_key = x->priv_key;
 318     else
 319         priv_key = NULL;
 320
 321     if (ptype > 0)
 322         pub_key = x->pub_key;
 323     else
 324         pub_key = NULL;
 325
 326     update_buflen(x->p, &buf_len);
 327
 328     if (buf_len == 0) {
 329         reason = ERR_R_PASSED_NULL_PARAMETER;
 330         goto err;
 331     }
 332
 333     update_buflen(x->g, &buf_len);
 334     update_buflen(pub_key, &buf_len);
 335     update_buflen(priv_key, &buf_len);
 336
 337     if (ptype == 2)
 338         ktype = "PKCS#3 DH Private-Key";
 339     else if (ptype == 1)
 340         ktype = "PKCS#3 DH Public-Key";
 341     else
 342         ktype = "PKCS#3 DH Parameters";
 343
 344     m = OPENSSL_malloc(buf_len + 10);
 345     if (m == NULL) {
 346         reason = ERR_R_MALLOC_FAILURE;
 347         goto err;
 348     }
 349
 350     BIO_indent(bp, indent, 128);
 351     if (BIO_printf(bp, "%s: (%d bit)\n", ktype, BN_num_bits(x->p)) <= 0)
 352         goto err;
 353     indent += 4;
 354
 355     if (!ASN1_bn_print(bp, "private-key:", priv_key, m, indent))
 356         goto err;
 357     if (!ASN1_bn_print(bp, "public-key:", pub_key, m, indent))
 358         goto err;
 359
 360     if (!ASN1_bn_print(bp, "prime:", x->p, m, indent))
 361         goto err;
 362     if (!ASN1_bn_print(bp, "generator:", x->g, m, indent))
 363         goto err;
 364     if (x->length != 0) {
 365         BIO_indent(bp, indent, 128);
 366         if (BIO_printf(bp, "recommended-private-length: %d bits\n",
 367                        (int)x->length) <= 0)
 368             goto err;
 369     }
 370
 371     ret = 1;
 372     if (0) {
 373  err:
 374         DHerr(DH_F_DO_DH_PRINT, reason);
 375     }
 376     if (m != NULL)
 377         OPENSSL_free(m);
 378     return (ret);
 379 }
 380
 381 static int int_dh_size(const EVP_PKEY *pkey)
 382 {
 383     return (DH_size(pkey->pkey.dh));
 384 }
 385
 386 static int dh_bits(const EVP_PKEY *pkey)
 387 {
 388     return BN_num_bits(pkey->pkey.dh->p);
 389 }
 390
 391 static int dh_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
 392 {
 393     if (BN_cmp(a->pkey.dh->p, b->pkey.dh->p) ||
 394         BN_cmp(a->pkey.dh->g, b->pkey.dh->g))
 395         return 0;
 396     else
 397         return 1;
 398 }
 399
 400 static int dh_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
 401 {
 402     BIGNUM *a;
 403
 404     if ((a = BN_dup(from->pkey.dh->p)) == NULL)
 405         return 0;
 406     if (to->pkey.dh->p != NULL)
 407         BN_free(to->pkey.dh->p);
 408     to->pkey.dh->p = a;
 409
 410     if ((a = BN_dup(from->pkey.dh->g)) == NULL)
 411         return 0;
 412     if (to->pkey.dh->g != NULL)
 413         BN_free(to->pkey.dh->g);
 414     to->pkey.dh->g = a;
 415
 416     return 1;
 417 }
 418
 419 static int dh_missing_parameters(const EVP_PKEY *a)
 420 {
 421     if (!a->pkey.dh->p || !a->pkey.dh->g)
 422         return 1;
 423     return 0;
 424 }
 425
 426 static int dh_pub_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
 427 {
 428     if (dh_cmp_parameters(a, b) == 0)
 429         return 0;
 430     if (BN_cmp(b->pkey.dh->pub_key, a->pkey.dh->pub_key) != 0)
 431         return 0;
 432     else
 433         return 1;
 434 }
 435
 436 static int dh_param_print(BIO *bp, const EVP_PKEY *pkey, int indent,
 437                           ASN1_PCTX *ctx)
 438 {
 439     return do_dh_print(bp, pkey->pkey.dh, indent, ctx, 0);
 440 }
 441
 442 static int dh_public_print(BIO *bp, const EVP_PKEY *pkey, int indent,
 443                            ASN1_PCTX *ctx)
 444 {
 445     return do_dh_print(bp, pkey->pkey.dh, indent, ctx, 1);
 446 }
 447
 448 static int dh_private_print(BIO *bp, const EVP_PKEY *pkey, int indent,
 449                             ASN1_PCTX *ctx)
 450 {
 451     return do_dh_print(bp, pkey->pkey.dh, indent, ctx, 2);
 452 }
 453
 454 int DHparams_print(BIO *bp, const DH *x)
 455 {
 456     return do_dh_print(bp, x, 4, NULL, 0);
 457 }
 458
 459 const EVP_PKEY_ASN1_METHOD dh_asn1_meth = {
 460     EVP_PKEY_DH,
 461     EVP_PKEY_DH,
 462     0,
 463
 464     "DH",
 465     "OpenSSL PKCS#3 DH method",
 466
 467     dh_pub_decode,
 468     dh_pub_encode,
 469     dh_pub_cmp,
 470     dh_public_print,
 471
 472     dh_priv_decode,
 473     dh_priv_encode,
 474     dh_private_print,
 475
 476     int_dh_size,
 477     dh_bits,
 478
 479     dh_param_decode,
 480     dh_param_encode,
 481     dh_missing_parameters,
 482     dh_copy_parameters,
 483     dh_cmp_parameters,
 484     dh_param_print,
 485     0,
 486
 487     int_dh_free,
 488     0
 489 };