summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/EVP_VerifyInit.pod
diff options
context:
space:
mode:
authorschwarze <>2016-11-03 09:35:34 +0000
committerschwarze <>2016-11-03 09:35:34 +0000
commit4d607f17ea3eb38ed9f7703afd423f6055c686d4 (patch)
tree58d82d0d7f6aeee380eaadbcfaa231ecbe6b90a0 /src/lib/libcrypto/doc/EVP_VerifyInit.pod
parentcf67afe5881727d740e9f6c772aa478123f7d698 (diff)
downloadopenbsd-4d607f17ea3eb38ed9f7703afd423f6055c686d4.tar.gz
openbsd-4d607f17ea3eb38ed9f7703afd423f6055c686d4.tar.bz2
openbsd-4d607f17ea3eb38ed9f7703afd423f6055c686d4.zip
convert EVP manuals from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/doc/EVP_VerifyInit.pod')
-rw-r--r--src/lib/libcrypto/doc/EVP_VerifyInit.pod96
1 files changed, 0 insertions, 96 deletions
diff --git a/src/lib/libcrypto/doc/EVP_VerifyInit.pod b/src/lib/libcrypto/doc/EVP_VerifyInit.pod
deleted file mode 100644
index b0d3f8e4c9..0000000000
--- a/src/lib/libcrypto/doc/EVP_VerifyInit.pod
+++ /dev/null
@@ -1,96 +0,0 @@
1=pod
2
3=head1 NAME
4
5EVP_VerifyInit, EVP_VerifyUpdate, EVP_VerifyFinal - EVP signature verification
6functions
7
8=head1 SYNOPSIS
9
10 #include <openssl/evp.h>
11
12 int EVP_VerifyInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
13 int EVP_VerifyUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt);
14 int EVP_VerifyFinal(EVP_MD_CTX *ctx,unsigned char *sigbuf, unsigned int siglen,EVP_PKEY *pkey);
15
16 int EVP_VerifyInit(EVP_MD_CTX *ctx, const EVP_MD *type);
17
18=head1 DESCRIPTION
19
20The EVP signature verification routines are a high level interface to digital
21signatures.
22
23EVP_VerifyInit_ex() sets up verification context B<ctx> to use digest
24B<type> from ENGINE B<impl>. B<ctx> must be initialized by calling
25EVP_MD_CTX_init() before calling this function.
26
27EVP_VerifyUpdate() hashes B<cnt> bytes of data at B<d> into the
28verification context B<ctx>. This function can be called several times on the
29same B<ctx> to include additional data.
30
31EVP_VerifyFinal() verifies the data in B<ctx> using the public key B<pkey>
32and against the B<siglen> bytes at B<sigbuf>.
33
34EVP_VerifyInit() initializes verification context B<ctx> to use the default
35implementation of digest B<type>.
36
37=head1 RETURN VALUES
38
39EVP_VerifyInit_ex() and EVP_VerifyUpdate() return 1 for success and 0 for
40failure.
41
42EVP_VerifyFinal() returns 1 for a correct signature, 0 for failure and -1 if
43some other error occurred.
44
45The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
46
47=head1 NOTES
48
49The B<EVP> interface to digital signatures should almost always be used in
50preference to the low level interfaces. This is because the code then becomes
51transparent to the algorithm used and much more flexible.
52
53Due to the link between message digests and public key algorithms the correct
54digest algorithm must be used with the correct public key type. A list of
55algorithms and associated public key algorithms appears in
56L<EVP_DigestInit(3)|EVP_DigestInit(3)>.
57
58The call to EVP_VerifyFinal() internally finalizes a copy of the digest context.
59This means that calls to EVP_VerifyUpdate() and EVP_VerifyFinal() can be called
60later to digest and verify additional data.
61
62Since only a copy of the digest context is ever finalized the context must
63be cleaned up after use by calling EVP_MD_CTX_cleanup() or a memory leak
64will occur.
65
66=head1 BUGS
67
68Older versions of this documentation wrongly stated that calls to
69EVP_VerifyUpdate() could not be made after calling EVP_VerifyFinal().
70
71Since the public key is passed in the call to EVP_SignFinal() any error
72relating to the private key (for example an unsuitable key and digest
73combination) will not be indicated until after potentially large amounts of
74data have been passed through EVP_SignUpdate().
75
76It is not possible to change the signing parameters using these function.
77
78The previous two bugs are fixed in the newer EVP_VerifyDigest*() function.
79
80=head1 SEE ALSO
81
82L<evp(3)|evp(3)>,
83L<EVP_SignInit(3)|EVP_SignInit(3)>,
84L<EVP_DigestInit(3)|EVP_DigestInit(3)>, L<err(3)|err(3)>,
85L<evp(3)|evp(3)>, L<hmac(3)|hmac(3)>, L<md2(3)|md2(3)>,
86L<md5(3)|md5(3)>, L<ripemd(3)|ripemd(3)>,
87L<sha(3)|sha(3)>, L<dgst(1)|dgst(1)>
88
89=head1 HISTORY
90
91EVP_VerifyInit(), EVP_VerifyUpdate() and EVP_VerifyFinal() are
92available in all versions of SSLeay and OpenSSL.
93
94EVP_VerifyInit_ex() was added in OpenSSL 0.9.7
95
96=cut