providers/implementations/encode_decode/encode_key2text.c

   1 /*
   2  * Copyright 2020 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 /*
  11  * Low level APIs are deprecated for public use, but still ok for internal use.
  12  */
  13 #include "internal/deprecated.h"
  14
  15 #include <ctype.h>
  16
  17 #include <openssl/core.h>
  18 #include <openssl/core_dispatch.h>
  19 #include <openssl/core_names.h>
  20 #include <openssl/bn.h>
  21 #include <openssl/err.h>
  22 #include <openssl/safestack.h>
  23 #include "internal/ffc.h"
  24 #include "crypto/bn.h"           /* bn_get_words() */
  25 #include "crypto/dh.h"           /* dh_get0_params() */
  26 #include "crypto/dsa.h"          /* dsa_get0_params() */
  27 #include "crypto/ec.h"           /* ec_key_get_libctx */
  28 #include "crypto/ecx.h"          /* ECX_KEY, etc... */
  29 #include "crypto/rsa.h"          /* RSA_PSS_PARAMS_30, etc... */
  30 #include "prov/bio.h"
  31 #include "prov/implementations.h"
  32 #include "prov/providercommonerr.h"
  33 #include "endecoder_local.h"
  34
  35 DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const, BIGNUM)
  36
  37 # ifdef SIXTY_FOUR_BIT_LONG
  38 #  define BN_FMTu "%lu"
  39 #  define BN_FMTx "%lx"
  40 # endif
  41
  42 # ifdef SIXTY_FOUR_BIT
  43 #  define BN_FMTu "%llu"
  44 #  define BN_FMTx "%llx"
  45 # endif
  46
  47 # ifdef THIRTY_TWO_BIT
  48 #  define BN_FMTu "%u"
  49 #  define BN_FMTx "%x"
  50 # endif
  51
  52 static int print_labeled_bignum(BIO *out, const char *label, const BIGNUM *bn)
  53 {
  54     int ret = 0, use_sep = 0;
  55     char *hex_str = NULL, *p;
  56     const char spaces[] = "    ";
  57     const char *post_label_spc = " ";
  58
  59     const char *neg = "";
  60     int bytes;
  61
  62     if (bn == NULL)
  63         return 0;
  64     if (label == NULL) {
  65         label = "";
  66         post_label_spc = "";
  67     }
  68
  69     if (BN_is_zero(bn))
  70         return BIO_printf(out, "%s%s0\n", label, post_label_spc);
  71
  72     if (BN_num_bytes(bn) <= BN_BYTES) {
  73         BN_ULONG *words = bn_get_words(bn);
  74
  75         if (BN_is_negative(bn))
  76             neg = "-";
  77
  78         return BIO_printf(out, "%s%s%s" BN_FMTu " (%s0x" BN_FMTx ")\n",
  79                           label, post_label_spc, neg, words[0], neg, words[0]);
  80     }
  81
  82     hex_str = BN_bn2hex(bn);
  83     p = hex_str;
  84     if (*p == '-') {
  85         ++p;
  86         neg = " (Negative)";
  87     }
  88     if (BIO_printf(out, "%s%s\n", label, neg) <= 0)
  89         goto err;
  90
  91     /* Keep track of how many bytes we have printed out so far */
  92     bytes = 0;
  93
  94     if (BIO_printf(out, "%s", spaces) <= 0)
  95         goto err;
  96
  97     /* Add a leading 00 if the top bit is set */
  98     if (*p >= '8') {
  99         if (BIO_printf(out, "%02x", 0) <= 0)
 100             goto err;
 101         ++bytes;
 102         use_sep = 1;
 103     }
 104     while (*p != '\0') {
 105         /* Do a newline after every 15 hex bytes + add the space indent */
 106         if ((bytes % 15) == 0 && bytes > 0) {
 107             if (BIO_printf(out, ":\n%s", spaces) <= 0)
 108                 goto err;
 109             use_sep = 0; /* The first byte on the next line doesnt have a : */
 110         }
 111         if (BIO_printf(out, "%s%c%c", use_sep ? ":" : "",
 112                        tolower(p[0]), tolower(p[1])) <= 0)
 113             goto err;
 114         ++bytes;
 115         p += 2;
 116         use_sep = 1;
 117     }
 118     if (BIO_printf(out, "\n") <= 0)
 119         goto err;
 120     ret = 1;
 121 err:
 122     OPENSSL_free(hex_str);
 123     return ret;
 124 }
 125
 126 /* Number of octets per line */
 127 #define LABELED_BUF_PRINT_WIDTH    15
 128
 129 static int print_labeled_buf(BIO *out, const char *label,
 130                              const unsigned char *buf, size_t buflen)
 131 {
 132     size_t i;
 133
 134     if (BIO_printf(out, "%s\n", label) <= 0)
 135         return 0;
 136
 137     for (i = 0; i < buflen; i++) {
 138         if ((i % LABELED_BUF_PRINT_WIDTH) == 0) {
 139             if (i > 0 && BIO_printf(out, "\n") <= 0)
 140                 return 0;
 141             if (BIO_printf(out, "    ") <= 0)
 142                 return 0;
 143         }
 144
 145         if (BIO_printf(out, "%02x%s", buf[i],
 146                                  (i == buflen - 1) ? "" : ":") <= 0)
 147             return 0;
 148     }
 149     if (BIO_printf(out, "\n") <= 0)
 150         return 0;
 151
 152     return 1;
 153 }
 154
 155 #if !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_DSA)
 156 static int ffc_params_to_text(BIO *out, const FFC_PARAMS *ffc)
 157 {
 158     if (ffc->nid != NID_undef) {
 159 #ifndef OPENSSL_NO_DH
 160         const char *name = ffc_named_group_from_uid(ffc->nid);
 161
 162         if (name == NULL)
 163             goto err;
 164         if (BIO_printf(out, "GROUP: %s\n", name) <= 0)
 165             goto err;
 166         return 1;
 167 #else
 168         /* How could this be? We should not have a nid in a no-dh build. */
 169         goto err;
 170 #endif
 171     }
 172
 173     if (!print_labeled_bignum(out, "P:   ", ffc->p))
 174         goto err;
 175     if (ffc->q != NULL) {
 176         if (!print_labeled_bignum(out, "Q:   ", ffc->q))
 177             goto err;
 178     }
 179     if (!print_labeled_bignum(out, "G:   ", ffc->g))
 180         goto err;
 181     if (ffc->j != NULL) {
 182         if (!print_labeled_bignum(out, "J:   ", ffc->j))
 183             goto err;
 184     }
 185     if (ffc->seed != NULL) {
 186         if (!print_labeled_buf(out, "SEED:", ffc->seed, ffc->seedlen))
 187             goto err;
 188     }
 189     if (ffc->gindex != -1) {
 190         if (BIO_printf(out, "gindex: %d\n", ffc->gindex) <= 0)
 191             goto err;
 192     }
 193     if (ffc->pcounter != -1) {
 194         if (BIO_printf(out, "pcounter: %d\n", ffc->pcounter) <= 0)
 195             goto err;
 196     }
 197     if (ffc->h != 0) {
 198         if (BIO_printf(out, "h: %d\n", ffc->h) <= 0)
 199             goto err;
 200     }
 201     return 1;
 202 err:
 203     return 0;
 204 }
 205 #endif
 206
 207 /* ---------------------------------------------------------------------- */
 208
 209 #ifndef OPENSSL_NO_DH
 210 static int dh_to_text(BIO *out, const void *key, int selection)
 211 {
 212     const DH *dh = key;
 213     const char *type_label = NULL;
 214     const BIGNUM *priv_key = NULL, *pub_key = NULL;
 215     const FFC_PARAMS *params = NULL;
 216     const BIGNUM *p = NULL;
 217
 218     if (out == NULL || dh == NULL) {
 219         ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_NULL_PARAMETER);
 220         return 0;
 221     }
 222
 223     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
 224         type_label = "DH Private-Key";
 225     else if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
 226         type_label = "DH Public-Key";
 227     else if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
 228         type_label = "DH Parameters";
 229
 230     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
 231         priv_key = DH_get0_priv_key(dh);
 232         if (priv_key == NULL) {
 233             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_A_PRIVATE_KEY);
 234             return 0;
 235         }
 236     }
 237     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
 238         pub_key = DH_get0_pub_key(dh);
 239         if (pub_key == NULL) {
 240             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_A_PUBLIC_KEY);
 241             return 0;
 242         }
 243     }
 244     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0) {
 245         params = dh_get0_params((DH *)dh);
 246         if (params == NULL) {
 247             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_PARAMETERS);
 248             return 0;
 249         }
 250     }
 251
 252     p = DH_get0_p(dh);
 253     if (p == NULL) {
 254         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
 255         return 0;
 256     }
 257
 258     if (BIO_printf(out, "%s: (%d bit)\n", type_label, BN_num_bits(p)) <= 0)
 259         return 0;
 260     if (priv_key != NULL
 261         && !print_labeled_bignum(out, "private-key:", priv_key))
 262         return 0;
 263     if (pub_key != NULL
 264         && !print_labeled_bignum(out, "public-key:", pub_key))
 265         return 0;
 266     if (params != NULL
 267         && !ffc_params_to_text(out, params))
 268         return 0;
 269
 270     return 1;
 271 }
 272
 273 # define dh_input_type          "DH"
 274 # define dhx_input_type         "DHX"
 275 #endif
 276
 277 /* ---------------------------------------------------------------------- */
 278
 279 #ifndef OPENSSL_NO_DSA
 280 static int dsa_to_text(BIO *out, const void *key, int selection)
 281 {
 282     const DSA *dsa = key;
 283     const char *type_label = NULL;
 284     const BIGNUM *priv_key = NULL, *pub_key = NULL;
 285     const FFC_PARAMS *params = NULL;
 286     const BIGNUM *p = NULL;
 287
 288     if (out == NULL || dsa == NULL) {
 289         ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_NULL_PARAMETER);
 290         return 0;
 291     }
 292
 293     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
 294         type_label = "Private-Key";
 295     else if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
 296         type_label = "Public-Key";
 297     else if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
 298         type_label = "DSA-Parameters";
 299
 300     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
 301         priv_key = DSA_get0_priv_key(dsa);
 302         if (priv_key == NULL) {
 303             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_A_PRIVATE_KEY);
 304             return 0;
 305         }
 306     }
 307     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
 308         pub_key = DSA_get0_pub_key(dsa);
 309         if (pub_key == NULL) {
 310             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_A_PUBLIC_KEY);
 311             return 0;
 312         }
 313     }
 314     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0) {
 315         params = dsa_get0_params((DSA *)dsa);
 316         if (params == NULL) {
 317             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_PARAMETERS);
 318             return 0;
 319         }
 320     }
 321
 322     p = DSA_get0_p(dsa);
 323     if (p == NULL) {
 324         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
 325         return 0;
 326     }
 327
 328     if (BIO_printf(out, "%s: (%d bit)\n", type_label, BN_num_bits(p)) <= 0)
 329         return 0;
 330     if (priv_key != NULL
 331         && !print_labeled_bignum(out, "priv:", priv_key))
 332         return 0;
 333     if (pub_key != NULL
 334         && !print_labeled_bignum(out, "pub: ", pub_key))
 335         return 0;
 336     if (params != NULL
 337         && !ffc_params_to_text(out, params))
 338         return 0;
 339
 340     return 1;
 341 }
 342
 343 # define dsa_input_type         "DSA"
 344 #endif
 345
 346 /* ---------------------------------------------------------------------- */
 347
 348 #ifndef OPENSSL_NO_EC
 349 static int ec_param_explicit_curve_to_text(BIO *out, const EC_GROUP *group,
 350                                            BN_CTX *ctx)
 351 {
 352     const char *plabel = "Prime:";
 353     BIGNUM *p = NULL, *a = NULL, *b = NULL;
 354
 355     p = BN_CTX_get(ctx);
 356     a = BN_CTX_get(ctx);
 357     b = BN_CTX_get(ctx);
 358     if (b == NULL
 359         || !EC_GROUP_get_curve(group, p, a, b, ctx))
 360         return 0;
 361
 362     if (EC_GROUP_get_field_type(group) == NID_X9_62_characteristic_two_field) {
 363         int basis_type = EC_GROUP_get_basis_type(group);
 364
 365         /* print the 'short name' of the base type OID */
 366         if (basis_type == NID_undef
 367             || BIO_printf(out, "Basis Type: %s\n", OBJ_nid2sn(basis_type)) <= 0)
 368             return 0;
 369         plabel = "Polynomial:";
 370     }
 371     return print_labeled_bignum(out, plabel, p)
 372         && print_labeled_bignum(out, "A:   ", a)
 373         && print_labeled_bignum(out, "B:   ", b);
 374 }
 375
 376 static int ec_param_explicit_gen_to_text(BIO *out, const EC_GROUP *group,
 377                                          BN_CTX *ctx)
 378 {
 379     const EC_POINT *point = NULL;
 380     BIGNUM *gen = NULL;
 381     const char *glabel = NULL;
 382     point_conversion_form_t form;
 383
 384     form = EC_GROUP_get_point_conversion_form(group);
 385     point = EC_GROUP_get0_generator(group);
 386     gen = BN_CTX_get(ctx);
 387
 388     if (gen == NULL
 389         || point == NULL
 390         || EC_POINT_point2bn(group, point, form, gen, ctx) == NULL)
 391         return 0;
 392
 393     if (gen != NULL) {
 394         switch (form) {
 395         case POINT_CONVERSION_COMPRESSED:
 396            glabel = "Generator (compressed):";
 397            break;
 398         case POINT_CONVERSION_UNCOMPRESSED:
 399             glabel = "Generator (uncompressed):";
 400             break;
 401         case POINT_CONVERSION_HYBRID:
 402             glabel = "Generator (hybrid):";
 403             break;
 404         default:
 405             return 0;
 406         }
 407         return print_labeled_bignum(out, glabel, gen);
 408     }
 409     return 1;
 410 }
 411
 412 /* Print explicit parameters */
 413 static int ec_param_explicit_to_text(BIO *out, const EC_GROUP *group,
 414                                      OPENSSL_CTX *libctx)
 415 {
 416     int ret = 0, tmp_nid;
 417     BN_CTX *ctx = NULL;
 418     const BIGNUM *order = NULL, *cofactor = NULL;
 419     const unsigned char *seed;
 420     size_t seed_len = 0;
 421
 422     ctx = BN_CTX_new_ex(libctx);
 423     if (ctx == NULL)
 424         return 0;
 425     BN_CTX_start(ctx);
 426
 427     tmp_nid = EC_GROUP_get_field_type(group);
 428     order = EC_GROUP_get0_order(group);
 429     if (order == NULL)
 430         goto err;
 431
 432     seed = EC_GROUP_get0_seed(group);
 433     if (seed != NULL)
 434         seed_len = EC_GROUP_get_seed_len(group);
 435     cofactor = EC_GROUP_get0_cofactor(group);
 436
 437     /* print the 'short name' of the field type */
 438     if (BIO_printf(out, "Field Type: %s\n", OBJ_nid2sn(tmp_nid)) <= 0
 439         || !ec_param_explicit_curve_to_text(out, group, ctx)
 440         || !ec_param_explicit_gen_to_text(out, group, ctx)
 441         || !print_labeled_bignum(out, "Order: ", order)
 442         || (cofactor != NULL
 443             && !print_labeled_bignum(out, "Cofactor: ", cofactor))
 444         || (seed != NULL
 445             && !print_labeled_buf(out, "Seed:", seed, seed_len)))
 446         goto err;
 447     ret = 1;
 448 err:
 449     BN_CTX_end(ctx);
 450     BN_CTX_free(ctx);
 451     return ret;
 452 }
 453
 454 static int ec_param_to_text(BIO *out, const EC_GROUP *group,
 455                             OPENSSL_CTX *libctx)
 456 {
 457     if (EC_GROUP_get_asn1_flag(group) & OPENSSL_EC_NAMED_CURVE) {
 458         const char *curve_name;
 459         int curve_nid = EC_GROUP_get_curve_name(group);
 460
 461         /* Explicit parameters */
 462         if (curve_nid == NID_undef)
 463             return 0;
 464
 465         if (BIO_printf(out, "%s: %s\n", "ASN1 OID", OBJ_nid2sn(curve_nid)) <= 0)
 466             return 0;
 467
 468         curve_name = EC_curve_nid2nist(curve_nid);
 469         return (curve_name == NULL
 470                 || BIO_printf(out, "%s: %s\n", "NIST CURVE", curve_name) > 0);
 471     } else {
 472         return ec_param_explicit_to_text(out, group, libctx);
 473     }
 474 }
 475
 476 static int ec_to_text(BIO *out, const void *key, int selection)
 477 {
 478     const EC_KEY *ec = key;
 479     const char *type_label = NULL;
 480     unsigned char *priv = NULL, *pub = NULL;
 481     size_t priv_len = 0, pub_len = 0;
 482     const EC_GROUP *group;
 483     int ret = 0;
 484
 485     if (out == NULL || ec == NULL) {
 486         ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_NULL_PARAMETER);
 487         return 0;
 488     }
 489
 490     if ((group = EC_KEY_get0_group(ec)) == NULL) {
 491         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
 492         return 0;
 493     }
 494
 495     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
 496         type_label = "Private-Key";
 497     else if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
 498         type_label = "Public-Key";
 499     else if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
 500         type_label = "EC-Parameters";
 501
 502     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
 503         const BIGNUM *priv_key = EC_KEY_get0_private_key(ec);
 504
 505         if (priv_key == NULL) {
 506             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_A_PRIVATE_KEY);
 507             goto err;
 508         }
 509         priv_len = EC_KEY_priv2buf(ec, &priv);
 510         if (priv_len == 0)
 511             goto err;
 512     }
 513     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
 514         const EC_POINT *pub_pt = EC_KEY_get0_public_key(ec);
 515
 516         if (pub_pt == NULL) {
 517             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_A_PUBLIC_KEY);
 518             goto err;
 519         }
 520
 521         pub_len = EC_KEY_key2buf(ec, EC_KEY_get_conv_form(ec), &pub, NULL);
 522         if (pub_len == 0)
 523             goto err;
 524     }
 525
 526     if (BIO_printf(out, "%s: (%d bit)\n", type_label,
 527                    EC_GROUP_order_bits(group)) <= 0)
 528         goto err;
 529     if (priv != NULL
 530         && !print_labeled_buf(out, "priv:", priv, priv_len))
 531         goto err;
 532     if (pub != NULL
 533         && !print_labeled_buf(out, "pub:", pub, pub_len))
 534         goto err;
 535     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
 536         ret = ec_param_to_text(out, group, ec_key_get_libctx(ec));
 537 err:
 538     OPENSSL_clear_free(priv, priv_len);
 539     OPENSSL_free(pub);
 540     return ret;
 541 }
 542
 543 # define ec_input_type          "EC"
 544 #endif
 545
 546 /* ---------------------------------------------------------------------- */
 547
 548 #ifndef OPENSSL_NO_EC
 549 static int ecx_to_text(BIO *out, const void *key, int selection)
 550 {
 551     const ECX_KEY *ecx = key;
 552     const char *type_label = NULL;
 553
 554     if (out == NULL || ecx == NULL) {
 555         ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_NULL_PARAMETER);
 556         return 0;
 557     }
 558
 559     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
 560         if (ecx->privkey == NULL) {
 561             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_A_PRIVATE_KEY);
 562             return 0;
 563         }
 564
 565         switch (ecx->type) {
 566         case ECX_KEY_TYPE_X25519:
 567             type_label = "X25519 Private-Key";
 568             break;
 569         case ECX_KEY_TYPE_X448:
 570             type_label = "X448 Private-Key";
 571             break;
 572         case ECX_KEY_TYPE_ED25519:
 573             type_label = "ED25519 Private-Key";
 574             break;
 575         case ECX_KEY_TYPE_ED448:
 576             type_label = "ED448 Private-Key";
 577             break;
 578         }
 579     } else if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
 580         /* ecx->pubkey is an array, not a pointer... */
 581         if (!ecx->haspubkey) {
 582             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_A_PUBLIC_KEY);
 583             return 0;
 584         }
 585
 586         switch (ecx->type) {
 587         case ECX_KEY_TYPE_X25519:
 588             type_label = "X25519 Public-Key";
 589             break;
 590         case ECX_KEY_TYPE_X448:
 591             type_label = "X448 Public-Key";
 592             break;
 593         case ECX_KEY_TYPE_ED25519:
 594             type_label = "ED25519 Public-Key";
 595             break;
 596         case ECX_KEY_TYPE_ED448:
 597             type_label = "ED448 Public-Key";
 598             break;
 599         }
 600     }
 601
 602     if (BIO_printf(out, "%s:\n", type_label) <= 0)
 603         return 0;
 604     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0
 605         && !print_labeled_buf(out, "priv:", ecx->privkey, ecx->keylen))
 606         return 0;
 607     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0
 608         && !print_labeled_buf(out, "pub:", ecx->pubkey, ecx->keylen))
 609         return 0;
 610
 611     return 1;
 612 }
 613
 614 # define ed25519_input_type     "ED25519"
 615 # define ed448_input_type       "ED448"
 616 # define x25519_input_type      "X25519"
 617 # define x448_input_type        "X448"
 618 #endif
 619
 620 /* ---------------------------------------------------------------------- */
 621
 622 static int rsa_to_text(BIO *out, const void *key, int selection)
 623 {
 624     const RSA *rsa = key;
 625     const char *type_label = "RSA key";
 626     const char *modulus_label;
 627     const char *exponent_label;
 628     const BIGNUM *rsa_d = NULL, *rsa_n = NULL, *rsa_e = NULL;
 629     STACK_OF(BIGNUM_const) *factors = NULL;
 630     STACK_OF(BIGNUM_const) *exps = NULL;
 631     STACK_OF(BIGNUM_const) *coeffs = NULL;
 632     int primes;
 633     const RSA_PSS_PARAMS_30 *pss_params = rsa_get0_pss_params_30((RSA *)rsa);
 634     int ret = 0;
 635
 636     if (out == NULL || rsa == NULL) {
 637         ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_NULL_PARAMETER);
 638         goto err;
 639     }
 640
 641     factors = sk_BIGNUM_const_new_null();
 642     exps = sk_BIGNUM_const_new_null();
 643     coeffs = sk_BIGNUM_const_new_null();
 644
 645     if (factors == NULL || exps == NULL || coeffs == NULL) {
 646         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
 647         goto err;
 648     }
 649
 650     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
 651         type_label = "Private-Key";
 652         modulus_label = "modulus:";
 653         exponent_label = "publicExponent:";
 654     } else if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
 655         type_label = "Public-Key";
 656         modulus_label = "Modulus:";
 657         exponent_label = "Exponent:";
 658     }
 659
 660     RSA_get0_key(rsa, &rsa_n, &rsa_e, &rsa_d);
 661     rsa_get0_all_params((RSA *)rsa, factors, exps, coeffs);
 662     primes = sk_BIGNUM_const_num(factors);
 663
 664     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
 665         if (BIO_printf(out, "%s: (%d bit, %d primes)\n",
 666                        type_label, BN_num_bits(rsa_n), primes) <= 0)
 667             goto err;
 668     } else {
 669         if (BIO_printf(out, "%s: (%d bit)\n",
 670                        type_label, BN_num_bits(rsa_n)) <= 0)
 671             goto err;
 672     }
 673
 674     if (!print_labeled_bignum(out, modulus_label, rsa_n))
 675         goto err;
 676     if (!print_labeled_bignum(out, exponent_label, rsa_e))
 677         goto err;
 678     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
 679         int i;
 680
 681         if (!print_labeled_bignum(out, "privateExponent:", rsa_d))
 682             goto err;
 683         if (!print_labeled_bignum(out, "prime1:",
 684                                   sk_BIGNUM_const_value(factors, 0)))
 685             goto err;
 686         if (!print_labeled_bignum(out, "prime2:",
 687                                   sk_BIGNUM_const_value(factors, 1)))
 688             goto err;
 689         if (!print_labeled_bignum(out, "exponent1:",
 690                                   sk_BIGNUM_const_value(exps, 0)))
 691             goto err;
 692         if (!print_labeled_bignum(out, "exponent2:",
 693                                   sk_BIGNUM_const_value(exps, 1)))
 694             goto err;
 695         if (!print_labeled_bignum(out, "coefficient:",
 696                                   sk_BIGNUM_const_value(coeffs, 0)))
 697             goto err;
 698         for (i = 2; i < sk_BIGNUM_const_num(factors); i++) {
 699             if (BIO_printf(out, "prime%d:", i + 1) <= 0)
 700                 goto err;
 701             if (!print_labeled_bignum(out, NULL,
 702                                       sk_BIGNUM_const_value(factors, i)))
 703                 goto err;
 704             if (BIO_printf(out, "exponent%d:", i + 1) <= 0)
 705                 goto err;
 706             if (!print_labeled_bignum(out, NULL,
 707                                       sk_BIGNUM_const_value(exps, i)))
 708                 goto err;
 709             if (BIO_printf(out, "coefficient%d:", i + 1) <= 0)
 710                 goto err;
 711             if (!print_labeled_bignum(out, NULL,
 712                                       sk_BIGNUM_const_value(coeffs, i - 1)))
 713                 goto err;
 714         }
 715     }
 716
 717     if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0) {
 718         switch (RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK)) {
 719         case RSA_FLAG_TYPE_RSA:
 720             if (!rsa_pss_params_30_is_unrestricted(pss_params)) {
 721                 if (BIO_printf(out, "(INVALID PSS PARAMETERS)\n") <= 0)
 722                     goto err;
 723             }
 724             break;
 725         case RSA_FLAG_TYPE_RSASSAPSS:
 726             if (rsa_pss_params_30_is_unrestricted(pss_params)) {
 727                 if (BIO_printf(out, "No PSS parameter restrictions\n") <= 0)
 728                     goto err;
 729             } else {
 730                 int hashalg_nid = rsa_pss_params_30_hashalg(pss_params);
 731                 int maskgenalg_nid = rsa_pss_params_30_maskgenalg(pss_params);
 732                 int maskgenhashalg_nid =
 733                     rsa_pss_params_30_maskgenhashalg(pss_params);
 734                 int saltlen = rsa_pss_params_30_saltlen(pss_params);
 735                 int trailerfield = rsa_pss_params_30_trailerfield(pss_params);
 736
 737                 if (BIO_printf(out, "PSS parameter restrictions:\n") <= 0)
 738                     goto err;
 739                 if (BIO_printf(out, "  Hash Algorithm: %s%s\n",
 740                                rsa_oaeppss_nid2name(hashalg_nid),
 741                                (hashalg_nid == NID_sha1
 742                                 ? " (default)" : "")) <= 0)
 743                     goto err;
 744                 if (BIO_printf(out, "  Mask Algorithm: %s with %s%s\n",
 745                                rsa_mgf_nid2name(maskgenalg_nid),
 746                                rsa_oaeppss_nid2name(maskgenhashalg_nid),
 747                                (maskgenalg_nid == NID_mgf1
 748                                 && maskgenhashalg_nid == NID_sha1
 749                                 ? " (default)" : "")) <= 0)
 750                     goto err;
 751                 if (BIO_printf(out, "  Minimum Salt Length: %d%s\n",
 752                                saltlen,
 753                                (saltlen == 20 ? " (default)" : "")) <= 0)
 754                     goto err;
 755                 /*
 756                  * TODO(3.0) Should we show the ASN.1 trailerField value, or
 757                  * the actual trailerfield byte (i.e. 0xBC for 1)?
 758                  * crypto/rsa/rsa_ameth.c isn't very clear on that, as it
 759                  * does display 0xBC when the default applies, but the ASN.1
 760                  * trailerField value otherwise...
 761                  */
 762                 if (BIO_printf(out, "  Trailer Field: 0x%x%s\n",
 763                                trailerfield,
 764                                (trailerfield == 1 ? " (default)" : "")) <= 0)
 765                     goto err;
 766             }
 767             break;
 768         }
 769     }
 770
 771     ret = 1;
 772  err:
 773     sk_BIGNUM_const_free(factors);
 774     sk_BIGNUM_const_free(exps);
 775     sk_BIGNUM_const_free(coeffs);
 776     return ret;
 777 }
 778
 779 #define rsa_input_type          "RSA"
 780 #define rsapss_input_type       "RSA-PSS"
 781
 782 /* ---------------------------------------------------------------------- */
 783
 784 static void *key2text_newctx(void *provctx)
 785 {
 786     return provctx;
 787 }
 788
 789 static void key2text_freectx(ossl_unused void *vctx)
 790 {
 791 }
 792
 793 static const OSSL_PARAM *key2text_gettable_params(void *provctx)
 794 {
 795     static const OSSL_PARAM gettables[] = {
 796         { OSSL_ENCODER_PARAM_OUTPUT_TYPE, OSSL_PARAM_UTF8_PTR, NULL, 0, 0 },
 797         OSSL_PARAM_END,
 798     };
 799
 800     return gettables;
 801 }
 802
 803 static int key2text_get_params(OSSL_PARAM params[], const char *input_type)
 804 {
 805     OSSL_PARAM *p;
 806
 807     p = OSSL_PARAM_locate(params, OSSL_ENCODER_PARAM_INPUT_TYPE);
 808     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, input_type))
 809         return 0;
 810
 811     p = OSSL_PARAM_locate(params, OSSL_ENCODER_PARAM_OUTPUT_TYPE);
 812     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "TEXT"))
 813         return 0;
 814
 815     return 1;
 816 }
 817
 818 static int key2text_encode(void *vctx, const void *key, int selection,
 819                            OSSL_CORE_BIO *cout,
 820                            int (*key2text)(BIO *out, const void *key,
 821                                            int selection),
 822                            OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
 823 {
 824     BIO *out = bio_new_from_core_bio(vctx, cout);
 825     int ret;
 826
 827     if (out == NULL)
 828         return 0;
 829
 830     ret = key2text(out, key, selection);
 831     BIO_free(out);
 832
 833     return ret;
 834 }
 835
 836 #define MAKE_TEXT_ENCODER(impl, type)                                   \
 837     static OSSL_FUNC_encoder_get_params_fn                              \
 838     impl##2text_get_params;                                             \
 839     static OSSL_FUNC_encoder_import_object_fn                           \
 840     impl##2text_import_object;                                          \
 841     static OSSL_FUNC_encoder_free_object_fn                             \
 842     impl##2text_free_object;                                            \
 843     static OSSL_FUNC_encoder_encode_fn impl##2text_encode;              \
 844                                                                         \
 845     static int impl##2text_get_params(OSSL_PARAM params[])              \
 846     {                                                                   \
 847         return key2text_get_params(params, impl##_input_type);           \
 848     }                                                                   \
 849     static void *impl##2text_import_object(void *ctx, int selection,    \
 850                                            const OSSL_PARAM params[])   \
 851     {                                                                   \
 852         return ossl_prov_import_key(impl##_keymgmt_functions,           \
 853                                     ctx, selection, params);            \
 854     }                                                                   \
 855     static void impl##2text_free_object(void *key)                      \
 856     {                                                                   \
 857         ossl_prov_free_key(impl##_keymgmt_functions, key);              \
 858     }                                                                   \
 859     static int impl##2text_encode(void *vctx, OSSL_CORE_BIO *cout,      \
 860                                   const void *key,                      \
 861                                   const OSSL_PARAM key_abstract[],      \
 862                                   int selection,                        \
 863                                   OSSL_PASSPHRASE_CALLBACK *cb,         \
 864                                   void *cbarg)                          \
 865     {                                                                   \
 866         /* We don't deal with abstract objects */                       \
 867         if (key_abstract != NULL) {                                     \
 868             ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);     \
 869             return 0;                                                   \
 870         }                                                               \
 871         return key2text_encode(vctx, key, selection, cout,              \
 872                                type##_to_text, cb, cbarg);              \
 873     }                                                                   \
 874     const OSSL_DISPATCH impl##_to_text_encoder_functions[] = {          \
 875         { OSSL_FUNC_ENCODER_NEWCTX,                                     \
 876           (void (*)(void))key2text_newctx },                            \
 877         { OSSL_FUNC_ENCODER_FREECTX,                                    \
 878           (void (*)(void))key2text_freectx },                           \
 879         { OSSL_FUNC_ENCODER_GETTABLE_PARAMS,                            \
 880           (void (*)(void))key2text_gettable_params },                   \
 881         { OSSL_FUNC_ENCODER_GET_PARAMS,                                 \
 882           (void (*)(void))impl##2text_get_params },                     \
 883         { OSSL_FUNC_ENCODER_IMPORT_OBJECT,                              \
 884           (void (*)(void))impl##2text_import_object },                  \
 885         { OSSL_FUNC_ENCODER_FREE_OBJECT,                                \
 886           (void (*)(void))impl##2text_free_object },                    \
 887         { OSSL_FUNC_ENCODER_ENCODE,                                     \
 888           (void (*)(void))impl##2text_encode },                         \
 889         { 0, NULL }                                                     \
 890     }
 891
 892 #ifndef OPENSSL_NO_DH
 893 MAKE_TEXT_ENCODER(dh, dh);
 894 MAKE_TEXT_ENCODER(dhx, dh);
 895 #endif
 896 #ifndef OPENSSL_NO_DSA
 897 MAKE_TEXT_ENCODER(dsa, dsa);
 898 #endif
 899 #ifndef OPENSSL_NO_EC
 900 MAKE_TEXT_ENCODER(ec, ec);
 901 MAKE_TEXT_ENCODER(ed25519, ecx);
 902 MAKE_TEXT_ENCODER(ed448, ecx);
 903 MAKE_TEXT_ENCODER(x25519, ecx);
 904 MAKE_TEXT_ENCODER(x448, ecx);
 905 #endif
 906 MAKE_TEXT_ENCODER(rsa, rsa);
 907 MAKE_TEXT_ENCODER(rsapss, rsa);