diff options
Diffstat (limited to '')
-rw-r--r-- | src/lib/libcrypto/doc/EVP_PKEY_verify.pod | 92 |
1 files changed, 0 insertions, 92 deletions
diff --git a/src/lib/libcrypto/doc/EVP_PKEY_verify.pod b/src/lib/libcrypto/doc/EVP_PKEY_verify.pod deleted file mode 100644 index 0f092ca8e1..0000000000 --- a/src/lib/libcrypto/doc/EVP_PKEY_verify.pod +++ /dev/null | |||
@@ -1,92 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | EVP_PKEY_verify_init, EVP_PKEY_verify - signature verification using a public | ||
6 | key algorithm | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/evp.h> | ||
11 | |||
12 | int EVP_PKEY_verify_init(EVP_PKEY_CTX *ctx); | ||
13 | int EVP_PKEY_verify(EVP_PKEY_CTX *ctx, | ||
14 | const unsigned char *sig, size_t siglen, | ||
15 | const unsigned char *tbs, size_t tbslen); | ||
16 | |||
17 | =head1 DESCRIPTION | ||
18 | |||
19 | The EVP_PKEY_verify_init() function initializes a public key algorithm | ||
20 | context using key B<pkey> for a signature verification operation. | ||
21 | |||
22 | The EVP_PKEY_verify() function performs a public key verification operation | ||
23 | using B<ctx>. The signature is specified using the B<sig> and | ||
24 | B<siglen> parameters. The verified data (i.e. the data believed originally | ||
25 | signed) is specified using the B<tbs> and B<tbslen> parameters. | ||
26 | |||
27 | =head1 NOTES | ||
28 | |||
29 | After the call to EVP_PKEY_verify_init() algorithm specific control | ||
30 | operations can be performed to set any appropriate parameters for the | ||
31 | operation. | ||
32 | |||
33 | The function EVP_PKEY_verify() can be called more than once on the same | ||
34 | context if several operations are performed using the same parameters. | ||
35 | |||
36 | =head1 RETURN VALUES | ||
37 | |||
38 | EVP_PKEY_verify_init() and EVP_PKEY_verify() return 1 if the verification was | ||
39 | successful and 0 if it failed. Unlike other functions the return value 0 from | ||
40 | EVP_PKEY_verify() only indicates that the signature did not verify | ||
41 | successfully (that is tbs did not match the original data or the signature was | ||
42 | of invalid form) it is not an indication of a more serious error. | ||
43 | |||
44 | A negative value indicates an error other that signature verification failure. | ||
45 | In particular a return value of -2 indicates the operation is not supported by | ||
46 | the public key algorithm. | ||
47 | |||
48 | =head1 EXAMPLE | ||
49 | |||
50 | Verify signature using PKCS#1 and SHA256 digest: | ||
51 | |||
52 | #include <openssl/evp.h> | ||
53 | #include <openssl/rsa.h> | ||
54 | |||
55 | EVP_PKEY_CTX *ctx; | ||
56 | unsigned char *md, *sig; | ||
57 | size_t mdlen, siglen; | ||
58 | EVP_PKEY *verify_key; | ||
59 | /* NB: assumes verify_key, sig, siglen md and mdlen are already set up | ||
60 | * and that verify_key is an RSA public key | ||
61 | */ | ||
62 | ctx = EVP_PKEY_CTX_new(verify_key); | ||
63 | if (!ctx) | ||
64 | /* Error occurred */ | ||
65 | if (EVP_PKEY_verify_init(ctx) <= 0) | ||
66 | /* Error */ | ||
67 | if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PADDING) <= 0) | ||
68 | /* Error */ | ||
69 | if (EVP_PKEY_CTX_set_signature_md(ctx, EVP_sha256()) <= 0) | ||
70 | /* Error */ | ||
71 | |||
72 | /* Perform operation */ | ||
73 | ret = EVP_PKEY_verify(ctx, sig, siglen, md, mdlen); | ||
74 | |||
75 | /* ret == 1 indicates success, 0 verify failure and < 0 for some | ||
76 | * other error. | ||
77 | */ | ||
78 | |||
79 | =head1 SEE ALSO | ||
80 | |||
81 | L<EVP_PKEY_CTX_new(3)|EVP_PKEY_CTX_new(3)>, | ||
82 | L<EVP_PKEY_encrypt(3)|EVP_PKEY_encrypt(3)>, | ||
83 | L<EVP_PKEY_decrypt(3)|EVP_PKEY_decrypt(3)>, | ||
84 | L<EVP_PKEY_sign(3)|EVP_PKEY_sign(3)>, | ||
85 | L<EVP_PKEY_verify_recover(3)|EVP_PKEY_verify_recover(3)>, | ||
86 | L<EVP_PKEY_derive(3)|EVP_PKEY_derive(3)> | ||
87 | |||
88 | =head1 HISTORY | ||
89 | |||
90 | These functions were first added to OpenSSL 1.0.0. | ||
91 | |||
92 | =cut | ||