diff options
Diffstat (limited to 'upstream/archlinux/man3/EVP_VerifyInit.3ssl')
| -rw-r--r-- | upstream/archlinux/man3/EVP_VerifyInit.3ssl | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/EVP_VerifyInit.3ssl b/upstream/archlinux/man3/EVP_VerifyInit.3ssl new file mode 100644 index 00000000..91aeac29 --- /dev/null +++ b/upstream/archlinux/man3/EVP_VerifyInit.3ssl @@ -0,0 +1,165 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" 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 +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. 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 >0, 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 +.\" ======================================================================== +.\" +.IX Title "EVP_VERIFYINIT 3ssl" +.TH EVP_VERIFYINIT 3ssl 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 +EVP_VerifyInit_ex, +EVP_VerifyInit, EVP_VerifyUpdate, EVP_VerifyFinal_ex, EVP_VerifyFinal +\&\- EVP signature verification functions +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/evp.h> +\& +\& int EVP_VerifyInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl); +\& int EVP_VerifyUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt); +\& int EVP_VerifyFinal_ex(EVP_MD_CTX *ctx, const unsigned char *sigbuf, +\& unsigned int siglen, EVP_PKEY *pkey, +\& OSSL_LIB_CTX *libctx, const char *propq); +\& int EVP_VerifyFinal(EVP_MD_CTX *ctx, unsigned char *sigbuf, unsigned int siglen, +\& EVP_PKEY *pkey); +\& +\& int EVP_VerifyInit(EVP_MD_CTX *ctx, const EVP_MD *type); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +The EVP signature verification routines are a high-level interface to digital +signatures. +.PP +\&\fBEVP_VerifyInit_ex()\fR sets up verification context \fIctx\fR to use digest +\&\fItype\fR from ENGINE \fIimpl\fR. \fIctx\fR must be created by calling +\&\fBEVP_MD_CTX_new()\fR before calling this function. +.PP +\&\fBEVP_VerifyUpdate()\fR hashes \fIcnt\fR bytes of data at \fId\fR into the +verification context \fIctx\fR. This function can be called several times on the +same \fIctx\fR to include additional data. +.PP +\&\fBEVP_VerifyFinal_ex()\fR verifies the data in \fIctx\fR using the public key +\&\fIpkey\fR and \fIsiglen\fR bytes in \fIsigbuf\fR. +The library context \fIlibctx\fR and property query \fIpropq\fR are used when creating +a context to use with the key \fIpkey\fR. +.PP +\&\fBEVP_VerifyFinal()\fR is similar to \fBEVP_VerifyFinal_ex()\fR but uses default +values of NULL for the library context \fIlibctx\fR and the property query \fIpropq\fR. +.PP +\&\fBEVP_VerifyInit()\fR initializes verification context \fIctx\fR to use the default +implementation of digest \fItype\fR. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBEVP_VerifyInit_ex()\fR and \fBEVP_VerifyUpdate()\fR return 1 for success and 0 for +failure. +.PP +\&\fBEVP_VerifyFinal_ex()\fR and \fBEVP_VerifyFinal()\fR return 1 for a correct +signature, 0 for failure and a negative value if some other error occurred. +.PP +The error codes can be obtained by \fBERR_get_error\fR\|(3). +.SH NOTES +.IX Header "NOTES" +The \fBEVP\fR interface to digital signatures should almost always be used in +preference to the low-level interfaces. This is because the code then becomes +transparent to the algorithm used and much more flexible. +.PP +The call to \fBEVP_VerifyFinal()\fR internally finalizes a copy of the digest context. +This means that calls to \fBEVP_VerifyUpdate()\fR and \fBEVP_VerifyFinal()\fR can be called +later to digest and verify additional data. Applications may disable this +behavior by setting the EVP_MD_CTX_FLAG_FINALISE context flag via +\&\fBEVP_MD_CTX_set_flags\fR\|(3). +.PP +Since only a copy of the digest context is ever finalized the context must +be cleaned up after use by calling \fBEVP_MD_CTX_free()\fR or a memory leak +will occur. +.PP +Note that not all providers support continuation, in case the selected +provider does not allow to duplicate contexts \fBEVP_VerifyFinal()\fR will +finalize the digest context and attempting to process additional data via +\&\fBEVP_VerifyUpdate()\fR will result in an error. +.SH BUGS +.IX Header "BUGS" +Older versions of this documentation wrongly stated that calls to +\&\fBEVP_VerifyUpdate()\fR could not be made after calling \fBEVP_VerifyFinal()\fR. +.PP +Since the public key is passed in the call to \fBEVP_SignFinal()\fR any error +relating to the private key (for example an unsuitable key and digest +combination) will not be indicated until after potentially large amounts of +data have been passed through \fBEVP_SignUpdate()\fR. +.PP +It is not possible to change the signing parameters using these function. +.PP +The previous two bugs are fixed in the newer EVP_DigestVerify*() function. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBevp\fR\|(7), +\&\fBEVP_SignInit\fR\|(3), +\&\fBEVP_DigestInit\fR\|(3), +\&\fBevp\fR\|(7), \fBHMAC\fR\|(3), \fBMD2\fR\|(3), +\&\fBMD5\fR\|(3), \fBMDC2\fR\|(3), \fBRIPEMD160\fR\|(3), +\&\fBSHA1\fR\|(3), \fBopenssl\-dgst\fR\|(1) +.SH HISTORY +.IX Header "HISTORY" +The function \fBEVP_VerifyFinal_ex()\fR was added in OpenSSL 3.0. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +.PP +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +<https://www.openssl.org/source/license.html>. |