openssl/doc/man3/DH_new.pod

=pod

=head1 NAME

DH_new, DH_free - allocate and free DH objects

=head1 SYNOPSIS

 #include <openssl/dh.h>

The following functions have been deprecated since OpenSSL 3.0, and can be
hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
see L<openssl_user_macros(7)>:

 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_new(3)>, L<ERR_get_error(3)>,
L<DH_generate_parameters(3)>,
L<DH_generate_key(3)>,
L<EVP_PKEY-DH(7)>

=head1 HISTORY

All of these functions were deprecated in OpenSSL 3.0.

For replacement see EVP_PKEY-DH(7).

=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
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
Document the DH library, and make some minor changes along the way. 2000-01-23 04:05:23 +08:00			`=pod`

			`=head1 NAME`

			`DH_new, DH_free - allocate and free DH objects`

			`=head1 SYNOPSIS`

			`#include <openssl/dh.h>`

Properly document deprecation of DH_new() and related functions Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Todd Short <todd.short@me.com> Reviewed-by: Hugo Landau <hlandau@openssl.org> (Merged from https://github.com/openssl/openssl/pull/18925) 2022-08-01 19:08:45 +08:00			`The following functions have been deprecated since OpenSSL 3.0, and can be`
			`hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,`
			`see L<openssl_user_macros(7)>:`

Document the DH library, and make some minor changes along the way. 2000-01-23 04:05:23 +08:00			`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-28 03:31:26 +08:00			`void DH_free(DH *dh);`
Document the DH library, and make some minor changes along the way. 2000-01-23 04:05:23 +08: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 22:17:37 +08:00			`If B<dh> is NULL nothing is done.`
Document the DH library, and make some minor changes along the way. 2000-01-23 04:05:23 +08: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-18 03:21:33 +08: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-23 04:05:23 +08:00			`a pointer to the newly allocated structure.`

			`DH_free() returns no value.`

			`=head1 SEE ALSO`

Fix referenses in section 3 manuals Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1900) 2016-11-11 16:33:09 +08:00			`L<DH_new(3)>, 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<DH_generate_parameters(3)>,`
Properly document deprecation of DH_new() and related functions Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Todd Short <todd.short@me.com> Reviewed-by: Hugo Landau <hlandau@openssl.org> (Merged from https://github.com/openssl/openssl/pull/18925) 2022-08-01 19:08:45 +08:00			`L<DH_generate_key(3)>,`
			`L<EVP_PKEY-DH(7)>`

			`=head1 HISTORY`

			`All of these functions were deprecated in OpenSSL 3.0.`

			`For replacement see EVP_PKEY-DH(7).`
Document the DH library, and make some minor changes along the way. 2000-01-23 04:05:23 +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`