356 lines
15 KiB
Groff
Executable File
356 lines
15 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 "PROVIDER-SIGNATURE 7"
|
|
.TH PROVIDER-SIGNATURE 7 "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"
|
|
provider\-signature \- The signature library <\-> provider functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 2
|
|
\& #include <openssl/core_numbers.h>
|
|
\& #include <openssl/core_names.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.
|
|
\& */
|
|
\&
|
|
\& /* Context management */
|
|
\& void *OP_signature_newctx(void *provctx);
|
|
\& void OP_signature_freectx(void *ctx);
|
|
\& void *OP_signature_dupctx(void *ctx);
|
|
\&
|
|
\& /* Signing */
|
|
\& int OP_signature_sign_init(void *ctx, void *provkey);
|
|
\& int OP_signature_sign(void *ctx, unsigned char *sig, size_t *siglen,
|
|
\& size_t sigsize, const unsigned char *tbs, size_t tbslen);
|
|
\&
|
|
\& /* Verifying */
|
|
\& int OP_signature_verify_init(void *ctx, void *provkey);
|
|
\& int OP_signature_verify(void *ctx, const unsigned char *sig, size_t siglen,
|
|
\& const unsigned char *tbs, size_t tbslen);
|
|
\&
|
|
\& /* Verify Recover */
|
|
\& int OP_signature_verify_recover_init(void *ctx, void *provkey);
|
|
\& int OP_signature_verify_recover(void *ctx, unsigned char *rout,
|
|
\& size_t *routlen, size_t routsize,
|
|
\& const unsigned char *sig, size_t siglen);
|
|
\&
|
|
\& /* Signature parameters */
|
|
\& int OP_signature_get_ctx_params(void *ctx, OSSL_PARAM params[]);
|
|
\& const OSSL_PARAM *OP_signature_gettable_ctx_params(void);
|
|
\& int OP_signature_set_ctx_params(void *ctx, const OSSL_PARAM params[]);
|
|
\& const OSSL_PARAM *OP_signature_settable_ctx_params(void);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
This documentation is primarily aimed at provider authors. See \fIprovider\fR\|(7)
|
|
for further information.
|
|
.PP
|
|
The signature (\s-1OSSL_OP_SIGNATURE\s0) operation enables providers to implement
|
|
signature algorithms and make them available to applications via the \s-1API\s0
|
|
functions \fIEVP_PKEY_sign\fR\|(3),
|
|
\&\fIEVP_PKEY_verify\fR\|(3),
|
|
and \fIEVP_PKEY_verify_recover\fR\|(3) (as well
|
|
as other related functions).
|
|
.PP
|
|
All \*(L"functions\*(R" mentioned here are passed as function pointers between
|
|
\&\fIlibcrypto\fR and the provider in \fB\s-1OSSL_DISPATCH\s0\fR arrays via
|
|
\&\fB\s-1OSSL_ALGORITHM\s0\fR arrays that are returned by the provider's
|
|
\&\fIprovider_query_operation()\fR function
|
|
(see \*(L"Provider Functions\*(R" in \fIprovider\-base\fR\|(7)).
|
|
.PP
|
|
All these \*(L"functions\*(R" have a corresponding function type definition
|
|
named \fBOSSL_{name}_fn\fR, and a helper function to retrieve the
|
|
function pointer from an \fB\s-1OSSL_DISPATCH\s0\fR element named
|
|
\&\fBOSSL_get_{name}\fR.
|
|
For example, the \*(L"function\*(R" \fIOP_signature_newctx()\fR has these:
|
|
.PP
|
|
.Vb 3
|
|
\& typedef void *(OSSL_OP_signature_newctx_fn)(void *provctx);
|
|
\& static ossl_inline OSSL_OP_signature_newctx_fn
|
|
\& OSSL_get_OP_signature_newctx(const OSSL_DISPATCH *opf);
|
|
.Ve
|
|
.PP
|
|
\&\fB\s-1OSSL_DISPATCH\s0\fR arrays are indexed by numbers that are provided as
|
|
macros in \fIopenssl\-core_numbers.h\fR\|(7), as follows:
|
|
.PP
|
|
.Vb 3
|
|
\& OP_signature_newctx OSSL_FUNC_SIGNATURE_NEWCTX
|
|
\& OP_signature_freectx OSSL_FUNC_SIGNATURE_FREECTX
|
|
\& OP_signature_dupctx OSSL_FUNC_SIGNATURE_DUPCTX
|
|
\&
|
|
\& OP_signature_sign_init OSSL_FUNC_SIGNATURE_SIGN_INIT
|
|
\& OP_signature_sign OSSL_FUNC_SIGNATURE_SIGN
|
|
\&
|
|
\& OP_signature_verify_init OSSL_FUNC_SIGNATURE_VERIFY_INIT
|
|
\& OP_signature_verify OSSL_FUNC_SIGNATURE_VERIFY
|
|
\&
|
|
\& OP_signature_verify_recover_init OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT
|
|
\& OP_signature_verify_recover OSSL_FUNC_SIGNATURE_VERIFY_RECOVER
|
|
\&
|
|
\& OP_signature_get_ctx_params OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS
|
|
\& OP_signature_gettable_ctx_params OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS
|
|
\& OP_signature_set_ctx_params OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS
|
|
\& OP_signature_settable_ctx_params OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS
|
|
.Ve
|
|
.PP
|
|
A signature algorithm implementation may not implement all of these functions.
|
|
In order to be a consistent set of functions a provider must implement
|
|
OP_signature_newctx and OP_signature_freectx.
|
|
It must also implement both of OP_signature_sign_init and OP_signature_sign,
|
|
or both of OP_signature_verify_init and OP_signature_verify, or both of
|
|
OP_signature_verify_recover_init and OP_signature_verify_recover.
|
|
All other functions are optional.
|
|
.PP
|
|
A signature algorithm must also implement some mechanism for generating,
|
|
loading or importing keys via the key management (\s-1OSSL_OP_KEYMGMT\s0) operation.
|
|
See \fIprovider\-keymgmt\fR\|(7) for further details.
|
|
.SS "Context Management Functions"
|
|
.IX Subsection "Context Management Functions"
|
|
\&\fIOP_signature_newctx()\fR should create and return a pointer to a provider side
|
|
structure for holding context information during a signature operation.
|
|
A pointer to this context will be passed back in a number of the other signature
|
|
operation function calls.
|
|
The parameter \fIprovctx\fR is the provider context generated during provider
|
|
initialisation (see \fIprovider\fR\|(7)).
|
|
.PP
|
|
\&\fIOP_signature_freectx()\fR is passed a pointer to the provider side signature
|
|
context in the \fIctx\fR parameter.
|
|
This function should free any resources associated with that context.
|
|
.PP
|
|
\&\fIOP_signature_dupctx()\fR should duplicate the provider side signature context in
|
|
the \fIctx\fR parameter and return the duplicate copy.
|
|
.SS "Signing Functions"
|
|
.IX Subsection "Signing Functions"
|
|
\&\fIOP_signature_sign_init()\fR initialises a context for signing given a provider side
|
|
signature context in the \fIctx\fR parameter, and a pointer to a provider key object
|
|
in the \fIprovkey\fR parameter.
|
|
The key object should have been previously generated, loaded or imported into
|
|
the provider using the key management (\s-1OSSL_OP_KEYMGMT\s0) operation (see
|
|
\&\fIprovider\-keymgmt\fR\|(7)>.
|
|
.PP
|
|
\&\fIOP_signature_sign()\fR performs the actual signing itself.
|
|
A previously initialised signature context is passed in the \fIctx\fR
|
|
parameter.
|
|
The data to be signed is pointed to be the \fItbs\fR parameter which is \fItbslen\fR
|
|
bytes long.
|
|
Unless \fIsig\fR is \s-1NULL\s0, the signature should be written to the location pointed
|
|
to by the \fIsig\fR parameter and it should not exceed \fIsigsize\fR bytes in length.
|
|
The length of the signature should be written to \fI*siglen\fR.
|
|
If \fIsig\fR is \s-1NULL\s0 then the maximum length of the signature should be written to
|
|
\&\fI*siglen\fR.
|
|
.SS "Verify Functions"
|
|
.IX Subsection "Verify Functions"
|
|
\&\fIOP_signature_verify_init()\fR initialises a context for verifying a signature given
|
|
a provider side signature context in the \fIctx\fR parameter, and a pointer to a
|
|
provider key object in the \fIprovkey\fR parameter.
|
|
The key object should have been previously generated, loaded or imported into
|
|
the provider using the key management (\s-1OSSL_OP_KEYMGMT\s0) operation (see
|
|
\&\fIprovider\-keymgmt\fR\|(7)>.
|
|
.PP
|
|
\&\fIOP_signature_verify()\fR performs the actual verification itself.
|
|
A previously initialised signature context is passed in the \fIctx\fR parameter.
|
|
The data that the signature covers is pointed to be the \fItbs\fR parameter which
|
|
is \fItbslen\fR bytes long.
|
|
The signature is pointed to by the \fIsig\fR parameter which is \fIsiglen\fR bytes
|
|
long.
|
|
.SS "Verify Recover Functions"
|
|
.IX Subsection "Verify Recover Functions"
|
|
\&\fIOP_signature_verify_recover_init()\fR initialises a context for recovering the
|
|
signed data given a provider side signature context in the \fIctx\fR parameter, and
|
|
a pointer to a provider key object in the \fIprovkey\fR parameter.
|
|
The key object should have been previously generated, loaded or imported into
|
|
the provider using the key management (\s-1OSSL_OP_KEYMGMT\s0) operation (see
|
|
\&\fIprovider\-keymgmt\fR\|(7)>.
|
|
.PP
|
|
\&\fIOP_signature_verify_recover()\fR performs the actual verify recover itself.
|
|
A previously initialised signature context is passed in the \fIctx\fR parameter.
|
|
The signature is pointed to by the \fIsig\fR parameter which is \fIsiglen\fR bytes
|
|
long.
|
|
Unless \fIrout\fR is \s-1NULL\s0, the recovered data should be written to the location
|
|
pointed to by \fIrout\fR which should not exceed \fIroutsize\fR bytes in length.
|
|
The length of the recovered data should be written to \fI*routlen\fR.
|
|
If \fIrout\fR is \s-1NULL\s0 then the maximum size of the output buffer is written to
|
|
the \fIroutlen\fR parameter.
|
|
.SS "Signature Parameters"
|
|
.IX Subsection "Signature Parameters"
|
|
See \s-1\fIOSSL_PARAM\s0\fR\|(3) for further details on the parameters structure used by
|
|
the \fIOP_signature_get_ctx_params()\fR and \fIOP_signature_set_ctx_params()\fR functions.
|
|
.PP
|
|
\&\fIOP_signature_get_ctx_params()\fR gets signature parameters associated with the
|
|
given provider side signature context \fIctx\fR and stored them in \fIparams\fR.
|
|
\&\fIOP_signature_set_ctx_params()\fR sets the signature parameters associated with the
|
|
given provider side signature context \fIctx\fR to \fIparams\fR.
|
|
Any parameter settings are additional to any that were previously set.
|
|
.PP
|
|
Parameters currently recognised by built-in signature algorithms are as
|
|
follows.
|
|
Not all parameters are relevant to, or are understood by all signature
|
|
algorithms:
|
|
.ie n .IP """digest"" (\fB\s-1OSSL_SIGNATURE_PARAM_DIGEST\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.el .IP "``digest'' (\fB\s-1OSSL_SIGNATURE_PARAM_DIGEST\s0\fR) <\s-1UTF8\s0 string>" 4
|
|
.IX Item "digest (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"
|
|
Get or sets the name of the digest algorithm used for the input to the signature
|
|
functions.
|
|
.ie n .IP """digest-size"" (\fB\s-1OSSL_SIGNATURE_PARAM_DIGEST_SIZE\s0\fR) <unsigned integer>" 4
|
|
.el .IP "``digest-size'' (\fB\s-1OSSL_SIGNATURE_PARAM_DIGEST_SIZE\s0\fR) <unsigned integer>" 4
|
|
.IX Item "digest-size (OSSL_SIGNATURE_PARAM_DIGEST_SIZE) <unsigned integer>"
|
|
Gets or sets the output size of the digest algorithm used for the input to the
|
|
signature functions.
|
|
The length of the \*(L"digest-size\*(R" parameter should not exceed that of a \fBsize_t\fR.
|
|
.PP
|
|
\&\fIOP_signature_gettable_ctx_params()\fR and \fIOP_signature_settable_ctx_params()\fR get a
|
|
constant \fB\s-1OSSL_PARAM\s0\fR array that describes the gettable and settable parameters,
|
|
i.e. parameters that can be used with \fIOP_signature_get_ctx_params()\fR and
|
|
\&\fIOP_signature_set_ctx_params()\fR respectively.
|
|
See \s-1\fIOSSL_PARAM\s0\fR\|(3) for the use of \fB\s-1OSSL_PARAM\s0\fR as parameter descriptor.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIOP_signature_newctx()\fR and \fIOP_signature_dupctx()\fR should return the newly created
|
|
provider side signature, or \s-1NULL\s0 on failure.
|
|
.PP
|
|
All other functions should return 1 for success or 0 on error.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIprovider\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The provider \s-1SIGNATURE\s0 interface was introduced 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>.
|