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