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