root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/doc/man3/RSA_new.pod

48 lines
1.1 KiB
Plaintext
Raw Normal View History

Document the RSA library.
2000-01-12 06:35:21 +08:00
=pod
=head1 NAME
RSA_new, RSA_free - allocate and free RSA objects
=head1 SYNOPSIS
#include <openssl/rsa.h>
doc/man3: reformat the function prototypes in the synopses I tried hard to keep the lines at 80 characters or less, but in a few cases I had to punt and just indented the subsequent lines by 4 spaces. A few well-placed typedefs for callback functions would really help, but these would be part of the API, so that's probably for later. I also took the liberty of inserting empty lines in overlong blocks to provide some visual space. Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1956)
2017-01-21 02:58:49 +08:00
RSA *RSA_new(void);
Document the RSA library.
2000-01-12 06:35:21 +08:00
void RSA_free(RSA *rsa);
=head1 DESCRIPTION
Various parts of the RSA documentation were inaccurate and out of date and this fixes those that I'm currently aware of. In particular, the ENGINE interference in the RSA API has hopefully been clarified. This still needs to be done for other areas of the API ...
2002-08-05 05:08:36 +08:00
RSA_new() allocates and initializes an B<RSA> structure. It is equivalent to
calling RSA_new_method(NULL).
Document the RSA library.
2000-01-12 06:35:21 +08:00
RSA_free() frees the B<RSA> structure and its components. The key is
Document RAND library.
2000-01-22 01:50:27 +08:00
erased before the memory is returned to the system.
free NULL cleanup Start ensuring all OpenSSL "free" routines allow NULL, and remove any if check before calling them. This gets DH_free, DSA_free, RSA_free Reviewed-by: Matt Caswell <matt@openssl.org>
2015-03-24 22:17:37 +08:00
If B<rsa> is NULL nothing is done.
Document the RSA library.
2000-01-12 06:35:21 +08:00
=head1 RETURN VALUES
If the allocation fails, RSA_new() returns B<NULL> and sets an error
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-18 03:21:33 +08:00
code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
Document the RSA library.
2000-01-12 06:35:21 +08:00
a pointer to the newly allocated structure.
RSA_free() returns no value.
=head1 SEE ALSO
Clean up "generic" intro pod files. Files like dh.pod, etc., mostly duplicated the API-specific pod files. Removed the duplicated content; that often mean the whole file could be removed. Some of the content about internals got moved into README files in the source tree. Some content (e.g., err.pod) got moved into other pod pages. Annotate generic pages, remove dup NAME Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-06-10 04:39:19 +08:00
L<ERR_get_error(3)>,
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-18 03:21:33 +08:00
L<RSA_generate_key(3)>,
L<RSA_new_method(3)>
Document the RSA library.
2000-01-12 06:35:21 +08:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
=head1 COPYRIGHT
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut