diff options
author | schwarze <> | 2016-11-04 10:17:17 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-04 10:17:17 +0000 |
commit | 195fe5e91c60bd205043b4bea113abdff1c67bcc (patch) | |
tree | 1d15fe02d83a7ffb422ebe78c34ee1117da63e59 /src/lib/libcrypto/doc/RSA_sign.pod | |
parent | 00872265b9546fcf2d5795aa3a120c35142d268b (diff) | |
download | openbsd-195fe5e91c60bd205043b4bea113abdff1c67bcc.tar.gz openbsd-195fe5e91c60bd205043b4bea113abdff1c67bcc.tar.bz2 openbsd-195fe5e91c60bd205043b4bea113abdff1c67bcc.zip |
convert RSA manuals from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/doc/RSA_sign.pod')
-rw-r--r-- | src/lib/libcrypto/doc/RSA_sign.pod | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/src/lib/libcrypto/doc/RSA_sign.pod b/src/lib/libcrypto/doc/RSA_sign.pod deleted file mode 100644 index 51587bdc41..0000000000 --- a/src/lib/libcrypto/doc/RSA_sign.pod +++ /dev/null | |||
@@ -1,61 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | RSA_sign, RSA_verify - RSA signatures | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/rsa.h> | ||
10 | |||
11 | int RSA_sign(int type, const unsigned char *m, unsigned int m_len, | ||
12 | unsigned char *sigret, unsigned int *siglen, RSA *rsa); | ||
13 | |||
14 | int RSA_verify(int type, const unsigned char *m, unsigned int m_len, | ||
15 | unsigned char *sigbuf, unsigned int siglen, RSA *rsa); | ||
16 | |||
17 | =head1 DESCRIPTION | ||
18 | |||
19 | RSA_sign() signs the message digest B<m> of size B<m_len> using the | ||
20 | private key B<rsa> as specified in PKCS #1 v2.0. It stores the | ||
21 | signature in B<sigret> and the signature size in B<siglen>. B<sigret> | ||
22 | must point to RSA_size(B<rsa>) bytes of memory. | ||
23 | Note that PKCS #1 adds meta-data, placing limits on the size of the | ||
24 | key that can be used. | ||
25 | See L<RSA_private_encrypt(3)|RSA_private_encrypt(3)> for lower-level | ||
26 | operations. | ||
27 | |||
28 | B<type> denotes the message digest algorithm that was used to generate | ||
29 | B<m>. It usually is one of B<NID_sha1>, B<NID_ripemd160> and B<NID_md5>; | ||
30 | see L<objects(3)|objects(3)> for details. If B<type> is B<NID_md5_sha1>, | ||
31 | an SSL signature (MD5 and SHA1 message digests with PKCS #1 padding | ||
32 | and no algorithm identifier) is created. | ||
33 | |||
34 | RSA_verify() verifies that the signature B<sigbuf> of size B<siglen> | ||
35 | matches a given message digest B<m> of size B<m_len>. B<type> denotes | ||
36 | the message digest algorithm that was used to generate the signature. | ||
37 | B<rsa> is the signer's public key. | ||
38 | |||
39 | =head1 RETURN VALUES | ||
40 | |||
41 | RSA_sign() returns 1 on success, 0 otherwise. RSA_verify() returns 1 | ||
42 | on successful verification, 0 otherwise. | ||
43 | |||
44 | The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. | ||
45 | |||
46 | =head1 CONFORMING TO | ||
47 | |||
48 | SSL, PKCS #1 v2.0 | ||
49 | |||
50 | =head1 SEE ALSO | ||
51 | |||
52 | L<ERR_get_error(3)|ERR_get_error(3)>, L<objects(3)|objects(3)>, | ||
53 | L<rsa(3)|rsa(3)>, L<RSA_private_encrypt(3)|RSA_private_encrypt(3)>, | ||
54 | L<RSA_public_decrypt(3)|RSA_public_decrypt(3)> | ||
55 | |||
56 | =head1 HISTORY | ||
57 | |||
58 | RSA_sign() and RSA_verify() are available in all versions of SSLeay | ||
59 | and OpenSSL. | ||
60 | |||
61 | =cut | ||