From 1313e37ab97c0b24eedf67b343b93a7c964b9767 Mon Sep 17 00:00:00 2001 From: Pauli Date: Mon, 17 Jun 2019 11:34:09 +1000 Subject: [PATCH] Better document specific OSSL_PARAM symbols. Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/9114) --- ...OSSL_PARAM_TYPE.pod => OSSL_PARAM_int.pod} | 38 ++++++++++++++----- util/private.num | 15 +++----- 2 files changed, 34 insertions(+), 19 deletions(-) rename doc/man3/{OSSL_PARAM_TYPE.pod => OSSL_PARAM_int.pod} (88%) diff --git a/doc/man3/OSSL_PARAM_TYPE.pod b/doc/man3/OSSL_PARAM_int.pod similarity index 88% rename from doc/man3/OSSL_PARAM_TYPE.pod rename to doc/man3/OSSL_PARAM_int.pod index 1b750b2c54..f8d8c501e0 100644 --- a/doc/man3/OSSL_PARAM_TYPE.pod +++ b/doc/man3/OSSL_PARAM_int.pod @@ -2,17 +2,31 @@ =head1 NAME -OSSL_PARAM_TYPE, OSSL_PARAM_utf8_string, OSSL_PARAM_octet_string, -OSSL_PARAM_utf8_ptr, OSSL_PARAM_octet_ptr, OSSL_PARAM_SIZED_TYPE, -OSSL_PARAM_SIZED_BN, OSSL_PARAM_SIZED_utf8_string, +OSSL_PARAM_double, OSSL_PARAM_int, OSSL_PARAM_int32, OSSL_PARAM_int64, +OSSL_PARAM_long, OSSL_PARAM_size_t, OSSL_PARAM_uint, OSSL_PARAM_uint32, +OSSL_PARAM_uint64, OSSL_PARAM_ulong, OSSL_PARAM_utf8_string, +OSSL_PARAM_octet_string, OSSL_PARAM_utf8_ptr, OSSL_PARAM_octet_ptr, +OSSL_PARAM_SIZED_double, OSSL_PARAM_SIZED_int, OSSL_PARAM_SIZED_int32, +OSSL_PARAM_SIZED_int64, OSSL_PARAM_SIZED_long, OSSL_PARAM_SIZED_size_t, +OSSL_PARAM_SIZED_uint, OSSL_PARAM_SIZED_uint32, OSSL_PARAM_SIZED_uint64, +OSSL_PARAM_SIZED_ulong, OSSL_PARAM_SIZED_BN, OSSL_PARAM_SIZED_utf8_string, OSSL_PARAM_SIZED_octet_string, OSSL_PARAM_SIZED_utf8_ptr, -OSSL_PARAM_SIZED_octet_ptr, OSSL_PARAM_END, OSSL_PARAM_construct_TYPE, -OSSL_PARAM_END, -OSSL_PARAM_construct_BN, OSSL_PARAM_construct_utf8_string, -OSSL_PARAM_construct_utf8_ptr, OSSL_PARAM_construct_octet_string, -OSSL_PARAM_construct_octet_ptr, OSSL_PARAM_construct_end, -OSSL_PARAM_locate, OSSL_PARAM_get_TYPE, -OSSL_PARAM_set_TYPE, OSSL_PARAM_get_BN, OSSL_PARAM_set_BN, +OSSL_PARAM_SIZED_octet_ptr, OSSL_PARAM_END, OSSL_PARAM_construct_double, +OSSL_PARAM_construct_int, OSSL_PARAM_construct_int32, +OSSL_PARAM_construct_int64, OSSL_PARAM_construct_long, +OSSL_PARAM_construct_size_t, OSSL_PARAM_construct_uint, +OSSL_PARAM_construct_uint32, OSSL_PARAM_construct_uint64, +OSSL_PARAM_construct_ulong, OSSL_PARAM_END, OSSL_PARAM_construct_BN, +OSSL_PARAM_construct_utf8_string, OSSL_PARAM_construct_utf8_ptr, +OSSL_PARAM_construct_octet_string, OSSL_PARAM_construct_octet_ptr, +OSSL_PARAM_construct_end, OSSL_PARAM_locate, OSSL_PARAM_get_double, +OSSL_PARAM_get_int, OSSL_PARAM_get_int32, OSSL_PARAM_get_int64, +OSSL_PARAM_get_long, OSSL_PARAM_get_size_t, OSSL_PARAM_get_uint, +OSSL_PARAM_get_uint32, OSSL_PARAM_get_uint64, OSSL_PARAM_get_ulong, +OSSL_PARAM_set_double, OSSL_PARAM_set_int, OSSL_PARAM_set_int32, +OSSL_PARAM_set_int64, OSSL_PARAM_set_long, OSSL_PARAM_set_size_t, +OSSL_PARAM_set_uint, OSSL_PARAM_set_uint32, OSSL_PARAM_set_uint64, +OSSL_PARAM_set_ulong, OSSL_PARAM_get_BN, OSSL_PARAM_set_BN, OSSL_PARAM_get_utf8_string, OSSL_PARAM_set_utf8_string, OSSL_PARAM_get_octet_string, OSSL_PARAM_set_octet_string, OSSL_PARAM_get_utf8_ptr, OSSL_PARAM_set_utf8_ptr, OSSL_PARAM_get_octet_ptr, @@ -21,6 +35,8 @@ OSSL_PARAM_set_octet_ptr =head1 SYNOPSIS +=for comment generic + #include #define OSSL_PARAM_TYPE(key, address) @@ -28,12 +44,14 @@ OSSL_PARAM_set_octet_ptr #define OSSL_PARAM_octet_string(key, address, size) #define OSSL_PARAM_utf8_ptr(key, address, size) #define OSSL_PARAM_octet_ptr(key, address, size) + #define OSSL_PARAM_SIZED_TYPE(key, address, return_size) #define OSSL_PARAM_SIZED_BN(key, address, size, return_size) #define OSSL_PARAM_SIZED_utf8_string(key, address, size, return_size) #define OSSL_PARAM_SIZED_octet_string(key, address, size, return_size) #define OSSL_PARAM_SIZED_utf8_ptr(key, address, size, return_size) #define OSSL_PARAM_SIZED_octet_ptr(key, address, size, return_size) + #define OSSL_PARAM_END OSSL_PARAM OSSL_PARAM_construct_TYPE(const char *key, TYPE *buf, size_t *ret); diff --git a/util/private.num b/util/private.num index 53edf4a7a4..7f4bf907ea 100644 --- a/util/private.num +++ b/util/private.num @@ -328,21 +328,18 @@ OpenSSL_add_all_algorithms define deprecated 1.1.0 OpenSSL_add_all_ciphers define deprecated 1.1.0 OpenSSL_add_all_digests define deprecated 1.1.0 OpenSSL_add_ssl_algorithms define +OSSL_PARAM_TYPE define +OSSL_PARAM_octet_ptr define +OSSL_PARAM_octet_string define OSSL_PARAM_utf8_ptr define +OSSL_PARAM_utf8_string define OSSL_PARAM_SIZED_BN define -OSSL_PARAM_TYPE generic -OSSL_PARAM_construct_TYPE generic -OSSL_PARAM_octet_string define +OSSL_PARAM_SIZED_TYPE define OSSL_PARAM_SIZED_octet_ptr define -OSSL_PARAM_utf8_string define -OSSL_PARAM_octet_ptr define +OSSL_PARAM_SIZED_octet_string define OSSL_PARAM_SIZED_utf8_ptr define OSSL_PARAM_SIZED_utf8_string define -OSSL_PARAM_SIZED_TYPE generic -OSSL_PARAM_get_TYPE generic OSSL_PARAM_END define -OSSL_PARAM_set_TYPE generic -OSSL_PARAM_SIZED_octet_string define PEM_FLAG_EAY_COMPATIBLE define PEM_FLAG_ONLY_B64 define PEM_FLAG_SECURE define -- 2.39.2