openssl/doc/crypto/DH_new.pod

=pod

=head1 NAME

DH_new, DH_free - allocate and free DH objects

=head1 SYNOPSIS

 #include <openssl/dh.h>

 DH* DH_new(void);

 void DH_free(DH *dh);

=head1 DESCRIPTION

DH_new() allocates and initializes a B<DH> structure.

DH_free() frees the B<DH> structure and its components. The values are
erased before the memory is returned to the system.
If B<dh> is NULL nothing is done.

=head1 RETURN VALUES

If the allocation fails, DH_new() returns B<NULL> and sets an error
code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
a pointer to the newly allocated structure.

DH_free() returns no value.

=head1 SEE ALSO

L<dh(3)>, L<ERR_get_error(3)>,
L<DH_generate_parameters(3)>,
L<DH_generate_key(3)>

=cut
Document the DH library, and make some minor changes along the way. 2000-01-22 20:05:23 +00:00			`=pod`

			`=head1 NAME`

			`DH_new, DH_free - allocate and free DH objects`

			`=head1 SYNOPSIS`

			`#include <openssl/dh.h>`

			`DH* DH_new(void);`

Document DSA and SHA. New function BN_pseudo_rand(). Use BN_prime_checks_size(BN_num_bits(w)) rounds of Miller-Rabin when generating DSA primes (why not use BN_is_prime()?) 2000-01-27 19:31:26 +00:00			`void DH_free(DH *dh);`
Document the DH library, and make some minor changes along the way. 2000-01-22 20:05:23 +00:00
			`=head1 DESCRIPTION`

			`DH_new() allocates and initializes a B<DH> structure.`

			`DH_free() frees the B<DH> structure and its components. The values are`
			`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 14:17:37 +00:00			`If B<dh> is NULL nothing is done.`
Document the DH library, and make some minor changes along the way. 2000-01-22 20:05:23 +00:00
			`=head1 RETURN VALUES`

			`If the allocation fails, DH_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-17 19:21:33 +00:00			`code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns`
Document the DH library, and make some minor changes along the way. 2000-01-22 20:05:23 +00:00			`a pointer to the newly allocated structure.`

			`DH_free() returns no value.`

			`=head1 SEE ALSO`

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-17 19:21:33 +00:00			`L<dh(3)>, L<ERR_get_error(3)>,`
			`L<DH_generate_parameters(3)>,`
			`L<DH_generate_key(3)>`
Document the DH library, and make some minor changes along the way. 2000-01-22 20:05:23 +00:00
			`=cut`