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