[thirdparty/openssl.git] / doc / man3 / DSA_new.pod

=pod

=head1 NAME

DSA_new, DSA_free - allocate and free DSA objects

=head1 SYNOPSIS

 #include <openssl/dsa.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)>:

 DSA* DSA_new(void);

 void DSA_free(DSA *dsa);

=head1 DESCRIPTION

All of the functions described on this page are deprecated.
Applications should instead use L<EVP_PKEY_new(3)> and L<EVP_PKEY_free(3)>.

DSA_new() allocates and initializes a B<DSA> structure. It is equivalent to
calling DSA_new_method(NULL).

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

=head1 RETURN VALUES

If the allocation fails, DSA_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.

DSA_free() returns no value.

=head1 SEE ALSO

L<EVP_PKEY_new(3)>, L<EVP_PKEY_free(3)>,
L<DSA_new(3)>, L<ERR_get_error(3)>,
L<DSA_generate_parameters(3)>,
L<DSA_generate_key(3)>

=head1 HISTORY

All of these functions were deprecated in OpenSSL 3.0.

=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
Commit	Line	Data
	1	=pod
	2
	3	=head1 NAME
	4
	5	DSA_new, DSA_free - allocate and free DSA objects
	6
	7	=head1 SYNOPSIS
	8
	9	#include <openssl/dsa.h>
	10
	11	The following functions have been deprecated since OpenSSL 3.0, and can be
	12	hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
	13	see L<openssl_user_macros(7)>:
	14
	15	DSA* DSA_new(void);
	16
	17	void DSA_free(DSA *dsa);
	18
	19	=head1 DESCRIPTION
	20
	21	All of the functions described on this page are deprecated.
	22	Applications should instead use L<EVP_PKEY_new(3)> and L<EVP_PKEY_free(3)>.
	23
	24	DSA_new() allocates and initializes a B<DSA> structure. It is equivalent to
	25	calling DSA_new_method(NULL).
	26
	27	DSA_free() frees the B<DSA> structure and its components. The values are
	28	erased before the memory is returned to the system.
	29	If B<dsa> is NULL nothing is done.
	30
	31	=head1 RETURN VALUES
	32
	33	If the allocation fails, DSA_new() returns B<NULL> and sets an error
	34	code that can be obtained by
	35	L<ERR_get_error(3)>. Otherwise it returns a pointer
	36	to the newly allocated structure.
	37
	38	DSA_free() returns no value.
	39
	40	=head1 SEE ALSO
	41
	42	L<EVP_PKEY_new(3)>, L<EVP_PKEY_free(3)>,
	43	L<DSA_new(3)>, L<ERR_get_error(3)>,
	44	L<DSA_generate_parameters(3)>,
	45	L<DSA_generate_key(3)>
	46
	47	=head1 HISTORY
	48
	49	All of these functions were deprecated in OpenSSL 3.0.
	50
	51	=head1 COPYRIGHT
	52
	53	Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
	54
	55	Licensed under the Apache License 2.0 (the "License"). You may not use
	56	this file except in compliance with the License. You can obtain a copy
	57	in the file LICENSE in the source distribution or at
	58	L<https://www.openssl.org/source/license.html>.
	59
	60	=cut