Add support for passing the libctx to the config loader
[openssl.git] / doc / man3 / OPENSSL_CTX.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_CTX, OPENSSL_CTX_new, OPENSSL_CTX_free, OPENSSL_CTX_load_config
6 - OpenSSL library context
7
8 =head1 SYNOPSIS
9
10  #include <openssl/crypto.h>
11
12  typedef struct openssl_ctx_st OPENSSL_CTX;
13
14  OPENSSL_CTX *OPENSSL_CTX_new(void);
15  int OPENSSL_CTX_load_config(OPENSSL_CTX *ctx, const char *config_file);
16  void OPENSSL_CTX_free(OPENSSL_CTX *ctx);
17
18 =head1 DESCRIPTION
19
20 C<OPENSSL_CTX> is an internal OpenSSL library context type.
21 Applications may allocate their own, but may also use C<NULL> to use
22 the internal default context with functions that take a C<OPENSSL_CTX>
23 argument.
24
25 OPENSSL_CTX_new() creates a new OpenSSL library context.
26 When a non default library context is in use care should be taken with
27 multi-threaded applications to properly clean up thread local resources before
28 the OPENSSL_CTX is freed.
29 See L<OPENSSL_thread_stop_ex(3)> for more information.
30
31 OPENSSL_CTX_load_config() loads a configuration file using the given C<ctx>.
32 This can be used to associate a libctx with providers that are loaded from
33 a configuration.
34
35 OPENSSL_CTX_free() frees the given C<ctx>.
36
37 =head1 RETURN VALUES
38
39 OPENSSL_CTX_new() return a library context pointer on success, or
40 C<NULL> on error.
41
42 OPENSSL_CTX_free() doesn't return any value.
43
44 =head1 HISTORY
45
46 OPENSSL_CTX, OPENSSL_CTX_new(), OPENSSL_CTX_load_config() and OPENSSL_CTX_free()
47 were added in OpenSSL 3.0.
48
49 =head1 COPYRIGHT
50
51 Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
52
53 Licensed under the Apache License 2.0 (the "License").  You may not use
54 this file except in compliance with the License.  You can obtain a copy
55 in the file LICENSE in the source distribution or at
56 L<https://www.openssl.org/source/license.html>.
57
58 =cut