1095 lines
53 KiB
Plaintext
1095 lines
53 KiB
Plaintext
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
. ds C`
|
|
. ds C'
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.\"
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
|
.de IX
|
|
..
|
|
.nr rF 0
|
|
.if \n(.g .if rF .nr rF 1
|
|
.if (\n(rF:(\n(.g==0)) \{
|
|
. if \nF \{
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
. \}
|
|
.\}
|
|
.rr rF
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "PROVIDER-BASE 7ossl"
|
|
.TH PROVIDER-BASE 7ossl "2024-01-30" "3.2.1" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
provider\-base
|
|
\&\- The basic OpenSSL library <\-> provider functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/core_dispatch.h>
|
|
\&
|
|
\& /*
|
|
\& * None of these are actual functions, but are displayed like this for
|
|
\& * the function signatures for functions that are offered as function
|
|
\& * pointers in OSSL_DISPATCH arrays.
|
|
\& */
|
|
\&
|
|
\& /* Functions offered by libcrypto to the providers */
|
|
\& const OSSL_ITEM *core_gettable_params(const OSSL_CORE_HANDLE *handle);
|
|
\& int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[]);
|
|
\&
|
|
\& typedef void (*OSSL_thread_stop_handler_fn)(void *arg);
|
|
\& int core_thread_start(const OSSL_CORE_HANDLE *handle,
|
|
\& OSSL_thread_stop_handler_fn handfn,
|
|
\& void *arg);
|
|
\&
|
|
\& OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle);
|
|
\& void core_new_error(const OSSL_CORE_HANDLE *handle);
|
|
\& void core_set_error_debug(const OSSL_CORE_HANDLE *handle,
|
|
\& const char *file, int line, const char *func);
|
|
\& void core_vset_error(const OSSL_CORE_HANDLE *handle,
|
|
\& uint32_t reason, const char *fmt, va_list args);
|
|
\&
|
|
\& int core_obj_add_sigid(const OSSL_CORE_HANDLE *prov, const char *sign_name,
|
|
\& const char *digest_name, const char *pkey_name);
|
|
\& int core_obj_create(const OSSL_CORE_HANDLE *handle, const char *oid,
|
|
\& const char *sn, const char *ln);
|
|
\&
|
|
\& /*
|
|
\& * Some OpenSSL functionality is directly offered to providers via
|
|
\& * dispatch
|
|
\& */
|
|
\& void *CRYPTO_malloc(size_t num, const char *file, int line);
|
|
\& void *CRYPTO_zalloc(size_t num, const char *file, int line);
|
|
\& void CRYPTO_free(void *ptr, const char *file, int line);
|
|
\& void CRYPTO_clear_free(void *ptr, size_t num,
|
|
\& const char *file, int line);
|
|
\& void *CRYPTO_realloc(void *addr, size_t num,
|
|
\& const char *file, int line);
|
|
\& void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
|
|
\& const char *file, int line);
|
|
\& void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
|
|
\& void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
|
|
\& void CRYPTO_secure_free(void *ptr, const char *file, int line);
|
|
\& void CRYPTO_secure_clear_free(void *ptr, size_t num,
|
|
\& const char *file, int line);
|
|
\& int CRYPTO_secure_allocated(const void *ptr);
|
|
\& void OPENSSL_cleanse(void *ptr, size_t len);
|
|
\&
|
|
\& unsigned char *OPENSSL_hexstr2buf(const char *str, long *buflen);
|
|
\&
|
|
\& OSSL_CORE_BIO *BIO_new_file(const char *filename, const char *mode);
|
|
\& OSSL_CORE_BIO *BIO_new_membuf(const void *buf, int len);
|
|
\& int BIO_read_ex(OSSL_CORE_BIO *bio, void *data, size_t data_len,
|
|
\& size_t *bytes_read);
|
|
\& int BIO_write_ex(OSSL_CORE_BIO *bio, const void *data, size_t data_len,
|
|
\& size_t *written);
|
|
\& int BIO_up_ref(OSSL_CORE_BIO *bio);
|
|
\& int BIO_free(OSSL_CORE_BIO *bio);
|
|
\& int BIO_vprintf(OSSL_CORE_BIO *bio, const char *format, va_list args);
|
|
\& int BIO_vsnprintf(char *buf, size_t n, const char *fmt, va_list args);
|
|
\&
|
|
\& void OSSL_SELF_TEST_set_callback(OSSL_LIB_CTX *libctx, OSSL_CALLBACK *cb,
|
|
\& void *cbarg);
|
|
\&
|
|
\& size_t get_entropy(const OSSL_CORE_HANDLE *handle,
|
|
\& unsigned char **pout, int entropy,
|
|
\& size_t min_len, size_t max_len);
|
|
\& size_t get_user_entropy(const OSSL_CORE_HANDLE *handle,
|
|
\& unsigned char **pout, int entropy,
|
|
\& size_t min_len, size_t max_len);
|
|
\& void cleanup_entropy(const OSSL_CORE_HANDLE *handle,
|
|
\& unsigned char *buf, size_t len);
|
|
\& void cleanup_user_entropy(const OSSL_CORE_HANDLE *handle,
|
|
\& unsigned char *buf, size_t len);
|
|
\& size_t get_nonce(const OSSL_CORE_HANDLE *handle,
|
|
\& unsigned char **pout, size_t min_len, size_t max_len,
|
|
\& const void *salt, size_t salt_len);
|
|
\& size_t get_user_nonce(const OSSL_CORE_HANDLE *handle,
|
|
\& unsigned char **pout, size_t min_len, size_t max_len,
|
|
\& const void *salt, size_t salt_len);
|
|
\& void cleanup_nonce(const OSSL_CORE_HANDLE *handle,
|
|
\& unsigned char *buf, size_t len);
|
|
\& void cleanup_user_nonce(const OSSL_CORE_HANDLE *handle,
|
|
\& unsigned char *buf, size_t len);
|
|
\&
|
|
\& /* Functions for querying the providers in the application library context */
|
|
\& int provider_register_child_cb(const OSSL_CORE_HANDLE *handle,
|
|
\& int (*create_cb)(const OSSL_CORE_HANDLE *provider,
|
|
\& void *cbdata),
|
|
\& int (*remove_cb)(const OSSL_CORE_HANDLE *provider,
|
|
\& void *cbdata),
|
|
\& int (*global_props_cb)(const char *props, void *cbdata),
|
|
\& void *cbdata);
|
|
\& void provider_deregister_child_cb(const OSSL_CORE_HANDLE *handle);
|
|
\& const char *provider_name(const OSSL_CORE_HANDLE *prov);
|
|
\& void *provider_get0_provider_ctx(const OSSL_CORE_HANDLE *prov);
|
|
\& const OSSL_DISPATCH *provider_get0_dispatch(const OSSL_CORE_HANDLE *prov);
|
|
\& int provider_up_ref(const OSSL_CORE_HANDLE *prov, int activate);
|
|
\& int provider_free(const OSSL_CORE_HANDLE *prov, int deactivate);
|
|
\&
|
|
\& /* Functions offered by the provider to libcrypto */
|
|
\& void provider_teardown(void *provctx);
|
|
\& const OSSL_ITEM *provider_gettable_params(void *provctx);
|
|
\& int provider_get_params(void *provctx, OSSL_PARAM params[]);
|
|
\& const OSSL_ALGORITHM *provider_query_operation(void *provctx,
|
|
\& int operation_id,
|
|
\& const int *no_store);
|
|
\& void provider_unquery_operation(void *provctx, int operation_id,
|
|
\& const OSSL_ALGORITHM *algs);
|
|
\& const OSSL_ITEM *provider_get_reason_strings(void *provctx);
|
|
\& int provider_get_capabilities(void *provctx, const char *capability,
|
|
\& OSSL_CALLBACK *cb, void *arg);
|
|
\& int provider_self_test(void *provctx);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
All \*(L"functions\*(R" mentioned here are passed as function pointers between
|
|
\&\fIlibcrypto\fR and the provider in \s-1\fIOSSL_DISPATCH\s0\fR\|(3) arrays, in the call
|
|
of the provider initialization function. See \*(L"Provider\*(R" in \fIprovider\fR\|(7)
|
|
for a description of the initialization function. They are known as \*(L"upcalls\*(R".
|
|
.PP
|
|
All these \*(L"functions\*(R" have a corresponding function type definition
|
|
named \fBOSSL_FUNC_{name}_fn\fR, and a helper function to retrieve the
|
|
function pointer from a \s-1\fIOSSL_DISPATCH\s0\fR\|(3) element named
|
|
\&\fBOSSL_FUNC_{name}\fR.
|
|
For example, the \*(L"function\*(R" \fIcore_gettable_params()\fR has these:
|
|
.PP
|
|
.Vb 4
|
|
\& typedef OSSL_PARAM *
|
|
\& (OSSL_FUNC_core_gettable_params_fn)(const OSSL_CORE_HANDLE *handle);
|
|
\& static ossl_inline OSSL_NAME_core_gettable_params_fn
|
|
\& OSSL_FUNC_core_gettable_params(const OSSL_DISPATCH *opf);
|
|
.Ve
|
|
.PP
|
|
\&\s-1\fIOSSL_DISPATCH\s0\fR\|(3) arrays are indexed by numbers that are provided as
|
|
macros in \fIopenssl\-core_dispatch.h\fR\|(7), as follows:
|
|
.PP
|
|
For \fIin\fR (the \s-1\fIOSSL_DISPATCH\s0\fR\|(3) array passed from \fIlibcrypto\fR to the
|
|
provider):
|
|
.PP
|
|
.Vb 10
|
|
\& core_gettable_params OSSL_FUNC_CORE_GETTABLE_PARAMS
|
|
\& core_get_params OSSL_FUNC_CORE_GET_PARAMS
|
|
\& core_thread_start OSSL_FUNC_CORE_THREAD_START
|
|
\& core_get_libctx OSSL_FUNC_CORE_GET_LIBCTX
|
|
\& core_new_error OSSL_FUNC_CORE_NEW_ERROR
|
|
\& core_set_error_debug OSSL_FUNC_CORE_SET_ERROR_DEBUG
|
|
\& core_vset_error OSSL_FUNC_CORE_VSET_ERROR
|
|
\& core_obj_add_sigid OSSL_FUNC_CORE_OBJ_ADD_SIGID
|
|
\& core_obj_create OSSL_FUNC_CORE_OBJ_CREATE
|
|
\& CRYPTO_malloc OSSL_FUNC_CRYPTO_MALLOC
|
|
\& CRYPTO_zalloc OSSL_FUNC_CRYPTO_ZALLOC
|
|
\& CRYPTO_free OSSL_FUNC_CRYPTO_FREE
|
|
\& CRYPTO_clear_free OSSL_FUNC_CRYPTO_CLEAR_FREE
|
|
\& CRYPTO_realloc OSSL_FUNC_CRYPTO_REALLOC
|
|
\& CRYPTO_clear_realloc OSSL_FUNC_CRYPTO_CLEAR_REALLOC
|
|
\& CRYPTO_secure_malloc OSSL_FUNC_CRYPTO_SECURE_MALLOC
|
|
\& CRYPTO_secure_zalloc OSSL_FUNC_CRYPTO_SECURE_ZALLOC
|
|
\& CRYPTO_secure_free OSSL_FUNC_CRYPTO_SECURE_FREE
|
|
\& CRYPTO_secure_clear_free OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE
|
|
\& CRYPTO_secure_allocated OSSL_FUNC_CRYPTO_SECURE_ALLOCATED
|
|
\& BIO_new_file OSSL_FUNC_BIO_NEW_FILE
|
|
\& BIO_new_mem_buf OSSL_FUNC_BIO_NEW_MEMBUF
|
|
\& BIO_read_ex OSSL_FUNC_BIO_READ_EX
|
|
\& BIO_write_ex OSSL_FUNC_BIO_WRITE_EX
|
|
\& BIO_up_ref OSSL_FUNC_BIO_UP_REF
|
|
\& BIO_free OSSL_FUNC_BIO_FREE
|
|
\& BIO_vprintf OSSL_FUNC_BIO_VPRINTF
|
|
\& BIO_vsnprintf OSSL_FUNC_BIO_VSNPRINTF
|
|
\& BIO_puts OSSL_FUNC_BIO_PUTS
|
|
\& BIO_gets OSSL_FUNC_BIO_GETS
|
|
\& BIO_ctrl OSSL_FUNC_BIO_CTRL
|
|
\& OPENSSL_cleanse OSSL_FUNC_OPENSSL_CLEANSE
|
|
\& OSSL_SELF_TEST_set_callback OSSL_FUNC_SELF_TEST_CB
|
|
\& ossl_rand_get_entropy OSSL_FUNC_GET_ENTROPY
|
|
\& ossl_rand_get_user_entropy OSSL_FUNC_GET_USER_ENTROPY
|
|
\& ossl_rand_cleanup_entropy OSSL_FUNC_CLEANUP_ENTROPY
|
|
\& ossl_rand_cleanup_user_entropy OSSL_FUNC_CLEANUP_USER_ENTROPY
|
|
\& ossl_rand_get_nonce OSSL_FUNC_GET_NONCE
|
|
\& ossl_rand_get_user_nonce OSSL_FUNC_GET_USER_NONCE
|
|
\& ossl_rand_cleanup_nonce OSSL_FUNC_CLEANUP_NONCE
|
|
\& ossl_rand_cleanup_user_nonce OSSL_FUNC_CLEANUP_USER_NONCE
|
|
\& provider_register_child_cb OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB
|
|
\& provider_deregister_child_cb OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB
|
|
\& provider_name OSSL_FUNC_PROVIDER_NAME
|
|
\& provider_get0_provider_ctx OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX
|
|
\& provider_get0_dispatch OSSL_FUNC_PROVIDER_GET0_DISPATCH
|
|
\& provider_up_ref OSSL_FUNC_PROVIDER_UP_REF
|
|
\& provider_free OSSL_FUNC_PROVIDER_FREE
|
|
.Ve
|
|
.PP
|
|
For \fI*out\fR (the \s-1\fIOSSL_DISPATCH\s0\fR\|(3) array passed from the provider to
|
|
\&\fIlibcrypto\fR):
|
|
.PP
|
|
.Vb 8
|
|
\& provider_teardown OSSL_FUNC_PROVIDER_TEARDOWN
|
|
\& provider_gettable_params OSSL_FUNC_PROVIDER_GETTABLE_PARAMS
|
|
\& provider_get_params OSSL_FUNC_PROVIDER_GET_PARAMS
|
|
\& provider_query_operation OSSL_FUNC_PROVIDER_QUERY_OPERATION
|
|
\& provider_unquery_operation OSSL_FUNC_PROVIDER_UNQUERY_OPERATION
|
|
\& provider_get_reason_strings OSSL_FUNC_PROVIDER_GET_REASON_STRINGS
|
|
\& provider_get_capabilities OSSL_FUNC_PROVIDER_GET_CAPABILITIES
|
|
\& provider_self_test OSSL_FUNC_PROVIDER_SELF_TEST
|
|
.Ve
|
|
.SS "Core functions"
|
|
.IX Subsection "Core functions"
|
|
\&\fIcore_gettable_params()\fR returns a constant array of descriptor
|
|
\&\s-1\fIOSSL_PARAM\s0\fR\|(3), for parameters that \fIcore_get_params()\fR can handle.
|
|
.PP
|
|
\&\fIcore_get_params()\fR retrieves parameters from the core for the given \fIhandle\fR.
|
|
See \*(L"Core parameters\*(R" below for a description of currently known
|
|
parameters.
|
|
.PP
|
|
The \fIcore_thread_start()\fR function informs the core that the provider has stated
|
|
an interest in the current thread. The core will inform the provider when the
|
|
thread eventually stops. It must be passed the \fIhandle\fR for this provider, as
|
|
well as a callback \fIhandfn\fR which will be called when the thread stops. The
|
|
callback will subsequently be called, with the supplied argument \fIarg\fR, from
|
|
the thread that is stopping and gets passed the provider context as an
|
|
argument. This may be useful to perform thread specific clean up such as
|
|
freeing thread local variables.
|
|
.PP
|
|
\&\fIcore_get_libctx()\fR retrieves the core context in which the library
|
|
object for the current provider is stored, accessible through the \fIhandle\fR.
|
|
This function is useful only for built-in providers such as the default
|
|
provider. Never cast this to \s-1OSSL_LIB_CTX\s0 in a provider that is not
|
|
built-in as the \s-1OSSL_LIB_CTX\s0 of the library loading the provider might be
|
|
a completely different structure than the \s-1OSSL_LIB_CTX\s0 of the library the
|
|
provider is linked to. Use \fIOSSL_LIB_CTX_new_child\fR\|(3) instead to obtain
|
|
a proper library context that is linked to the application library context.
|
|
.PP
|
|
\&\fIcore_new_error()\fR, \fIcore_set_error_debug()\fR and \fIcore_vset_error()\fR are
|
|
building blocks for reporting an error back to the core, with
|
|
reference to the \fIhandle\fR.
|
|
.IP "\fIcore_new_error()\fR" 4
|
|
.IX Item "core_new_error()"
|
|
allocates a new thread specific error record.
|
|
.Sp
|
|
This corresponds to the OpenSSL function \fIERR_new\fR\|(3).
|
|
.IP "\fIcore_set_error_debug()\fR" 4
|
|
.IX Item "core_set_error_debug()"
|
|
sets debugging information in the current thread specific error
|
|
record.
|
|
The debugging information includes the name of the file \fIfile\fR, the
|
|
line \fIline\fR and the function name \fIfunc\fR where the error occurred.
|
|
.Sp
|
|
This corresponds to the OpenSSL function \fIERR_set_debug\fR\|(3).
|
|
.IP "\fIcore_vset_error()\fR" 4
|
|
.IX Item "core_vset_error()"
|
|
sets the \fIreason\fR for the error, along with any addition data.
|
|
The \fIreason\fR is a number defined by the provider and used to index
|
|
the reason strings table that's returned by
|
|
\&\fIprovider_get_reason_strings()\fR.
|
|
The additional data is given as a format string \fIfmt\fR and a set of
|
|
arguments \fIargs\fR, which are treated in the same manner as with
|
|
\&\fIBIO_vsnprintf()\fR.
|
|
\&\fIfile\fR and \fIline\fR may also be passed to indicate exactly where the
|
|
error occurred or was reported.
|
|
.Sp
|
|
This corresponds to the OpenSSL function \fIERR_vset_error\fR\|(3).
|
|
.PP
|
|
The \fIcore_obj_create()\fR function registers a new \s-1OID\s0 and associated short name
|
|
\&\fIsn\fR and long name \fIln\fR for the given \fIhandle\fR. It is similar to the OpenSSL
|
|
function \fIOBJ_create\fR\|(3) except that it returns 1 on success or 0 on failure.
|
|
It will treat as success the case where the \s-1OID\s0 already exists (even if the
|
|
short name \fIsn\fR or long name \fIln\fR provided as arguments differ from those
|
|
associated with the existing \s-1OID,\s0 in which case the new names are not
|
|
associated).
|
|
.PP
|
|
The \fIcore_obj_add_sigid()\fR function registers a new composite signature algorithm
|
|
(\fIsign_name\fR) consisting of an underlying signature algorithm (\fIpkey_name\fR)
|
|
and digest algorithm (\fIdigest_name\fR) for the given \fIhandle\fR. It assumes that
|
|
the OIDs for the composite signature algorithm as well as for the underlying
|
|
signature and digest algorithms are either already known to OpenSSL or have been
|
|
registered via a call to \fIcore_obj_create()\fR. It corresponds to the OpenSSL
|
|
function \fIOBJ_add_sigid\fR\|(3), except that the objects are identified by name
|
|
rather than a numeric \s-1NID.\s0 Any name (\s-1OID,\s0 short name or long name) can be used
|
|
to identify the object. It will treat as success the case where the composite
|
|
signature algorithm already exists (even if registered against a different
|
|
underlying signature or digest algorithm). For \fIdigest_name\fR, \s-1NULL\s0 or an
|
|
empty string is permissible for signature algorithms that do not need a digest
|
|
to operate correctly. The function returns 1 on success or 0 on failure.
|
|
.PP
|
|
\&\fICRYPTO_malloc()\fR, \fICRYPTO_zalloc()\fR, \fICRYPTO_free()\fR, \fICRYPTO_clear_free()\fR,
|
|
\&\fICRYPTO_realloc()\fR, \fICRYPTO_clear_realloc()\fR, \fICRYPTO_secure_malloc()\fR,
|
|
\&\fICRYPTO_secure_zalloc()\fR, \fICRYPTO_secure_free()\fR,
|
|
\&\fICRYPTO_secure_clear_free()\fR, \fICRYPTO_secure_allocated()\fR,
|
|
\&\fIBIO_new_file()\fR, \fIBIO_new_mem_buf()\fR, \fIBIO_read_ex()\fR, \fIBIO_write_ex()\fR, \fIBIO_up_ref()\fR,
|
|
\&\fIBIO_free()\fR, \fIBIO_vprintf()\fR, \fIBIO_vsnprintf()\fR, \fIBIO_gets()\fR, \fIBIO_puts()\fR,
|
|
\&\fIBIO_ctrl()\fR, \fIOPENSSL_cleanse()\fR and
|
|
\&\fIOPENSSL_hexstr2buf()\fR correspond exactly to the public functions with
|
|
the same name. As a matter of fact, the pointers in the \s-1\fIOSSL_DISPATCH\s0\fR\|(3)
|
|
array are typically direct pointers to those public functions. Note that the \s-1BIO\s0
|
|
functions take an \fB\s-1OSSL_CORE_BIO\s0\fR type rather than the standard \fB\s-1BIO\s0\fR
|
|
type. This is to ensure that a provider does not mix BIOs from the core
|
|
with BIOs used on the provider side (the two are not compatible).
|
|
\&\fIOSSL_SELF_TEST_set_callback()\fR is used to set an optional callback that can be
|
|
passed into a provider. This may be ignored by a provider.
|
|
.PP
|
|
\&\fIget_entropy()\fR retrieves seeding material from the operating system.
|
|
The seeding material will have at least \fIentropy\fR bytes of randomness and the
|
|
output will have at least \fImin_len\fR and at most \fImax_len\fR bytes.
|
|
The buffer address is stored in \fI*pout\fR and the buffer length is
|
|
returned to the caller. On error, zero is returned.
|
|
.PP
|
|
\&\fIget_user_entropy()\fR is the same as \fIget_entropy()\fR except that it will
|
|
attempt to gather seed material via the seed source specified by a call to
|
|
\&\fIRAND_set_seed_source_type\fR\|(3) or via \*(L"Random Configuration\*(R" in \fIconfig\fR\|(5).
|
|
.PP
|
|
\&\fIcleanup_entropy()\fR is used to clean up and free the buffer returned by
|
|
\&\fIget_entropy()\fR. The entropy pointer returned by \fIget_entropy()\fR
|
|
is passed in \fBbuf\fR and its length in \fBlen\fR.
|
|
.PP
|
|
\&\fIcleanup_user_entropy()\fR is used to clean up and free the buffer returned by
|
|
\&\fIget_user_entropy()\fR. The entropy pointer returned by \fIget_user_entropy()\fR
|
|
is passed in \fBbuf\fR and its length in \fBlen\fR.
|
|
.PP
|
|
\&\fIget_nonce()\fR retrieves a nonce using the passed \fIsalt\fR parameter
|
|
of length \fIsalt_len\fR and operating system specific information.
|
|
The \fIsalt\fR should contain uniquely identifying information and this is
|
|
included, in an unspecified manner, as part of the output.
|
|
The output is stored in a buffer which contains at least \fImin_len\fR and at
|
|
most \fImax_len\fR bytes. The buffer address is stored in \fI*pout\fR and the
|
|
buffer length returned to the caller. On error, zero is returned.
|
|
.PP
|
|
\&\fIget_user_nonce()\fR is the same as \fIget_nonce()\fR except that it will attempt
|
|
to gather seed material via the seed source specified by a call to
|
|
\&\fIRAND_set_seed_source_type\fR\|(3) or via \*(L"Random Configuration\*(R" in \fIconfig\fR\|(5).
|
|
.PP
|
|
\&\fIcleanup_nonce()\fR is used to clean up and free the buffer returned by
|
|
\&\fIget_nonce()\fR. The nonce pointer returned by \fIget_nonce()\fR
|
|
is passed in \fBbuf\fR and its length in \fBlen\fR.
|
|
.PP
|
|
\&\fIcleanup_user_nonce()\fR is used to clean up and free the buffer returned by
|
|
\&\fIget_user_nonce()\fR. The nonce pointer returned by \fIget_user_nonce()\fR
|
|
is passed in \fBbuf\fR and its length in \fBlen\fR.
|
|
.PP
|
|
\&\fIprovider_register_child_cb()\fR registers callbacks for being informed about the
|
|
loading and unloading of providers in the application's library context.
|
|
\&\fIhandle\fR is this provider's handle and \fIcbdata\fR is this provider's data
|
|
that will be passed back to the callbacks. It returns 1 on success or 0
|
|
otherwise. These callbacks may be called while holding locks in libcrypto. In
|
|
order to avoid deadlocks the callback implementation must not be long running
|
|
and must not call other OpenSSL \s-1API\s0 functions or upcalls.
|
|
.PP
|
|
\&\fIcreate_cb\fR is a callback that will be called when a new provider is loaded
|
|
into the application's library context. It is also called for any providers that
|
|
are already loaded at the point that this callback is registered. The callback
|
|
is passed the handle being used for the new provider being loadded and this
|
|
provider's data in \fIcbdata\fR. It should return 1 on success or 0 on failure.
|
|
.PP
|
|
\&\fIremove_cb\fR is a callback that will be called when a new provider is unloaded
|
|
from the application's library context. It is passed the handle being used for
|
|
the provider being unloaded and this provider's data in \fIcbdata\fR. It should
|
|
return 1 on success or 0 on failure.
|
|
.PP
|
|
\&\fIglobal_props_cb\fR is a callback that will be called when the global properties
|
|
from the parent library context are changed. It should return 1 on success
|
|
or 0 on failure.
|
|
.PP
|
|
\&\fIprovider_deregister_child_cb()\fR unregisters callbacks previously registered via
|
|
\&\fIprovider_register_child_cb()\fR. If \fIprovider_register_child_cb()\fR has been called
|
|
then \fIprovider_deregister_child_cb()\fR should be called at or before the point that
|
|
this provider's teardown function is called.
|
|
.PP
|
|
\&\fIprovider_name()\fR returns a string giving the name of the provider identified by
|
|
\&\fIhandle\fR.
|
|
.PP
|
|
\&\fIprovider_get0_provider_ctx()\fR returns the provider context that is associated
|
|
with the provider identified by \fIprov\fR.
|
|
.PP
|
|
\&\fIprovider_get0_dispatch()\fR gets the dispatch table registered by the provider
|
|
identified by \fIprov\fR when it initialised.
|
|
.PP
|
|
\&\fIprovider_up_ref()\fR increments the reference count on the provider \fIprov\fR. If
|
|
\&\fIactivate\fR is nonzero then the provider is also loaded if it is not already
|
|
loaded. It returns 1 on success or 0 on failure.
|
|
.PP
|
|
\&\fIprovider_free()\fR decrements the reference count on the provider \fIprov\fR. If
|
|
\&\fIdeactivate\fR is nonzero then the provider is also unloaded if it is not
|
|
already loaded. It returns 1 on success or 0 on failure.
|
|
.SS "Provider functions"
|
|
.IX Subsection "Provider functions"
|
|
\&\fIprovider_teardown()\fR is called when a provider is shut down and removed
|
|
from the core's provider store.
|
|
It must free the passed \fIprovctx\fR.
|
|
.PP
|
|
\&\fIprovider_gettable_params()\fR should return a constant array of
|
|
descriptor \s-1\fIOSSL_PARAM\s0\fR\|(3), for parameters that \fIprovider_get_params()\fR
|
|
can handle.
|
|
.PP
|
|
\&\fIprovider_get_params()\fR should process the \s-1\fIOSSL_PARAM\s0\fR\|(3) array
|
|
\&\fIparams\fR, setting the values of the parameters it understands.
|
|
.PP
|
|
\&\fIprovider_query_operation()\fR should return a constant \s-1\fIOSSL_ALGORITHM\s0\fR\|(3)
|
|
that corresponds to the given \fIoperation_id\fR.
|
|
It should indicate if the core may store a reference to this array by
|
|
setting \fI*no_store\fR to 0 (core may store a reference) or 1 (core may
|
|
not store a reference).
|
|
.PP
|
|
\&\fIprovider_unquery_operation()\fR informs the provider that the result of a
|
|
\&\fIprovider_query_operation()\fR is no longer directly required and that the function
|
|
pointers have been copied. The \fIoperation_id\fR should match that passed to
|
|
\&\fIprovider_query_operation()\fR and \fIalgs\fR should be its return value.
|
|
.PP
|
|
\&\fIprovider_get_reason_strings()\fR should return a constant \s-1\fIOSSL_ITEM\s0\fR\|(3)
|
|
array that provides reason strings for reason codes the provider may
|
|
use when reporting errors using \fIcore_put_error()\fR.
|
|
.PP
|
|
The \fIprovider_get_capabilities()\fR function should call the callback \fIcb\fR passing
|
|
it a set of \s-1\fIOSSL_PARAM\s0\fR\|(3)s and the caller supplied argument \fIarg\fR. The
|
|
\&\s-1\fIOSSL_PARAM\s0\fR\|(3)s should provide details about the capability with the name given
|
|
in the \fIcapability\fR argument relevant for the provider context \fIprovctx\fR. If a
|
|
provider supports multiple capabilities with the given name then it may call the
|
|
callback multiple times (one for each capability). Capabilities can be useful for
|
|
describing the services that a provider can offer. For further details see the
|
|
\&\*(L"\s-1CAPABILITIES\*(R"\s0 section below. It should return 1 on success or 0 on error.
|
|
.PP
|
|
The \fIprovider_self_test()\fR function should perform known answer tests on a subset
|
|
of the algorithms that it uses, and may also verify the integrity of the
|
|
provider module. It should return 1 on success or 0 on error. It will return 1
|
|
if this function is not used.
|
|
.PP
|
|
None of these functions are mandatory, but a provider is fairly
|
|
useless without at least \fIprovider_query_operation()\fR, and
|
|
\&\fIprovider_gettable_params()\fR is fairly useless if not accompanied by
|
|
\&\fIprovider_get_params()\fR.
|
|
.SS "Provider parameters"
|
|
.IX Subsection "Provider parameters"
|
|
\&\fIprovider_get_params()\fR can return the following provider parameters to the core:
|
|
.ie n .IP """name"" (\fB\s-1OSSL_PROV_PARAM_NAME\s0\fR) <\s-1UTF8\s0 ptr>" 4
|
|
.el .IP "``name'' (\fB\s-1OSSL_PROV_PARAM_NAME\s0\fR) <\s-1UTF8\s0 ptr>" 4
|
|
.IX Item "name (OSSL_PROV_PARAM_NAME) <UTF8 ptr>"
|
|
This points to a string that should give a unique name for the provider.
|
|
.ie n .IP """version"" (\fB\s-1OSSL_PROV_PARAM_VERSION\s0\fR) <\s-1UTF8\s0 ptr>" 4
|
|
.el .IP "``version'' (\fB\s-1OSSL_PROV_PARAM_VERSION\s0\fR) <\s-1UTF8\s0 ptr>" 4
|
|
.IX Item "version (OSSL_PROV_PARAM_VERSION) <UTF8 ptr>"
|
|
This points to a string that is a version number associated with this provider.
|
|
OpenSSL in-built providers use \s-1OPENSSL_VERSION_STR,\s0 but this may be different
|
|
for any third party provider. This string is for informational purposes only.
|
|
.ie n .IP """buildinfo"" (\fB\s-1OSSL_PROV_PARAM_BUILDINFO\s0\fR) <\s-1UTF8\s0 ptr>" 4
|
|
.el .IP "``buildinfo'' (\fB\s-1OSSL_PROV_PARAM_BUILDINFO\s0\fR) <\s-1UTF8\s0 ptr>" 4
|
|
.IX Item "buildinfo (OSSL_PROV_PARAM_BUILDINFO) <UTF8 ptr>"
|
|
This points to a string that is a build information associated with this provider.
|
|
OpenSSL in-built providers use \s-1OPENSSL_FULL_VERSION_STR,\s0 but this may be
|
|
different for any third party provider.
|
|
.ie n .IP """status"" (\fB\s-1OSSL_PROV_PARAM_STATUS\s0\fR) <unsigned integer>" 4
|
|
.el .IP "``status'' (\fB\s-1OSSL_PROV_PARAM_STATUS\s0\fR) <unsigned integer>" 4
|
|
.IX Item "status (OSSL_PROV_PARAM_STATUS) <unsigned integer>"
|
|
This returns 0 if the provider has entered an error state, otherwise it returns
|
|
1.
|
|
.PP
|
|
\&\fIprovider_gettable_params()\fR should return the above parameters.
|
|
.SS "Core parameters"
|
|
.IX Subsection "Core parameters"
|
|
\&\fIcore_get_params()\fR can retrieve the following core parameters for each provider:
|
|
.ie n .IP """openssl-version"" (\fB\s-1OSSL_PROV_PARAM_CORE_VERSION\s0\fR) <\s-1UTF8\s0 string ptr>" 4
|
|
.el .IP "``openssl-version'' (\fB\s-1OSSL_PROV_PARAM_CORE_VERSION\s0\fR) <\s-1UTF8\s0 string ptr>" 4
|
|
.IX Item "openssl-version (OSSL_PROV_PARAM_CORE_VERSION) <UTF8 string ptr>"
|
|
This points to the OpenSSL libraries' full version string, i.e. the string
|
|
expanded from the macro \fB\s-1OPENSSL_VERSION_STR\s0\fR.
|
|
.ie n .IP """provider-name"" (\fB\s-1OSSL_PROV_PARAM_CORE_PROV_NAME\s0\fR) <\s-1UTF8\s0 string ptr>" 4
|
|
.el .IP "``provider-name'' (\fB\s-1OSSL_PROV_PARAM_CORE_PROV_NAME\s0\fR) <\s-1UTF8\s0 string ptr>" 4
|
|
.IX Item "provider-name (OSSL_PROV_PARAM_CORE_PROV_NAME) <UTF8 string ptr>"
|
|
This points to the OpenSSL libraries' idea of what the calling provider is named.
|
|
.ie n .IP """module-filename"" (\fB\s-1OSSL_PROV_PARAM_CORE_MODULE_FILENAME\s0\fR) <\s-1UTF8\s0 string ptr>" 4
|
|
.el .IP "``module-filename'' (\fB\s-1OSSL_PROV_PARAM_CORE_MODULE_FILENAME\s0\fR) <\s-1UTF8\s0 string ptr>" 4
|
|
.IX Item "module-filename (OSSL_PROV_PARAM_CORE_MODULE_FILENAME) <UTF8 string ptr>"
|
|
This points to a string containing the full filename of the providers
|
|
module file.
|
|
.PP
|
|
Additionally, provider specific configuration parameters from the
|
|
config file are available, in dotted name form.
|
|
The dotted name form is a concatenation of section names and final
|
|
config command name separated by periods.
|
|
.PP
|
|
For example, let's say we have the following config example:
|
|
.PP
|
|
.Vb 2
|
|
\& config_diagnostics = 1
|
|
\& openssl_conf = openssl_init
|
|
\&
|
|
\& [openssl_init]
|
|
\& providers = providers_sect
|
|
\&
|
|
\& [providers_sect]
|
|
\& foo = foo_sect
|
|
\&
|
|
\& [foo_sect]
|
|
\& activate = 1
|
|
\& data1 = 2
|
|
\& data2 = str
|
|
\& more = foo_more
|
|
\&
|
|
\& [foo_more]
|
|
\& data3 = foo,bar
|
|
.Ve
|
|
.PP
|
|
The provider will have these additional parameters available:
|
|
.ie n .IP """activate""" 4
|
|
.el .IP "``activate''" 4
|
|
.IX Item "activate"
|
|
pointing at the string \*(L"1\*(R"
|
|
.ie n .IP """data1""" 4
|
|
.el .IP "``data1''" 4
|
|
.IX Item "data1"
|
|
pointing at the string \*(L"2\*(R"
|
|
.ie n .IP """data2""" 4
|
|
.el .IP "``data2''" 4
|
|
.IX Item "data2"
|
|
pointing at the string \*(L"str\*(R"
|
|
.ie n .IP """more.data3""" 4
|
|
.el .IP "``more.data3''" 4
|
|
.IX Item "more.data3"
|
|
pointing at the string \*(L"foo,bar\*(R"
|
|
.PP
|
|
For more information on handling parameters, see \s-1\fIOSSL_PARAM\s0\fR\|(3) as
|
|
\&\fIOSSL_PARAM_int\fR\|(3).
|
|
.SH "CAPABILITIES"
|
|
.IX Header "CAPABILITIES"
|
|
Capabilities describe some of the services that a provider can offer.
|
|
Applications can query the capabilities to discover those services.
|
|
.PP
|
|
\fI\*(L"TLS-GROUP\*(R" Capability\fR
|
|
.IX Subsection "TLS-GROUP Capability"
|
|
.PP
|
|
The \*(L"TLS-GROUP\*(R" capability can be queried by libssl to discover the list of
|
|
\&\s-1TLS\s0 groups that a provider can support. Each group supported can be used for
|
|
\&\fIkey exchange\fR (\s-1KEX\s0) or \fIkey encapsulation method\fR (\s-1KEM\s0) during a \s-1TLS\s0
|
|
handshake.
|
|
\&\s-1TLS\s0 clients can advertise the list of \s-1TLS\s0 groups they support in the
|
|
supported_groups extension, and \s-1TLS\s0 servers can select a group from the offered
|
|
list that they also support. In this way a provider can add to the list of
|
|
groups that libssl already supports with additional ones.
|
|
.PP
|
|
Each \s-1TLS\s0 group that a provider supports should be described via the callback
|
|
passed in through the provider_get_capabilities function. Each group should have
|
|
the following details supplied (all are mandatory, except
|
|
\&\fB\s-1OSSL_CAPABILITY_TLS_GROUP_IS_KEM\s0\fR):
|
|
.ie n .IP """tls-group-name"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``tls-group-name'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "tls-group-name (OSSL_CAPABILITY_TLS_GROUP_NAME) <UTF8 string>"
|
|
The name of the group as given in the \s-1IANA TLS\s0 Supported Groups registry
|
|
<https://www.iana.org/assignments/tls\-parameters/tls\-parameters.xhtml#tls\-parameters\-8>.
|
|
.ie n .IP """tls-group-name-internal"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``tls-group-name-internal'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "tls-group-name-internal (OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL) <UTF8 string>"
|
|
The name of the group as known by the provider. This could be the same as the
|
|
\&\*(L"tls-group-name\*(R", but does not have to be.
|
|
.ie n .IP """tls-group-id"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_ID\s0\fR) <unsigned integer>" 4
|
|
.el .IP "``tls-group-id'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_ID\s0\fR) <unsigned integer>" 4
|
|
.IX Item "tls-group-id (OSSL_CAPABILITY_TLS_GROUP_ID) <unsigned integer>"
|
|
The \s-1TLS\s0 group id value as given in the \s-1IANA TLS\s0 Supported Groups registry.
|
|
.ie n .IP """tls-group-alg"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_ALG\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``tls-group-alg'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_ALG\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "tls-group-alg (OSSL_CAPABILITY_TLS_GROUP_ALG) <UTF8 string>"
|
|
The name of a Key Management algorithm that the provider offers and that should
|
|
be used with this group. Keys created should be able to support \fIkey exchange\fR
|
|
or \fIkey encapsulation method\fR (\s-1KEM\s0), as implied by the optional
|
|
\&\fB\s-1OSSL_CAPABILITY_TLS_GROUP_IS_KEM\s0\fR flag.
|
|
The algorithm must support key and parameter generation as well as the
|
|
key/parameter generation parameter, \fB\s-1OSSL_PKEY_PARAM_GROUP_NAME\s0\fR. The group
|
|
name given via \*(L"tls-group-name-internal\*(R" above will be passed via
|
|
\&\fB\s-1OSSL_PKEY_PARAM_GROUP_NAME\s0\fR when libssl wishes to generate keys/parameters.
|
|
.ie n .IP """tls-group-sec-bits"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS\s0\fR) <unsigned integer>" 4
|
|
.el .IP "``tls-group-sec-bits'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS\s0\fR) <unsigned integer>" 4
|
|
.IX Item "tls-group-sec-bits (OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS) <unsigned integer>"
|
|
The number of bits of security offered by keys in this group. The number of bits
|
|
should be comparable with the ones given in table 2 and 3 of the \s-1NIST SP800\-57\s0
|
|
document.
|
|
.ie n .IP """tls-group-is-kem"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_IS_KEM\s0\fR) <unsigned integer>" 4
|
|
.el .IP "``tls-group-is-kem'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_IS_KEM\s0\fR) <unsigned integer>" 4
|
|
.IX Item "tls-group-is-kem (OSSL_CAPABILITY_TLS_GROUP_IS_KEM) <unsigned integer>"
|
|
Boolean flag to describe if the group should be used in \fIkey exchange\fR (\s-1KEX\s0)
|
|
mode (0, default) or in \fIkey encapsulation method\fR (\s-1KEM\s0) mode (1).
|
|
.Sp
|
|
This parameter is optional: if not specified, \s-1KEX\s0 mode is assumed as the default
|
|
mode for the group.
|
|
.Sp
|
|
In \s-1KEX\s0 mode, in a typical Diffie-Hellman fashion, both sides execute \fIkeygen\fR
|
|
then \fIderive\fR against the peer public key. To operate in \s-1KEX\s0 mode, the group
|
|
implementation must support the provider functions as described in
|
|
\&\fIprovider\-keyexch\fR\|(7).
|
|
.Sp
|
|
In \s-1KEM\s0 mode, the client executes \fIkeygen\fR and sends its public key, the server
|
|
executes \fIencapsulate\fR using the client's public key and sends back the
|
|
resulting \fIciphertext\fR, finally the client executes \fIdecapsulate\fR to retrieve
|
|
the same \fIshared secret\fR generated by the server's \fIencapsulate\fR. To operate
|
|
in \s-1KEM\s0 mode, the group implementation must support the provider functions as
|
|
described in \fIprovider\-kem\fR\|(7).
|
|
.Sp
|
|
Both in \s-1KEX\s0 and \s-1KEM\s0 mode, the resulting \fIshared secret\fR is then used according
|
|
to the protocol specification.
|
|
.ie n .IP """tls-min-tls"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_MIN_TLS\s0\fR) <integer>" 4
|
|
.el .IP "``tls-min-tls'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_MIN_TLS\s0\fR) <integer>" 4
|
|
.IX Item "tls-min-tls (OSSL_CAPABILITY_TLS_GROUP_MIN_TLS) <integer>"
|
|
.PD 0
|
|
.ie n .IP """tls-max-tls"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_MAX_TLS\s0\fR) <integer>" 4
|
|
.el .IP "``tls-max-tls'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_MAX_TLS\s0\fR) <integer>" 4
|
|
.IX Item "tls-max-tls (OSSL_CAPABILITY_TLS_GROUP_MAX_TLS) <integer>"
|
|
.ie n .IP """tls-min-dtls"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS\s0\fR) <integer>" 4
|
|
.el .IP "``tls-min-dtls'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS\s0\fR) <integer>" 4
|
|
.IX Item "tls-min-dtls (OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS) <integer>"
|
|
.ie n .IP """tls-max-dtls"" (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS\s0\fR) <integer>" 4
|
|
.el .IP "``tls-max-dtls'' (\fB\s-1OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS\s0\fR) <integer>" 4
|
|
.IX Item "tls-max-dtls (OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS) <integer>"
|
|
.PD
|
|
These parameters can be used to describe the minimum and maximum \s-1TLS\s0 and \s-1DTLS\s0
|
|
versions supported by the group. The values equate to the on-the-wire encoding
|
|
of the various \s-1TLS\s0 versions. For example TLSv1.3 is 0x0304 (772 decimal), and
|
|
TLSv1.2 is 0x0303 (771 decimal). A 0 indicates that there is no defined minimum
|
|
or maximum. A \-1 indicates that the group should not be used in that protocol.
|
|
.PP
|
|
\fI\*(L"TLS-SIGALG\*(R" Capability\fR
|
|
.IX Subsection "TLS-SIGALG Capability"
|
|
.PP
|
|
The \*(L"TLS-SIGALG\*(R" capability can be queried by libssl to discover the list of
|
|
\&\s-1TLS\s0 signature algorithms that a provider can support. Each signature supported
|
|
can be used for client\- or server-authentication in addition to the built-in
|
|
signature algorithms.
|
|
\&\s-1TLS1.3\s0 clients can advertise the list of \s-1TLS\s0 signature algorithms they support
|
|
in the signature_algorithms extension, and \s-1TLS\s0 servers can select an algorithm
|
|
from the offered list that they also support. In this way a provider can add
|
|
to the list of signature algorithms that libssl already supports with
|
|
additional ones.
|
|
.PP
|
|
Each \s-1TLS\s0 signature algorithm that a provider supports should be described via
|
|
the callback passed in through the provider_get_capabilities function. Each
|
|
algorithm can have the following details supplied:
|
|
.ie n .IP """iana-name"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_IANA_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``iana-name'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_IANA_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "iana-name (OSSL_CAPABILITY_TLS_SIGALG_IANA_NAME) <UTF8 string>"
|
|
The name of the signature algorithm as given in the \s-1IANA TLS\s0 Signature Scheme
|
|
registry as \*(L"Description\*(R":
|
|
<https://www.iana.org/assignments/tls\-parameters/tls\-parameters.xhtml#tls\-signaturescheme>.
|
|
This value must be supplied.
|
|
.ie n .IP """iana-code-point"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_CODE_POINT\s0\fR) <unsigned integer>" 4
|
|
.el .IP "``iana-code-point'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_CODE_POINT\s0\fR) <unsigned integer>" 4
|
|
.IX Item "iana-code-point (OSSL_CAPABILITY_TLS_SIGALG_CODE_POINT) <unsigned integer>"
|
|
The \s-1TLS\s0 algorithm \s-1ID\s0 value as given in the \s-1IANA TLS\s0 SignatureScheme registry.
|
|
This value must be supplied.
|
|
.ie n .IP """sigalg-name"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``sigalg-name'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "sigalg-name (OSSL_CAPABILITY_TLS_SIGALG_NAME) <UTF8 string>"
|
|
A name for the full (possibly composite hash-and-signature) signature
|
|
algorithm.
|
|
The provider may, but is not obligated to, provide a signature implementation
|
|
with this name; if it doesn't, this is assumed to be a composite of a pure
|
|
signature algorithm and a hash algorithm, which must be given with the
|
|
parameters \*(L"sig-name\*(R" and \*(L"hash-name\*(R".
|
|
This value must be supplied.
|
|
.ie n .IP """sigalg-oid"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_OID\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``sigalg-oid'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_OID\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "sigalg-oid (OSSL_CAPABILITY_TLS_SIGALG_OID) <UTF8 string>"
|
|
The \s-1OID\s0 of the \*(L"sigalg-name\*(R" algorithm in canonical numeric text form. If
|
|
this parameter is given, \fIOBJ_create()\fR will be used to create an \s-1OBJ\s0 and
|
|
a \s-1NID\s0 for this \s-1OID,\s0 using the \*(L"sigalg-name\*(R" parameter for its (short) name.
|
|
Otherwise, it's assumed to already exist in the object database, possibly
|
|
done by the provider with the \fIcore_obj_create()\fR upcall.
|
|
This value is optional.
|
|
.ie n .IP """sig-name"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_SIG_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``sig-name'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_SIG_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "sig-name (OSSL_CAPABILITY_TLS_SIGALG_SIG_NAME) <UTF8 string>"
|
|
The name of the pure signature algorithm that is part of a composite
|
|
\&\*(L"sigalg-name\*(R". If \*(L"sigalg-name\*(R" is implemented by the provider, this
|
|
parameter is redundant and must not be given.
|
|
This value is optional.
|
|
.ie n .IP """sig-oid"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_SIG_OID\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``sig-oid'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_SIG_OID\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "sig-oid (OSSL_CAPABILITY_TLS_SIGALG_SIG_OID) <UTF8 string>"
|
|
The \s-1OID\s0 of the \*(L"sig-name\*(R" algorithm in canonical numeric text form. If
|
|
this parameter is given, \fIOBJ_create()\fR will be used to create an \s-1OBJ\s0 and
|
|
a \s-1NID\s0 for this \s-1OID,\s0 using the \*(L"sig-name\*(R" parameter for its (short) name.
|
|
Otherwise, it is assumed to already exist in the object database. This
|
|
can be done by the provider using the \fIcore_obj_create()\fR upcall.
|
|
This value is optional.
|
|
.ie n .IP """hash-name"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_HASH_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``hash-name'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_HASH_NAME\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "hash-name (OSSL_CAPABILITY_TLS_SIGALG_HASH_NAME) <UTF8 string>"
|
|
The name of the hash algorithm that is part of a composite \*(L"sigalg-name\*(R".
|
|
If \*(L"sigalg-name\*(R" is implemented by the provider, this parameter is redundant
|
|
and must not be given.
|
|
This value is optional.
|
|
.ie n .IP """hash-oid"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_HASH_OID\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``hash-oid'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_HASH_OID\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "hash-oid (OSSL_CAPABILITY_TLS_SIGALG_HASH_OID) <UTF8 string>"
|
|
The \s-1OID\s0 of the \*(L"hash-name\*(R" algorithm in canonical numeric text form. If
|
|
this parameter is given, \fIOBJ_create()\fR will be used to create an \s-1OBJ\s0 and
|
|
a \s-1NID\s0 for this \s-1OID,\s0 using the \*(L"hash-name\*(R" parameter for its (short) name.
|
|
Otherwise, it's assumed to already exist in the object database, possibly
|
|
done by the provider with the \fIcore_obj_create()\fR upcall.
|
|
This value is optional.
|
|
.ie n .IP """key-type"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_KEYTYPE\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``key-type'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_KEYTYPE\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "key-type (OSSL_CAPABILITY_TLS_SIGALG_KEYTYPE) <UTF8 string>"
|
|
The key type of the public key of applicable certificates. If this parameter
|
|
isn't present, it's assumed to be the same as \*(L"sig-name\*(R" if that's present,
|
|
otherwise \*(L"sigalg-name\*(R".
|
|
This value is optional.
|
|
.ie n .IP """key-type-oid"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_KEYTYPE_OID\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``key-type-oid'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_KEYTYPE_OID\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "key-type-oid (OSSL_CAPABILITY_TLS_SIGALG_KEYTYPE_OID) <UTF8 string>"
|
|
The \s-1OID\s0 of the \*(L"key-type\*(R" in canonical numeric text form. If
|
|
this parameter is given, \fIOBJ_create()\fR will be used to create an \s-1OBJ\s0 and
|
|
a \s-1NID\s0 for this \s-1OID,\s0 using the \*(L"key-type\*(R" parameter for its (short) name.
|
|
Otherwise, it's assumed to already exist in the object database, possibly
|
|
done by the provider with the \fIcore_obj_create()\fR upcall.
|
|
This value is optional.
|
|
.ie n .IP """sec-bits"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_SECURITY_BITS\s0\fR) <unsigned integer>" 4
|
|
.el .IP "``sec-bits'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_SECURITY_BITS\s0\fR) <unsigned integer>" 4
|
|
.IX Item "sec-bits (OSSL_CAPABILITY_TLS_SIGALG_SECURITY_BITS) <unsigned integer>"
|
|
The number of bits of security offered by keys of this algorithm. The number
|
|
of bits should be comparable with the ones given in table 2 and 3 of the \s-1NIST
|
|
SP800\-57\s0 document. This number is used to determine the security strength of
|
|
the algorithm if no digest algorithm has been registered that otherwise
|
|
defines the security strength. If the signature algorithm implements its own
|
|
digest internally, this value needs to be set to properly reflect the overall
|
|
security strength.
|
|
This value must be supplied.
|
|
.ie n .IP """tls-min-tls"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_MIN_TLS\s0\fR) <integer>" 4
|
|
.el .IP "``tls-min-tls'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_MIN_TLS\s0\fR) <integer>" 4
|
|
.IX Item "tls-min-tls (OSSL_CAPABILITY_TLS_SIGALG_MIN_TLS) <integer>"
|
|
.PD 0
|
|
.ie n .IP """tls-max-tls"" (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_MAX_TLS\s0\fR) <integer>" 4
|
|
.el .IP "``tls-max-tls'' (\fB\s-1OSSL_CAPABILITY_TLS_SIGALG_MAX_TLS\s0\fR) <integer>" 4
|
|
.IX Item "tls-max-tls (OSSL_CAPABILITY_TLS_SIGALG_MAX_TLS) <integer>"
|
|
.PD
|
|
These parameters can be used to describe the minimum and maximum \s-1TLS\s0
|
|
versions supported by the signature algorithm. The values equate to the
|
|
on-the-wire encoding of the various \s-1TLS\s0 versions. For example TLSv1.3 is
|
|
0x0304 (772 decimal), and TLSv1.2 is 0x0303 (771 decimal). A 0 indicates that
|
|
there is no defined minimum or maximum. A \-1 indicates that the signature
|
|
algorithm should not be used in that protocol.
|
|
Presently values representing anything other than \s-1TLS1.3\s0 mean that the
|
|
complete algorithm is ignored.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The \fIcore_obj_create()\fR and \fIcore_obj_add_sigid()\fR functions were not thread safe
|
|
in OpenSSL 3.0.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
This is an example of a simple provider made available as a
|
|
dynamically loadable module.
|
|
It implements the fictitious algorithm \f(CW\*(C`FOO\*(C'\fR for the fictitious
|
|
operation \f(CW\*(C`BAR\*(C'\fR.
|
|
.PP
|
|
.Vb 3
|
|
\& #include <malloc.h>
|
|
\& #include <openssl/core.h>
|
|
\& #include <openssl/core_dispatch.h>
|
|
\&
|
|
\& /* Errors used in this provider */
|
|
\& #define E_MALLOC 1
|
|
\&
|
|
\& static const OSSL_ITEM reasons[] = {
|
|
\& { E_MALLOC, "memory allocation failure" }.
|
|
\& OSSL_DISPATCH_END
|
|
\& };
|
|
\&
|
|
\& /*
|
|
\& * To ensure we get the function signature right, forward declare
|
|
\& * them using function types provided by openssl/core_dispatch.h
|
|
\& */
|
|
\& OSSL_FUNC_bar_newctx_fn foo_newctx;
|
|
\& OSSL_FUNC_bar_freectx_fn foo_freectx;
|
|
\& OSSL_FUNC_bar_init_fn foo_init;
|
|
\& OSSL_FUNC_bar_update_fn foo_update;
|
|
\& OSSL_FUNC_bar_final_fn foo_final;
|
|
\&
|
|
\& OSSL_FUNC_provider_query_operation_fn p_query;
|
|
\& OSSL_FUNC_provider_get_reason_strings_fn p_reasons;
|
|
\& OSSL_FUNC_provider_teardown_fn p_teardown;
|
|
\&
|
|
\& OSSL_provider_init_fn OSSL_provider_init;
|
|
\&
|
|
\& OSSL_FUNC_core_put_error *c_put_error = NULL;
|
|
\&
|
|
\& /* Provider context */
|
|
\& struct prov_ctx_st {
|
|
\& OSSL_CORE_HANDLE *handle;
|
|
\& }
|
|
\&
|
|
\& /* operation context for the algorithm FOO */
|
|
\& struct foo_ctx_st {
|
|
\& struct prov_ctx_st *provctx;
|
|
\& int b;
|
|
\& };
|
|
\&
|
|
\& static void *foo_newctx(void *provctx)
|
|
\& {
|
|
\& struct foo_ctx_st *fooctx = malloc(sizeof(*fooctx));
|
|
\&
|
|
\& if (fooctx != NULL)
|
|
\& fooctx\->provctx = provctx;
|
|
\& else
|
|
\& c_put_error(provctx\->handle, E_MALLOC, _\|_FILE_\|_, _\|_LINE_\|_);
|
|
\& return fooctx;
|
|
\& }
|
|
\&
|
|
\& static void foo_freectx(void *fooctx)
|
|
\& {
|
|
\& free(fooctx);
|
|
\& }
|
|
\&
|
|
\& static int foo_init(void *vfooctx)
|
|
\& {
|
|
\& struct foo_ctx_st *fooctx = vfooctx;
|
|
\&
|
|
\& fooctx\->b = 0x33;
|
|
\& }
|
|
\&
|
|
\& static int foo_update(void *vfooctx, unsigned char *in, size_t inl)
|
|
\& {
|
|
\& struct foo_ctx_st *fooctx = vfooctx;
|
|
\&
|
|
\& /* did you expect something serious? */
|
|
\& if (inl == 0)
|
|
\& return 1;
|
|
\& for (; inl\-\- > 0; in++)
|
|
\& *in ^= fooctx\->b;
|
|
\& return 1;
|
|
\& }
|
|
\&
|
|
\& static int foo_final(void *vfooctx)
|
|
\& {
|
|
\& struct foo_ctx_st *fooctx = vfooctx;
|
|
\&
|
|
\& fooctx\->b = 0x66;
|
|
\& }
|
|
\&
|
|
\& static const OSSL_DISPATCH foo_fns[] = {
|
|
\& { OSSL_FUNC_BAR_NEWCTX, (void (*)(void))foo_newctx },
|
|
\& { OSSL_FUNC_BAR_FREECTX, (void (*)(void))foo_freectx },
|
|
\& { OSSL_FUNC_BAR_INIT, (void (*)(void))foo_init },
|
|
\& { OSSL_FUNC_BAR_UPDATE, (void (*)(void))foo_update },
|
|
\& { OSSL_FUNC_BAR_FINAL, (void (*)(void))foo_final },
|
|
\& OSSL_DISPATCH_END
|
|
\& };
|
|
\&
|
|
\& static const OSSL_ALGORITHM bars[] = {
|
|
\& { "FOO", "provider=chumbawamba", foo_fns },
|
|
\& { NULL, NULL, NULL }
|
|
\& };
|
|
\&
|
|
\& static const OSSL_ALGORITHM *p_query(void *provctx, int operation_id,
|
|
\& int *no_store)
|
|
\& {
|
|
\& switch (operation_id) {
|
|
\& case OSSL_OP_BAR:
|
|
\& return bars;
|
|
\& }
|
|
\& return NULL;
|
|
\& }
|
|
\&
|
|
\& static const OSSL_ITEM *p_reasons(void *provctx)
|
|
\& {
|
|
\& return reasons;
|
|
\& }
|
|
\&
|
|
\& static void p_teardown(void *provctx)
|
|
\& {
|
|
\& free(provctx);
|
|
\& }
|
|
\&
|
|
\& static const OSSL_DISPATCH prov_fns[] = {
|
|
\& { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))p_teardown },
|
|
\& { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))p_query },
|
|
\& { OSSL_FUNC_PROVIDER_GET_REASON_STRINGS, (void (*)(void))p_reasons },
|
|
\& OSSL_DISPATCH_END
|
|
\& };
|
|
\&
|
|
\& int OSSL_provider_init(const OSSL_CORE_HANDLE *handle,
|
|
\& const OSSL_DISPATCH *in,
|
|
\& const OSSL_DISPATCH **out,
|
|
\& void **provctx)
|
|
\& {
|
|
\& struct prov_ctx_st *pctx = NULL;
|
|
\&
|
|
\& for (; in\->function_id != 0; in++)
|
|
\& switch (in\->function_id) {
|
|
\& case OSSL_FUNC_CORE_PUT_ERROR:
|
|
\& c_put_error = OSSL_FUNC_core_put_error(in);
|
|
\& break;
|
|
\& }
|
|
\&
|
|
\& *out = prov_fns;
|
|
\&
|
|
\& if ((pctx = malloc(sizeof(*pctx))) == NULL) {
|
|
\& /*
|
|
\& * ALEA IACTA EST, if the core retrieves the reason table
|
|
\& * regardless, that string will be displayed, otherwise not.
|
|
\& */
|
|
\& c_put_error(handle, E_MALLOC, _\|_FILE_\|_, _\|_LINE_\|_);
|
|
\& return 0;
|
|
\& }
|
|
\& pctx\->handle = handle;
|
|
\& return 1;
|
|
\& }
|
|
.Ve
|
|
.PP
|
|
This relies on a few things existing in \fIopenssl/core_dispatch.h\fR:
|
|
.PP
|
|
.Vb 1
|
|
\& #define OSSL_OP_BAR 4711
|
|
\&
|
|
\& #define OSSL_FUNC_BAR_NEWCTX 1
|
|
\& typedef void *(OSSL_FUNC_bar_newctx_fn)(void *provctx);
|
|
\& static ossl_inline OSSL_FUNC_bar_newctx(const OSSL_DISPATCH *opf)
|
|
\& { return (OSSL_FUNC_bar_newctx_fn *)opf\->function; }
|
|
\&
|
|
\& #define OSSL_FUNC_BAR_FREECTX 2
|
|
\& typedef void (OSSL_FUNC_bar_freectx_fn)(void *ctx);
|
|
\& static ossl_inline OSSL_FUNC_bar_freectx(const OSSL_DISPATCH *opf)
|
|
\& { return (OSSL_FUNC_bar_freectx_fn *)opf\->function; }
|
|
\&
|
|
\& #define OSSL_FUNC_BAR_INIT 3
|
|
\& typedef void *(OSSL_FUNC_bar_init_fn)(void *ctx);
|
|
\& static ossl_inline OSSL_FUNC_bar_init(const OSSL_DISPATCH *opf)
|
|
\& { return (OSSL_FUNC_bar_init_fn *)opf\->function; }
|
|
\&
|
|
\& #define OSSL_FUNC_BAR_UPDATE 4
|
|
\& typedef void *(OSSL_FUNC_bar_update_fn)(void *ctx,
|
|
\& unsigned char *in, size_t inl);
|
|
\& static ossl_inline OSSL_FUNC_bar_update(const OSSL_DISPATCH *opf)
|
|
\& { return (OSSL_FUNC_bar_update_fn *)opf\->function; }
|
|
\&
|
|
\& #define OSSL_FUNC_BAR_FINAL 5
|
|
\& typedef void *(OSSL_FUNC_bar_final_fn)(void *ctx);
|
|
\& static ossl_inline OSSL_FUNC_bar_final(const OSSL_DISPATCH *opf)
|
|
\& { return (OSSL_FUNC_bar_final_fn *)opf\->function; }
|
|
.Ve
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIprovider\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The concept of providers and everything surrounding them was
|
|
introduced in OpenSSL 3.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2019\-2023 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|