Document the RSA library.
[openssl.git] / doc / crypto / RSA_size.pod
1 =pod
2
3 =head1 NAME
4
5 RSA_size - Get RSA modulus size
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rsa.h>
10
11  int RSA_size(RSA *rsa);
12
13 =head1 DESCRIPTION
14
15 This function returns the RSA modulus size in bytes. It can be used to
16 determine how much memory must be allocated for an RSA encrypted
17 value.
18
19 B<rsa->n> must not be B<NULL>.
20
21 =head1 RETURN VALUE
22
23 The size in bytes.
24
25 =head1 SEE ALSO
26
27 rsa(3)
28
29 =head1 HISTORY
30
31 RSA_size() is available in all versions of SSLeay and OpenSSL.
32
33 =cut