247 lines
8.2 KiB
Groff
Executable File
247 lines
8.2 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" 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" ''
|
|
'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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" 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 "OSSL_PROVIDER 3"
|
|
.TH OSSL_PROVIDER 3 "2020-03-02" "3.0.0-dev" "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"
|
|
OSSL_PROVIDER, OSSL_PROVIDER_load, OSSL_PROVIDER_unload,
|
|
OSSL_PROVIDER_available,
|
|
OSSL_PROVIDER_gettable_params, OSSL_PROVIDER_get_params,
|
|
OSSL_PROVIDER_add_builtin, OSSL_PROVIDER_name \- provider routines
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/provider.h>
|
|
\&
|
|
\& typedef struct ossl_provider_st OSSL_PROVIDER;
|
|
\&
|
|
\& OSSL_PROVIDER *OSSL_PROVIDER_load(OPENSSL_CTX *libctx, const char *name);
|
|
\& int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
|
|
\& int OSSL_PROVIDER_available(OPENSSL_CTX *libctx, const char *name);
|
|
\&
|
|
\& const OSSL_PARAM *OSSL_PROVIDER_gettable_params(OSSL_PROVIDER *prov);
|
|
\& int OSSL_PROVIDER_get_params(OSSL_PROVIDER *prov, OSSL_PARAM params[]);
|
|
\&
|
|
\& int OSSL_PROVIDER_add_builtin(OPENSSL_CTX *libctx, const char *name,
|
|
\& ossl_provider_init_fn *init_fn);
|
|
\&
|
|
\& const char *OSSL_PROVIDER_name(const OSSL_PROVIDER *prov);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fB\s-1OSSL_PROVIDER\s0\fR is a type that holds internal information about
|
|
implementation providers (see \fIprovider\fR\|(7) for information on what a
|
|
provider is).
|
|
A provider can be built in to the application or the OpenSSL
|
|
libraries, or can be a loadable module.
|
|
The functions described here handle both forms.
|
|
.PP
|
|
Some of these functions operate within a library context, please see
|
|
\&\s-1\fIOPENSSL_CTX\s0\fR\|(3) for further details.
|
|
.SS "Functions"
|
|
.IX Subsection "Functions"
|
|
\&\fIOSSL_PROVIDER_add_builtin()\fR is used to add a built in provider to
|
|
\&\fB\s-1OSSL_PROVIDER\s0\fR store in the given library context, by associating a
|
|
provider name with a provider initialization function.
|
|
This name can then be used with \fIOSSL_PROVIDER_load()\fR.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_load()\fR loads and initializes a provider.
|
|
This may simply initialize a provider that was previously added with
|
|
\&\fIOSSL_PROVIDER_add_builtin()\fR and run its given initialization function,
|
|
or load a provider module with the given name and run its provider
|
|
entry point, \f(CW\*(C`OSSL_provider_init\*(C'\fR.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_unload()\fR unloads the given provider.
|
|
For a provider added with \fIOSSL_PROVIDER_add_builtin()\fR, this simply
|
|
runs its teardown function.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_available()\fR checks if a named provider is available
|
|
for use.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_gettable_params()\fR is used to get a provider parameter
|
|
descriptor set as a constant \fB\s-1OSSL_PARAM\s0\fR array.
|
|
See \s-1\fIOSSL_PARAM\s0\fR\|(3) for more information.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_get_params()\fR is used to get provider parameter values.
|
|
The caller must prepare the \fB\s-1OSSL_PARAM\s0\fR array before calling this
|
|
function, and the variables acting as buffers for this parameter array
|
|
should be filled with data when it returns successfully.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_name()\fR returns the name of the given provider.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIOSSL_PROVIDER_add()\fR returns 1 on success, or 0 on error.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_load()\fR returns a pointer to a provider object on
|
|
success, or \fB\s-1NULL\s0\fR on error.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_unload()\fR returns 1 on success, or 0 on error.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_available()\fR returns 1 if the named provider is available,
|
|
otherwise 0.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_gettable_params()\fR returns a pointer to an array
|
|
of constant \fB\s-1OSSL_PARAM\s0\fR, or \s-1NULL\s0 if none is provided.
|
|
.PP
|
|
\&\fIOSSL_PROVIDER_get_params()\fR returns 1 on success, or 0 on error.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
This demonstrates how to load the provider module \*(L"foo\*(R" and ask for
|
|
its build number.
|
|
.PP
|
|
.Vb 7
|
|
\& OSSL_PROVIDER *prov = NULL;
|
|
\& const char *build = NULL;
|
|
\& size_t built_l = 0;
|
|
\& OSSL_PARAM request[] = {
|
|
\& { "build", OSSL_PARAM_UTF8_STRING_PTR, &build, 0, &build_l },
|
|
\& { NULL, 0, NULL, 0, NULL }
|
|
\& };
|
|
\&
|
|
\& if ((prov = OSSL_PROVIDER_load(NULL, "foo")) != NULL
|
|
\& && OSSL_PROVIDER_get_params(prov, request))
|
|
\& printf("Provider \*(Aqfoo\*(Aq build %s\en", build);
|
|
\& else
|
|
\& ERR_print_errors_fp(stderr);
|
|
.Ve
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIopenssl\-core.h\fR\|(7), \s-1\fIOPENSSL_CTX\s0\fR\|(3), \fIprovider\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The type and functions described here were added in OpenSSL 3.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2019 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>.
|