Blame doc/man3/RSA_sign.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
RSA_sign, RSA_verify - RSA signatures
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/rsa.h>
Packit Service 084de1
Packit Service 084de1
 int RSA_sign(int type, const unsigned char *m, unsigned int m_len,
Packit Service 084de1
              unsigned char *sigret, unsigned int *siglen, RSA *rsa);
Packit Service 084de1
Packit Service 084de1
 int RSA_verify(int type, const unsigned char *m, unsigned int m_len,
Packit Service 084de1
                unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
RSA_sign() signs the message digest B<m> of size B<m_len> using the
Packit Service 084de1
private key B<rsa> using RSASSA-PKCS1-v1_5 as specified in RFC 3447. It
Packit Service 084de1
stores the signature in B<sigret> and the signature size in B<siglen>.
Packit Service 084de1
B<sigret> must point to RSA_size(B<rsa>) bytes of memory.
Packit Service 084de1
Note that PKCS #1 adds meta-data, placing limits on the size of the
Packit Service 084de1
key that can be used.
Packit Service 084de1
See L<RSA_private_encrypt(3)> for lower-level
Packit Service 084de1
operations.
Packit Service 084de1
Packit Service 084de1
B<type> denotes the message digest algorithm that was used to generate
Packit Service 084de1
B<m>.
Packit Service 084de1
If B<type> is B<NID_md5_sha1>,
Packit Service 084de1
an SSL signature (MD5 and SHA1 message digests with PKCS #1 padding
Packit Service 084de1
and no algorithm identifier) is created.
Packit Service 084de1
Packit Service 084de1
RSA_verify() verifies that the signature B<sigbuf> of size B<siglen>
Packit Service 084de1
matches a given message digest B<m> of size B<m_len>. B<type> denotes
Packit Service 084de1
the message digest algorithm that was used to generate the signature.
Packit Service 084de1
B<rsa> is the signer's public key.
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
RSA_sign() returns 1 on success.
Packit Service 084de1
RSA_verify() returns 1 on successful verification.
Packit Service 084de1
Packit Service 084de1
The error codes can be obtained by L<ERR_get_error(3)>.
Packit Service 084de1
Packit Service 084de1
=head1 CONFORMING TO
Packit Service 084de1
Packit Service 084de1
SSL, PKCS #1 v2.0
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<ERR_get_error(3)>,
Packit Service 084de1
L<RSA_private_encrypt(3)>,
Packit Service 084de1
L<RSA_public_decrypt(3)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut