| yuezonghe | 824eb0c | 2024-06-27 02:32:26 -0700 | [diff] [blame] | 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> using RSASSA-PKCS1-v1_5 as specified in RFC 3447. It |
| 21 | stores the signature in B<sigret> and the signature size in B<siglen>. |
| 22 | B<sigret> 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)> for lower-level |
| 26 | operations. |
| 27 | |
| 28 | B<type> denotes the message digest algorithm that was used to generate |
| 29 | B<m>. |
| 30 | 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. |
| 42 | RSA_verify() returns 1 on successful verification. |
| 43 | |
| 44 | The error codes can be obtained by L<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)>, |
| 53 | L<RSA_private_encrypt(3)>, |
| 54 | L<RSA_public_decrypt(3)> |
| 55 | |
| 56 | =head1 COPYRIGHT |
| 57 | |
| 58 | Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. |
| 59 | |
| 60 | Licensed under the OpenSSL license (the "License"). You may not use |
| 61 | this file except in compliance with the License. You can obtain a copy |
| 62 | in the file LICENSE in the source distribution or at |
| 63 | L<https://www.openssl.org/source/license.html>. |
| 64 | |
| 65 | =cut |