Update documentation with Diffie-Hellman best practices.
[openssl.git] / doc / ssl / SSL_CONF_CTX_new.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CONF_CTX_new, SSL_CONF_CTX_free - SSL configuration allocation functions
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  SSL_CONF_CTX *SSL_CONF_CTX_new(void);
12  void SSL_CONF_CTX_free(SSL_CONF_CTX *cctx);
13
14 =head1 DESCRIPTION
15
16 The function SSL_CONF_CTX_new() allocates and initialises an B<SSL_CONF_CTX>
17 structure for use with the SSL_CONF functions.
18
19 The function SSL_CONF_CTX_free() frees up the context B<cctx>.
20 If B<cctx> is NULL nothing is done.
21
22 =head1 RETURN VALUES
23
24 SSL_CONF_CTX_new() returns either the newly allocated B<SSL_CONF_CTX> structure
25 or B<NULL> if an error occurs.
26
27 SSL_CONF_CTX_free() does not return a value.
28
29 =head1 SEE ALSO
30
31 L<SSL_CONF_CTX_set_flags(3)|SSL_CONF_CTX_set_flags(3)>,
32 L<SSL_CONF_CTX_set_ssl_ctx(3)|SSL_CONF_CTX_set_ssl_ctx(3)>,
33 L<SSL_CONF_CTX_set1_prefix(3)|SSL_CONF_CTX_set1_prefix(3)>,
34 L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)>,
35 L<SSL_CONF_cmd_argv(3)|SSL_CONF_cmd_argv(3)>
36
37 =head1 HISTORY
38
39 These functions were first added to OpenSSL 1.0.2
40
41 =cut