Remove SSLeay history, etc., from docs
[openssl.git] / doc / crypto / RSA_sign_ASN1_OCTET_STRING.pod
1 =pod
2
3 =head1 NAME
4
5 RSA_sign_ASN1_OCTET_STRING, RSA_verify_ASN1_OCTET_STRING - RSA signatures
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rsa.h>
10
11  int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
12     unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
13     RSA *rsa);
14
15  int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
16     unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
17     RSA *rsa);
18
19 =head1 DESCRIPTION
20
21 RSA_sign_ASN1_OCTET_STRING() signs the octet string B<m> of size
22 B<m_len> using the private key B<rsa> represented in DER using PKCS #1
23 padding. It stores the signature in B<sigret> and the signature size
24 in B<siglen>. B<sigret> must point to B<RSA_size(rsa)> bytes of
25 memory.
26
27 B<dummy> is ignored.
28
29 The random number generator must be seeded prior to calling RSA_sign_ASN1_OCTET_STRING().
30
31 RSA_verify_ASN1_OCTET_STRING() verifies that the signature B<sigbuf>
32 of size B<siglen> is the DER representation of a given octet string
33 B<m> of size B<m_len>. B<dummy> is ignored. B<rsa> is the signer's
34 public key.
35
36 =head1 RETURN VALUES
37
38 RSA_sign_ASN1_OCTET_STRING() returns 1 on success, 0 otherwise.
39 RSA_verify_ASN1_OCTET_STRING() returns 1 on successful verification, 0
40 otherwise.
41
42 The error codes can be obtained by L<ERR_get_error(3)>.
43
44 =head1 BUGS
45
46 These functions serve no recognizable purpose.
47
48 =head1 SEE ALSO
49
50 L<ERR_get_error(3)>,
51 L<rand(3)>, L<rsa(3)>, L<RSA_sign(3)>,
52 L<RSA_verify(3)>
53
54 =cut