util/perl/OpenSSL/paramnames.pm

   1 #! /usr/bin/env perl
   2 # Copyright 2023 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 package OpenSSL::paramnames;
  10
  11 use strict;
  12 use warnings;
  13
  14 require Exporter;
  15 our @ISA = qw(Exporter);
  16 our @EXPORT_OK = qw(generate_public_macros
  17                     generate_internal_macros
  18                     produce_decoder);
  19
  20 my $case_sensitive = 1;
  21
  22 my %params = (
  23 # Well known parameter names that core passes to providers
  24     'PROV_PARAM_CORE_VERSION' =>         "openssl-version",# utf8_ptr
  25     'PROV_PARAM_CORE_PROV_NAME' =>       "provider-name",  # utf8_ptr
  26     'PROV_PARAM_CORE_MODULE_FILENAME' => "module-filename",# utf8_ptr
  27
  28 # Well known parameter names that Providers can define
  29     'PROV_PARAM_NAME' =>               "name",               # utf8_ptr
  30     'PROV_PARAM_VERSION' =>            "version",            # utf8_ptr
  31     'PROV_PARAM_BUILDINFO' =>          "buildinfo",          # utf8_ptr
  32     'PROV_PARAM_STATUS' =>             "status",             # uint
  33     'PROV_PARAM_SECURITY_CHECKS' =>    "security-checks",    # uint
  34     'PROV_PARAM_TLS1_PRF_EMS_CHECK' => "tls1-prf-ems-check", # uint
  35     'PROV_PARAM_DRBG_TRUNC_DIGEST' =>  "drbg-no-trunc-md",   # uint
  36
  37 # Self test callback parameters
  38     'PROV_PARAM_SELF_TEST_PHASE' =>  "st-phase",# utf8_string
  39     'PROV_PARAM_SELF_TEST_TYPE' =>   "st-type", # utf8_string
  40     'PROV_PARAM_SELF_TEST_DESC' =>   "st-desc", # utf8_string
  41
  42 # Provider-native object abstractions
  43 #
  44 # These are used when a provider wants to pass object data or an object
  45 # reference back to libcrypto.  This is only useful for provider functions
  46 # that take a callback to which an PARAM array with these parameters
  47 # can be passed.
  48 #
  49 # This set of parameter names is explained in detail in provider-object(7)
  50 # (doc/man7/provider-object.pod)
  51
  52     'OBJECT_PARAM_TYPE' =>              "type",     # INTEGER
  53     'OBJECT_PARAM_DATA_TYPE' =>         "data-type",# UTF8_STRING
  54     'OBJECT_PARAM_DATA_STRUCTURE' =>    "data-structure",# UTF8_STRING
  55     'OBJECT_PARAM_REFERENCE' =>         "reference",# OCTET_STRING
  56     'OBJECT_PARAM_DATA' =>              "data",# OCTET_STRING or UTF8_STRING
  57     'OBJECT_PARAM_DESC' =>              "desc",     # UTF8_STRING
  58
  59 # Algorithm parameters
  60 # If "engine",or "properties",are specified, they should always be paired
  61 # with the algorithm type.
  62 # Note these are common names that are shared by many types (such as kdf, mac,
  63 # and pkey) e.g: see MAC_PARAM_DIGEST below.
  64
  65     'ALG_PARAM_DIGEST' =>       "digest",       # utf8_string
  66     'ALG_PARAM_CIPHER' =>       "cipher",       # utf8_string
  67     'ALG_PARAM_ENGINE' =>       "engine",       # utf8_string
  68     'ALG_PARAM_MAC' =>          "mac",          # utf8_string
  69     'ALG_PARAM_PROPERTIES' =>   "properties",   # utf8_string
  70
  71 # cipher parameters
  72     'CIPHER_PARAM_PADDING' =>              "padding",     # uint
  73     'CIPHER_PARAM_USE_BITS' =>             "use-bits",    # uint
  74     'CIPHER_PARAM_TLS_VERSION' =>          "tls-version", # uint
  75     'CIPHER_PARAM_TLS_MAC' =>              "tls-mac",     # octet_ptr
  76     'CIPHER_PARAM_TLS_MAC_SIZE' =>         "tls-mac-size",# size_t
  77     'CIPHER_PARAM_MODE' =>                 "mode",        # uint
  78     'CIPHER_PARAM_BLOCK_SIZE' =>           "blocksize",   # size_t
  79     'CIPHER_PARAM_AEAD' =>                 "aead",        # int, 0 or 1
  80     'CIPHER_PARAM_CUSTOM_IV' =>            "custom-iv",   # int, 0 or 1
  81     'CIPHER_PARAM_CTS' =>                  "cts",         # int, 0 or 1
  82     'CIPHER_PARAM_TLS1_MULTIBLOCK' =>      "tls-multi",   # int, 0 or 1
  83     'CIPHER_PARAM_HAS_RAND_KEY' =>         "has-randkey", # int, 0 or 1
  84     'CIPHER_PARAM_KEYLEN' =>               "keylen",      # size_t
  85     'CIPHER_PARAM_IVLEN' =>                "ivlen",       # size_t
  86     'CIPHER_PARAM_IV' =>                   "iv",          # octet_string OR octet_ptr
  87     'CIPHER_PARAM_UPDATED_IV' =>           "updated-iv",  # octet_string OR octet_ptr
  88     'CIPHER_PARAM_NUM' =>                  "num",         # uint
  89     'CIPHER_PARAM_ROUNDS' =>               "rounds",      # uint
  90     'CIPHER_PARAM_AEAD_TAG' =>             "tag",         # octet_string
  91     'CIPHER_PARAM_AEAD_TLS1_AAD' =>        "tlsaad",      # octet_string
  92     'CIPHER_PARAM_AEAD_TLS1_AAD_PAD' =>    "tlsaadpad",   # size_t
  93     'CIPHER_PARAM_AEAD_TLS1_IV_FIXED' =>   "tlsivfixed",  # octet_string
  94     'CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN' => "tlsivgen",    # octet_string
  95     'CIPHER_PARAM_AEAD_TLS1_SET_IV_INV' => "tlsivinv",    # octet_string
  96     'CIPHER_PARAM_AEAD_IVLEN' =>           '*CIPHER_PARAM_IVLEN',
  97     'CIPHER_PARAM_AEAD_TAGLEN' =>          "taglen",      # size_t
  98     'CIPHER_PARAM_AEAD_MAC_KEY' =>         "mackey",      # octet_string
  99     'CIPHER_PARAM_RANDOM_KEY' =>           "randkey",     # octet_string
 100     'CIPHER_PARAM_RC2_KEYBITS' =>          "keybits",     # size_t
 101     'CIPHER_PARAM_SPEED' =>                "speed",       # uint
 102     'CIPHER_PARAM_CTS_MODE' =>             "cts_mode",    # utf8_string
 103 # For passing the AlgorithmIdentifier parameter in DER form
 104     'CIPHER_PARAM_ALGORITHM_ID_PARAMS' =>  "alg_id_param",# octet_string
 105     'CIPHER_PARAM_XTS_STANDARD' =>         "xts_standard",# utf8_string
 106
 107     'CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT' =>  "tls1multi_maxsndfrag",# uint
 108     'CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE' =>        "tls1multi_maxbufsz",  # size_t
 109     'CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE' =>         "tls1multi_interleave",# uint
 110     'CIPHER_PARAM_TLS1_MULTIBLOCK_AAD' =>                "tls1multi_aad",       # octet_string
 111     'CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN' =>        "tls1multi_aadpacklen",# uint
 112     'CIPHER_PARAM_TLS1_MULTIBLOCK_ENC' =>                "tls1multi_enc",       # octet_string
 113     'CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN' =>             "tls1multi_encin",     # octet_string
 114     'CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN' =>            "tls1multi_enclen",    # size_t
 115
 116 # digest parameters
 117     'DIGEST_PARAM_XOFLEN' =>       "xoflen",       # size_t
 118     'DIGEST_PARAM_SSL3_MS' =>      "ssl3-ms",      # octet string
 119     'DIGEST_PARAM_PAD_TYPE' =>     "pad-type",     # uint
 120     'DIGEST_PARAM_MICALG' =>       "micalg",       # utf8 string
 121     'DIGEST_PARAM_BLOCK_SIZE' =>   "blocksize",    # size_t
 122     'DIGEST_PARAM_SIZE' =>         "size",         # size_t
 123     'DIGEST_PARAM_XOF' =>          "xof",          # int, 0 or 1
 124     'DIGEST_PARAM_ALGID_ABSENT' => "algid-absent", # int, 0 or 1
 125
 126 # MAC parameters
 127     'MAC_PARAM_KEY' =>            "key",           # octet string
 128     'MAC_PARAM_IV' =>             "iv",            # octet string
 129     'MAC_PARAM_CUSTOM' =>         "custom",        # utf8 string
 130     'MAC_PARAM_SALT' =>           "salt",          # octet string
 131     'MAC_PARAM_XOF' =>            "xof",           # int, 0 or 1
 132     'MAC_PARAM_DIGEST_NOINIT' =>  "digest-noinit", # int, 0 or 1
 133     'MAC_PARAM_DIGEST_ONESHOT' => "digest-oneshot",# int, 0 or 1
 134     'MAC_PARAM_C_ROUNDS' =>       "c-rounds",      # unsigned int
 135     'MAC_PARAM_D_ROUNDS' =>       "d-rounds",      # unsigned int
 136
 137 # If "engine",or "properties",are specified, they should always be paired
 138 # with "cipher",or "digest".
 139
 140     'MAC_PARAM_CIPHER' =>           '*ALG_PARAM_CIPHER',        # utf8 string
 141     'MAC_PARAM_DIGEST' =>           '*ALG_PARAM_DIGEST',        # utf8 string
 142     'MAC_PARAM_PROPERTIES' =>       '*ALG_PARAM_PROPERTIES',    # utf8 string
 143     'MAC_PARAM_SIZE' =>             "size",                     # size_t
 144     'MAC_PARAM_BLOCK_SIZE' =>       "block-size",               # size_t
 145     'MAC_PARAM_TLS_DATA_SIZE' =>    "tls-data-size",            # size_t
 146
 147 # KDF / PRF parameters
 148     'KDF_PARAM_SECRET' =>       "secret",                   # octet string
 149     'KDF_PARAM_KEY' =>          "key",                      # octet string
 150     'KDF_PARAM_SALT' =>         "salt",                     # octet string
 151     'KDF_PARAM_PASSWORD' =>     "pass",                     # octet string
 152     'KDF_PARAM_PREFIX' =>       "prefix",                   # octet string
 153     'KDF_PARAM_LABEL' =>        "label",                    # octet string
 154     'KDF_PARAM_DATA' =>         "data",                     # octet string
 155     'KDF_PARAM_DIGEST' =>       '*ALG_PARAM_DIGEST',        # utf8 string
 156     'KDF_PARAM_CIPHER' =>       '*ALG_PARAM_CIPHER',        # utf8 string
 157     'KDF_PARAM_MAC' =>          '*ALG_PARAM_MAC',           # utf8 string
 158     'KDF_PARAM_MAC_SIZE' =>     "maclen",                   # size_t
 159     'KDF_PARAM_PROPERTIES' =>   '*ALG_PARAM_PROPERTIES',    # utf8 string
 160     'KDF_PARAM_ITER' =>         "iter",                     # unsigned int
 161     'KDF_PARAM_MODE' =>         "mode",                     # utf8 string or int
 162     'KDF_PARAM_PKCS5' =>        "pkcs5",                    # int
 163     'KDF_PARAM_UKM' =>          "ukm",                      # octet string
 164     'KDF_PARAM_CEK_ALG' =>      "cekalg",                   # utf8 string
 165     'KDF_PARAM_SCRYPT_N' =>     "n",                        # uint64_t
 166     'KDF_PARAM_SCRYPT_R' =>     "r",                        # uint32_t
 167     'KDF_PARAM_SCRYPT_P' =>     "p",                        # uint32_t
 168     'KDF_PARAM_SCRYPT_MAXMEM' => "maxmem_bytes",            # uint64_t
 169     'KDF_PARAM_INFO' =>         "info",                     # octet string
 170     'KDF_PARAM_SEED' =>         "seed",                     # octet string
 171     'KDF_PARAM_SSHKDF_XCGHASH' => "xcghash",                # octet string
 172     'KDF_PARAM_SSHKDF_SESSION_ID' => "session_id",          # octet string
 173     'KDF_PARAM_SSHKDF_TYPE' =>  "type",                     # int
 174     'KDF_PARAM_SIZE' =>         "size",                     # size_t
 175     'KDF_PARAM_CONSTANT' =>     "constant",                 # octet string
 176     'KDF_PARAM_PKCS12_ID' =>    "id",                       # int
 177     'KDF_PARAM_KBKDF_USE_L' =>          "use-l",            # int
 178     'KDF_PARAM_KBKDF_USE_SEPARATOR' =>  "use-separator",    # int
 179     'KDF_PARAM_KBKDF_R' =>      "r",                        # int
 180     'KDF_PARAM_X942_ACVPINFO' =>        "acvp-info",
 181     'KDF_PARAM_X942_PARTYUINFO' =>      "partyu-info",
 182     'KDF_PARAM_X942_PARTYVINFO' =>      "partyv-info",
 183     'KDF_PARAM_X942_SUPP_PUBINFO' =>    "supp-pubinfo",
 184     'KDF_PARAM_X942_SUPP_PRIVINFO' =>   "supp-privinfo",
 185     'KDF_PARAM_X942_USE_KEYBITS' =>     "use-keybits",
 186     'KDF_PARAM_HMACDRBG_ENTROPY' =>     "entropy",
 187     'KDF_PARAM_HMACDRBG_NONCE' =>       "nonce",
 188     'KDF_PARAM_THREADS' =>        "threads",                # uint32_t
 189     'KDF_PARAM_EARLY_CLEAN' =>    "early_clean",            # uint32_t
 190     'KDF_PARAM_ARGON2_AD' =>      "ad",                     # octet string
 191     'KDF_PARAM_ARGON2_LANES' =>   "lanes",                  # uint32_t
 192     'KDF_PARAM_ARGON2_MEMCOST' => "memcost",                # uint32_t
 193     'KDF_PARAM_ARGON2_VERSION' => "version",                # uint32_t
 194
 195 # Known RAND names
 196     'RAND_PARAM_STATE' =>                   "state",
 197     'RAND_PARAM_STRENGTH' =>                "strength",
 198     'RAND_PARAM_MAX_REQUEST' =>             "max_request",
 199     'RAND_PARAM_TEST_ENTROPY' =>            "test_entropy",
 200     'RAND_PARAM_TEST_NONCE' =>              "test_nonce",
 201
 202 # RAND/DRBG names
 203     'DRBG_PARAM_RESEED_REQUESTS' =>         "reseed_requests",
 204     'DRBG_PARAM_RESEED_TIME_INTERVAL' =>    "reseed_time_interval",
 205     'DRBG_PARAM_MIN_ENTROPYLEN' =>          "min_entropylen",
 206     'DRBG_PARAM_MAX_ENTROPYLEN' =>          "max_entropylen",
 207     'DRBG_PARAM_MIN_NONCELEN' =>            "min_noncelen",
 208     'DRBG_PARAM_MAX_NONCELEN' =>            "max_noncelen",
 209     'DRBG_PARAM_MAX_PERSLEN' =>             "max_perslen",
 210     'DRBG_PARAM_MAX_ADINLEN' =>             "max_adinlen",
 211     'DRBG_PARAM_RESEED_COUNTER' =>          "reseed_counter",
 212     'DRBG_PARAM_RESEED_TIME' =>             "reseed_time",
 213     'DRBG_PARAM_PROPERTIES' =>              '*ALG_PARAM_PROPERTIES',
 214     'DRBG_PARAM_DIGEST' =>                  '*ALG_PARAM_DIGEST',
 215     'DRBG_PARAM_CIPHER' =>                  '*ALG_PARAM_CIPHER',
 216     'DRBG_PARAM_MAC' =>                     '*ALG_PARAM_MAC',
 217     'DRBG_PARAM_USE_DF' =>                  "use_derivation_function",
 218
 219 # DRBG call back parameters
 220     'DRBG_PARAM_ENTROPY_REQUIRED' =>        "entropy_required",
 221     'DRBG_PARAM_PREDICTION_RESISTANCE' =>   "prediction_resistance",
 222     'DRBG_PARAM_MIN_LENGTH' =>              "minium_length",
 223     'DRBG_PARAM_MAX_LENGTH' =>              "maxium_length",
 224     'DRBG_PARAM_RANDOM_DATA' =>             "random_data",
 225     'DRBG_PARAM_SIZE' =>                    "size",
 226
 227 # PKEY parameters
 228 # Common PKEY parameters
 229     'PKEY_PARAM_BITS' =>                "bits",# integer
 230     'PKEY_PARAM_MAX_SIZE' =>            "max-size",# integer
 231     'PKEY_PARAM_SECURITY_BITS' =>       "security-bits",# integer
 232     'PKEY_PARAM_DIGEST' =>              '*ALG_PARAM_DIGEST',
 233     'PKEY_PARAM_CIPHER' =>              '*ALG_PARAM_CIPHER', # utf8 string
 234     'PKEY_PARAM_ENGINE' =>              '*ALG_PARAM_ENGINE', # utf8 string
 235     'PKEY_PARAM_PROPERTIES' =>          '*ALG_PARAM_PROPERTIES',
 236     'PKEY_PARAM_DEFAULT_DIGEST' =>      "default-digest",# utf8 string
 237     'PKEY_PARAM_MANDATORY_DIGEST' =>    "mandatory-digest",# utf8 string
 238     'PKEY_PARAM_PAD_MODE' =>            "pad-mode",
 239     'PKEY_PARAM_DIGEST_SIZE' =>         "digest-size",
 240     'PKEY_PARAM_MASKGENFUNC' =>         "mgf",
 241     'PKEY_PARAM_MGF1_DIGEST' =>         "mgf1-digest",
 242     'PKEY_PARAM_MGF1_PROPERTIES' =>     "mgf1-properties",
 243     'PKEY_PARAM_ENCODED_PUBLIC_KEY' =>  "encoded-pub-key",
 244     'PKEY_PARAM_GROUP_NAME' =>          "group",
 245     'PKEY_PARAM_DIST_ID' =>             "distid",
 246     'PKEY_PARAM_PUB_KEY' =>             "pub",
 247     'PKEY_PARAM_PRIV_KEY' =>            "priv",
 248     'PKEY_PARAM_IMPLICIT_REJECTION' =>  "implicit-rejection",
 249
 250 # Diffie-Hellman/DSA Parameters
 251     'PKEY_PARAM_FFC_P' =>               "p",
 252     'PKEY_PARAM_FFC_G' =>               "g",
 253     'PKEY_PARAM_FFC_Q' =>               "q",
 254     'PKEY_PARAM_FFC_GINDEX' =>          "gindex",
 255     'PKEY_PARAM_FFC_PCOUNTER' =>        "pcounter",
 256     'PKEY_PARAM_FFC_SEED' =>            "seed",
 257     'PKEY_PARAM_FFC_COFACTOR' =>        "j",
 258     'PKEY_PARAM_FFC_H' =>               "hindex",
 259     'PKEY_PARAM_FFC_VALIDATE_PQ' =>     "validate-pq",
 260     'PKEY_PARAM_FFC_VALIDATE_G' =>      "validate-g",
 261     'PKEY_PARAM_FFC_VALIDATE_LEGACY' => "validate-legacy",
 262
 263 # Diffie-Hellman params
 264     'PKEY_PARAM_DH_GENERATOR' =>        "safeprime-generator",
 265     'PKEY_PARAM_DH_PRIV_LEN' =>         "priv_len",
 266
 267 # Elliptic Curve Domain Parameters
 268     'PKEY_PARAM_EC_PUB_X' =>     "qx",
 269     'PKEY_PARAM_EC_PUB_Y' =>     "qy",
 270
 271 # Elliptic Curve Explicit Domain Parameters
 272     'PKEY_PARAM_EC_FIELD_TYPE' =>                   "field-type",
 273     'PKEY_PARAM_EC_P' =>                            "p",
 274     'PKEY_PARAM_EC_A' =>                            "a",
 275     'PKEY_PARAM_EC_B' =>                            "b",
 276     'PKEY_PARAM_EC_GENERATOR' =>                    "generator",
 277     'PKEY_PARAM_EC_ORDER' =>                        "order",
 278     'PKEY_PARAM_EC_COFACTOR' =>                     "cofactor",
 279     'PKEY_PARAM_EC_SEED' =>                         "seed",
 280     'PKEY_PARAM_EC_CHAR2_M' =>                      "m",
 281     'PKEY_PARAM_EC_CHAR2_TYPE' =>                   "basis-type",
 282     'PKEY_PARAM_EC_CHAR2_TP_BASIS' =>               "tp",
 283     'PKEY_PARAM_EC_CHAR2_PP_K1' =>                  "k1",
 284     'PKEY_PARAM_EC_CHAR2_PP_K2' =>                  "k2",
 285     'PKEY_PARAM_EC_CHAR2_PP_K3' =>                  "k3",
 286     'PKEY_PARAM_EC_DECODED_FROM_EXPLICIT_PARAMS' => "decoded-from-explicit",
 287
 288 # Elliptic Curve Key Parameters
 289     'PKEY_PARAM_USE_COFACTOR_FLAG' => "use-cofactor-flag",
 290     'PKEY_PARAM_USE_COFACTOR_ECDH' => '*PKEY_PARAM_USE_COFACTOR_FLAG',
 291
 292 # RSA Keys
 293 #
 294 # n, e, d are the usual public and private key components
 295 #
 296 # rsa-num is the number of factors, including p and q
 297 # rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
 298 # rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
 299 # rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
 300 #
 301 # The number of rsa-factor items must be equal to the number of rsa-exponent
 302 # items, and the number of rsa-coefficients must be one less.
 303 # (the base i for the coefficients is 2, not 1, at least as implied by
 304 # RFC 8017)
 305
 306     'PKEY_PARAM_RSA_N' =>           "n",
 307     'PKEY_PARAM_RSA_E' =>           "e",
 308     'PKEY_PARAM_RSA_D' =>           "d",
 309     'PKEY_PARAM_RSA_FACTOR' =>      "rsa-factor",
 310     'PKEY_PARAM_RSA_EXPONENT' =>    "rsa-exponent",
 311     'PKEY_PARAM_RSA_COEFFICIENT' => "rsa-coefficient",
 312     'PKEY_PARAM_RSA_FACTOR1' =>      "rsa-factor1",
 313     'PKEY_PARAM_RSA_FACTOR2' =>      "rsa-factor2",
 314     'PKEY_PARAM_RSA_FACTOR3' =>      "rsa-factor3",
 315     'PKEY_PARAM_RSA_FACTOR4' =>      "rsa-factor4",
 316     'PKEY_PARAM_RSA_FACTOR5' =>      "rsa-factor5",
 317     'PKEY_PARAM_RSA_FACTOR6' =>      "rsa-factor6",
 318     'PKEY_PARAM_RSA_FACTOR7' =>      "rsa-factor7",
 319     'PKEY_PARAM_RSA_FACTOR8' =>      "rsa-factor8",
 320     'PKEY_PARAM_RSA_FACTOR9' =>      "rsa-factor9",
 321     'PKEY_PARAM_RSA_FACTOR10' =>     "rsa-factor10",
 322     'PKEY_PARAM_RSA_EXPONENT1' =>    "rsa-exponent1",
 323     'PKEY_PARAM_RSA_EXPONENT2' =>    "rsa-exponent2",
 324     'PKEY_PARAM_RSA_EXPONENT3' =>    "rsa-exponent3",
 325     'PKEY_PARAM_RSA_EXPONENT4' =>    "rsa-exponent4",
 326     'PKEY_PARAM_RSA_EXPONENT5' =>    "rsa-exponent5",
 327     'PKEY_PARAM_RSA_EXPONENT6' =>    "rsa-exponent6",
 328     'PKEY_PARAM_RSA_EXPONENT7' =>    "rsa-exponent7",
 329     'PKEY_PARAM_RSA_EXPONENT8' =>    "rsa-exponent8",
 330     'PKEY_PARAM_RSA_EXPONENT9' =>    "rsa-exponent9",
 331     'PKEY_PARAM_RSA_EXPONENT10' =>   "rsa-exponent10",
 332     'PKEY_PARAM_RSA_COEFFICIENT1' => "rsa-coefficient1",
 333     'PKEY_PARAM_RSA_COEFFICIENT2' => "rsa-coefficient2",
 334     'PKEY_PARAM_RSA_COEFFICIENT3' => "rsa-coefficient3",
 335     'PKEY_PARAM_RSA_COEFFICIENT4' => "rsa-coefficient4",
 336     'PKEY_PARAM_RSA_COEFFICIENT5' => "rsa-coefficient5",
 337     'PKEY_PARAM_RSA_COEFFICIENT6' => "rsa-coefficient6",
 338     'PKEY_PARAM_RSA_COEFFICIENT7' => "rsa-coefficient7",
 339     'PKEY_PARAM_RSA_COEFFICIENT8' => "rsa-coefficient8",
 340     'PKEY_PARAM_RSA_COEFFICIENT9' => "rsa-coefficient9",
 341
 342 # Key generation parameters
 343     'PKEY_PARAM_RSA_BITS' =>             '*PKEY_PARAM_BITS',
 344     'PKEY_PARAM_RSA_PRIMES' =>           "primes",
 345     'PKEY_PARAM_RSA_DIGEST' =>           '*PKEY_PARAM_DIGEST',
 346     'PKEY_PARAM_RSA_DIGEST_PROPS' =>     '*PKEY_PARAM_PROPERTIES',
 347     'PKEY_PARAM_RSA_MASKGENFUNC' =>      '*PKEY_PARAM_MASKGENFUNC',
 348     'PKEY_PARAM_RSA_MGF1_DIGEST' =>      '*PKEY_PARAM_MGF1_DIGEST',
 349     'PKEY_PARAM_RSA_PSS_SALTLEN' =>      "saltlen",
 350
 351 # EC, X25519 and X448 Key generation parameters
 352     'PKEY_PARAM_DHKEM_IKM' =>        "dhkem-ikm",
 353
 354 # Key generation parameters
 355     'PKEY_PARAM_FFC_TYPE' =>         "type",
 356     'PKEY_PARAM_FFC_PBITS' =>        "pbits",
 357     'PKEY_PARAM_FFC_QBITS' =>        "qbits",
 358     'PKEY_PARAM_FFC_DIGEST' =>       '*PKEY_PARAM_DIGEST',
 359     'PKEY_PARAM_FFC_DIGEST_PROPS' => '*PKEY_PARAM_PROPERTIES',
 360
 361     'PKEY_PARAM_EC_ENCODING' =>                "encoding",# utf8_string
 362     'PKEY_PARAM_EC_POINT_CONVERSION_FORMAT' => "point-format",
 363     'PKEY_PARAM_EC_GROUP_CHECK_TYPE' =>        "group-check",
 364     'PKEY_PARAM_EC_INCLUDE_PUBLIC' =>          "include-public",
 365
 366 # Key Exchange parameters
 367     'EXCHANGE_PARAM_PAD' =>                   "pad",# uint
 368     'EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE' => "ecdh-cofactor-mode",# int
 369     'EXCHANGE_PARAM_KDF_TYPE' =>              "kdf-type",# utf8_string
 370     'EXCHANGE_PARAM_KDF_DIGEST' =>            "kdf-digest",# utf8_string
 371     'EXCHANGE_PARAM_KDF_DIGEST_PROPS' =>      "kdf-digest-props",# utf8_string
 372     'EXCHANGE_PARAM_KDF_OUTLEN' =>            "kdf-outlen",# size_t
 373 # The following parameter is an octet_string on set and an octet_ptr on get
 374     'EXCHANGE_PARAM_KDF_UKM' =>               "kdf-ukm",
 375
 376 # Signature parameters
 377     'SIGNATURE_PARAM_ALGORITHM_ID' =>       "algorithm-id",
 378     'SIGNATURE_PARAM_PAD_MODE' =>           '*PKEY_PARAM_PAD_MODE',
 379     'SIGNATURE_PARAM_DIGEST' =>             '*PKEY_PARAM_DIGEST',
 380     'SIGNATURE_PARAM_PROPERTIES' =>         '*PKEY_PARAM_PROPERTIES',
 381     'SIGNATURE_PARAM_PSS_SALTLEN' =>        "saltlen",
 382     'SIGNATURE_PARAM_MGF1_DIGEST' =>        '*PKEY_PARAM_MGF1_DIGEST',
 383     'SIGNATURE_PARAM_MGF1_PROPERTIES' =>    '*PKEY_PARAM_MGF1_PROPERTIES',
 384     'SIGNATURE_PARAM_DIGEST_SIZE' =>        '*PKEY_PARAM_DIGEST_SIZE',
 385     'SIGNATURE_PARAM_NONCE_TYPE' =>         "nonce-type",
 386     'SIGNATURE_PARAM_INSTANCE' =>           "instance",
 387     'SIGNATURE_PARAM_CONTEXT_STRING' =>     "context-string",
 388
 389 # Asym cipher parameters
 390     'ASYM_CIPHER_PARAM_DIGEST' =>                   '*PKEY_PARAM_DIGEST',
 391     'ASYM_CIPHER_PARAM_PROPERTIES' =>               '*PKEY_PARAM_PROPERTIES',
 392     'ASYM_CIPHER_PARAM_ENGINE' =>                   '*PKEY_PARAM_ENGINE',
 393     'ASYM_CIPHER_PARAM_PAD_MODE' =>                 '*PKEY_PARAM_PAD_MODE',
 394     'ASYM_CIPHER_PARAM_MGF1_DIGEST' =>              '*PKEY_PARAM_MGF1_DIGEST',
 395     'ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS' =>        '*PKEY_PARAM_MGF1_PROPERTIES',
 396     'ASYM_CIPHER_PARAM_OAEP_DIGEST' =>              '*ALG_PARAM_DIGEST',
 397     'ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS' =>        "digest-props",
 398 # The following parameter is an octet_string on set and an octet_ptr on get
 399     'ASYM_CIPHER_PARAM_OAEP_LABEL' =>               "oaep-label",
 400     'ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION' =>       "tls-client-version",
 401     'ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION' =>   "tls-negotiated-version",
 402     'ASYM_CIPHER_PARAM_IMPLICIT_REJECTION' =>       "implicit-rejection",
 403
 404 # Encoder / decoder parameters
 405
 406     'ENCODER_PARAM_CIPHER' =>           '*ALG_PARAM_CIPHER',
 407     'ENCODER_PARAM_PROPERTIES' =>       '*ALG_PARAM_PROPERTIES',
 408 # Currently PVK only, but reusable for others as needed
 409     'ENCODER_PARAM_ENCRYPT_LEVEL' =>    "encrypt-level",
 410     'ENCODER_PARAM_SAVE_PARAMETERS' =>  "save-parameters",# integer
 411
 412     'DECODER_PARAM_PROPERTIES' =>       '*ALG_PARAM_PROPERTIES',
 413
 414 # Passphrase callback parameters
 415     'PASSPHRASE_PARAM_INFO' =>          "info",
 416
 417 # Keygen callback parameters, from provider to libcrypto
 418     'GEN_PARAM_POTENTIAL' =>            "potential",# integer
 419     'GEN_PARAM_ITERATION' =>            "iteration",# integer
 420
 421 # ACVP Test parameters : These should not be used normally
 422     'PKEY_PARAM_RSA_TEST_XP1' => "xp1",
 423     'PKEY_PARAM_RSA_TEST_XP2' => "xp2",
 424     'PKEY_PARAM_RSA_TEST_XP' =>  "xp",
 425     'PKEY_PARAM_RSA_TEST_XQ1' => "xq1",
 426     'PKEY_PARAM_RSA_TEST_XQ2' => "xq2",
 427     'PKEY_PARAM_RSA_TEST_XQ' =>  "xq",
 428     'PKEY_PARAM_RSA_TEST_P1' =>  "p1",
 429     'PKEY_PARAM_RSA_TEST_P2' =>  "p2",
 430     'PKEY_PARAM_RSA_TEST_Q1' =>  "q1",
 431     'PKEY_PARAM_RSA_TEST_Q2' =>  "q2",
 432     'SIGNATURE_PARAM_KAT' =>     "kat",
 433
 434 # KEM parameters
 435     'KEM_PARAM_OPERATION' =>            "operation",
 436     'KEM_PARAM_IKME' =>                 "ikme",
 437
 438 # Capabilities
 439
 440 # TLS-GROUP Capability
 441     'CAPABILITY_TLS_GROUP_NAME' =>              "tls-group-name",
 442     'CAPABILITY_TLS_GROUP_NAME_INTERNAL' =>     "tls-group-name-internal",
 443     'CAPABILITY_TLS_GROUP_ID' =>                "tls-group-id",
 444     'CAPABILITY_TLS_GROUP_ALG' =>               "tls-group-alg",
 445     'CAPABILITY_TLS_GROUP_SECURITY_BITS' =>     "tls-group-sec-bits",
 446     'CAPABILITY_TLS_GROUP_IS_KEM' =>            "tls-group-is-kem",
 447     'CAPABILITY_TLS_GROUP_MIN_TLS' =>           "tls-min-tls",
 448     'CAPABILITY_TLS_GROUP_MAX_TLS' =>           "tls-max-tls",
 449     'CAPABILITY_TLS_GROUP_MIN_DTLS' =>          "tls-min-dtls",
 450     'CAPABILITY_TLS_GROUP_MAX_DTLS' =>          "tls-max-dtls",
 451
 452 # TLS-SIGALG Capability
 453     'CAPABILITY_TLS_SIGALG_IANA_NAME' =>         "tls-sigalg-iana-name",
 454     'CAPABILITY_TLS_SIGALG_CODE_POINT' =>        "tls-sigalg-code-point",
 455     'CAPABILITY_TLS_SIGALG_NAME' =>              "tls-sigalg-name",
 456     'CAPABILITY_TLS_SIGALG_OID' =>               "tls-sigalg-oid",
 457     'CAPABILITY_TLS_SIGALG_SIG_NAME' =>          "tls-sigalg-sig-name",
 458     'CAPABILITY_TLS_SIGALG_SIG_OID' =>           "tls-sigalg-sig-oid",
 459     'CAPABILITY_TLS_SIGALG_HASH_NAME' =>         "tls-sigalg-hash-name",
 460     'CAPABILITY_TLS_SIGALG_HASH_OID' =>          "tls-sigalg-hash-oid",
 461     'CAPABILITY_TLS_SIGALG_KEYTYPE' =>           "tls-sigalg-keytype",
 462     'CAPABILITY_TLS_SIGALG_KEYTYPE_OID' =>       "tls-sigalg-keytype-oid",
 463     'CAPABILITY_TLS_SIGALG_SECURITY_BITS' =>     "tls-sigalg-sec-bits",
 464     'CAPABILITY_TLS_SIGALG_MIN_TLS' =>           "tls-min-tls",
 465     'CAPABILITY_TLS_SIGALG_MAX_TLS' =>           "tls-max-tls",
 466
 467 # storemgmt parameters
 468
 469
 470 # Used by storemgmt_ctx_set_params():
 471 #
 472 # - STORE_PARAM_EXPECT is an INTEGER, and the value is any of the
 473 #   STORE_INFO numbers.  This is used to set the expected type of
 474 #   object loaded.
 475 #
 476 # - STORE_PARAM_SUBJECT, STORE_PARAM_ISSUER,
 477 #   STORE_PARAM_SERIAL, STORE_PARAM_FINGERPRINT,
 478 #   STORE_PARAM_DIGEST, STORE_PARAM_ALIAS
 479 #   are used as search criteria.
 480 #   (STORE_PARAM_DIGEST is used with STORE_PARAM_FINGERPRINT)
 481
 482     'STORE_PARAM_EXPECT' =>     "expect",       # INTEGER
 483     'STORE_PARAM_SUBJECT' =>    "subject",      # DER blob => OCTET_STRING
 484     'STORE_PARAM_ISSUER' =>     "name",         # DER blob => OCTET_STRING
 485     'STORE_PARAM_SERIAL' =>     "serial",       # INTEGER
 486     'STORE_PARAM_DIGEST' =>     "digest",       # UTF8_STRING
 487     'STORE_PARAM_FINGERPRINT' => "fingerprint", # OCTET_STRING
 488     'STORE_PARAM_ALIAS' =>      "alias",        # UTF8_STRING
 489
 490 # You may want to pass properties for the provider implementation to use
 491     'STORE_PARAM_PROPERTIES' => "properties",   # utf8_string
 492 # DECODER input type if a decoder is used by the store
 493     'STORE_PARAM_INPUT_TYPE' => "input-type",   # UTF8_STRING
 494
 495
 496 # Libssl record layer
 497     'LIBSSL_RECORD_LAYER_PARAM_OPTIONS' =>        "options",
 498     'LIBSSL_RECORD_LAYER_PARAM_MODE' =>           "mode",
 499     'LIBSSL_RECORD_LAYER_PARAM_READ_AHEAD' =>     "read_ahead",
 500     'LIBSSL_RECORD_LAYER_READ_BUFFER_LEN' =>      "read_buffer_len",
 501     'LIBSSL_RECORD_LAYER_PARAM_USE_ETM' =>        "use_etm",
 502     'LIBSSL_RECORD_LAYER_PARAM_STREAM_MAC' =>     "stream_mac",
 503     'LIBSSL_RECORD_LAYER_PARAM_TLSTREE' =>        "tlstree",
 504     'LIBSSL_RECORD_LAYER_PARAM_MAX_FRAG_LEN' =>   "max_frag_len",
 505     'LIBSSL_RECORD_LAYER_PARAM_MAX_EARLY_DATA' => "max_early_data",
 506     'LIBSSL_RECORD_LAYER_PARAM_BLOCK_PADDING' =>  "block_padding",
 507 );
 508
 509 # Generate string based macros for public consumption
 510 sub generate_public_macros {
 511     my @macros = ();
 512
 513     foreach my $name (keys %params) {
 514         my $val = $params{$name};
 515         my $def = '# define OSSL_' . $name . ' ';
 516
 517         if (substr($val, 0, 1) eq '*') {
 518             $def .= 'OSSL_' . substr($val, 1);
 519         } else {
 520             $def .= '"' . $val . '"';
 521         }
 522         push(@macros, $def)
 523     }
 524     return join("\n", sort @macros);
 525 }
 526
 527 # Generate number based macros for internal use
 528 # The numbers are unique per string
 529 sub generate_internal_macros {
 530     my @macros = ();
 531     my $count = 0;
 532     my %reverse;
 533
 534     # Determine the number for each unique string
 535     # Sort the names to improve the chance of cache coherency
 536     foreach my $name (sort keys %params) {
 537         my $val = $params{$name};
 538
 539         if (substr($val, 0, 1) ne '*' and not defined $reverse{$val}) {
 540             $reverse{$val} = $count++;
 541         }
 542     }
 543
 544     # Output the defines
 545     foreach my $name (keys %params) {
 546         my $val = $params{$name};
 547         my $def = '#define PIDX_' . $name . ' ';
 548
 549         if (substr($val, 0, 1) eq '*') {
 550             $def .= 'PIDX_' . substr($val, 1);
 551         } else {
 552             $def .= $reverse{$val};
 553         }
 554         push(@macros, $def)
 555     }
 556     return "#define NUM_PIDX $count\n\n" . join("\n", sort @macros);
 557 }
 558
 559 sub generate_trie {
 560     my %trie;
 561     my $nodes = 0;
 562     my $chars = 0;
 563
 564     foreach my $name (keys %params) {
 565         my $val = $params{$name};
 566         if (substr($val, 0, 1) ne '*') {
 567             my $cursor = \%trie;
 568
 569             $chars += length($val);
 570             for my $i (0 .. length($val) - 1) {
 571                 my $c = substr($val, $i, 1);
 572
 573                 if (not $case_sensitive) {
 574                     $c = '_' if $c eq '-';
 575                     $c = lc $c;
 576                 }
 577
 578                 if (not defined $$cursor{$c}) {
 579                     $cursor->{$c} = {};
 580                     $nodes++;
 581                 }
 582                 $cursor = $cursor->{$c};
 583             }
 584             $cursor->{'val'} = $name;
 585         }
 586     }
 587     #print "\n\n/* $nodes nodes for $chars letters*/\n\n";
 588     return %trie;
 589 }
 590
 591 sub generate_code_from_trie {
 592     my $n = shift;
 593     my $trieref = shift;
 594     my $idt = "    ";
 595     my $indent0 = $idt x ($n + 1);
 596     my $indent1 = $indent0 . $idt;
 597     my $strcmp = $case_sensitive ? 'strcmp' : 'strcasecmp';
 598
 599     print "int ossl_param_find_pidx(const char *s)\n{\n" if $n == 0;
 600
 601     if ($trieref->{'suffix'}) {
 602         my $suf = $trieref->{'suffix'};
 603
 604         printf "%sif ($strcmp(\"$suf\", s + $n) == 0", $indent0;
 605         if (not $case_sensitive) {
 606             $suf =~ tr/_/-/;
 607             print " || $strcmp(\"$suf\", s + $n) == 0"
 608                 if ($suf ne $trieref->{'suffix'});
 609         }
 610         printf ")\n%sreturn PIDX_%s;\n", $indent1, $trieref->{'name'};
 611         #printf "%sbreak;\n", $indent0;
 612         return;
 613     }
 614
 615     printf "%sswitch(s\[%d\]) {\n", $indent0, $n;
 616     printf "%sdefault:\n", $indent0;
 617     for my $l (sort keys %$trieref) {
 618         if ($l eq 'val') {
 619             printf "%sbreak;\n", $indent1;
 620             printf "%scase '\\0':\n", $indent0;
 621             printf "%sreturn PIDX_%s;\n", $indent1, $trieref->{'val'};
 622         } else {
 623             printf "%sbreak;\n", $indent1;
 624             printf "%scase '%s':", $indent0, $l;
 625             if (not $case_sensitive) {
 626                 print "   case '-':" if ($l eq '_');
 627                 printf "   case '%s':", uc $l if ($l =~ /[a-z]/);
 628             }
 629             print "\n";
 630             generate_code_from_trie($n + 1, $trieref->{$l});
 631         }
 632     }
 633     printf "%s}\n", $indent0;
 634     print "    return -1;\n}\n" if $n == 0;
 635     return "";
 636 }
 637
 638 # Find long endings and cache what they resolve to
 639 sub locate_long_endings {
 640     my $trieref = shift;
 641     my @names = keys %$trieref;
 642     my $num = @names;
 643
 644     return (1, '', $trieref->{$names[0]}) if ($num == 1 and $names[0] eq 'val');
 645
 646     if ($num == 1) {
 647         my ($res, $suffix, $name) = locate_long_endings($trieref->{$names[0]});
 648         my $e = $names[0] . $suffix;
 649         if ($res) {
 650             $trieref->{'suffix'} = $e;
 651             $trieref->{'name'} = $name;
 652         }
 653         return $res, $e, $name;
 654     }
 655
 656     for my $l (@names) {
 657         if ($l ne 'val') {
 658             my ($res, $suffix, $name) = locate_long_endings($trieref->{$l});
 659         }
 660     }
 661     return 0, '';
 662 }
 663
 664 sub produce_decoder {
 665     my %t = generate_trie();
 666     my $s;
 667
 668     locate_long_endings(\%t);
 669
 670     open local *STDOUT, '>', \$s;
 671     generate_code_from_trie(0, \%t);
 672     return $s;
 673 }