xref: /freebsd/crypto/openssl/doc/man3/TS_RESP_CTX_new.pod (revision a7148ab39c03abd4d1a84997c70bf96f15dd2a09)
1b077aed3SPierre Pronchery=pod
2b077aed3SPierre Pronchery
3b077aed3SPierre Pronchery=head1 NAME
4b077aed3SPierre Pronchery
5b077aed3SPierre ProncheryTS_RESP_CTX_new_ex, TS_RESP_CTX_new,
6b077aed3SPierre ProncheryTS_RESP_CTX_free - Timestamp response context object creation
7b077aed3SPierre Pronchery
8b077aed3SPierre Pronchery=head1 SYNOPSIS
9b077aed3SPierre Pronchery
10b077aed3SPierre Pronchery #include <openssl/ts.h>
11b077aed3SPierre Pronchery
12b077aed3SPierre Pronchery TS_RESP_CTX *TS_RESP_CTX_new_ex(OSSL_LIB_CTX *libctx, const char *propq);
13b077aed3SPierre Pronchery TS_RESP_CTX *TS_RESP_CTX_new(void);
14b077aed3SPierre Pronchery void TS_RESP_CTX_free(TS_RESP_CTX *ctx);
15b077aed3SPierre Pronchery
16b077aed3SPierre Pronchery=head1 DESCRIPTION
17b077aed3SPierre Pronchery
18b077aed3SPierre ProncheryCreates a response context that can be used for generating responses.
19b077aed3SPierre Pronchery
20b077aed3SPierre ProncheryTS_RESP_CTX_new_ex() allocates and initializes a TS_RESP_CTX structure with a
21b077aed3SPierre Proncherylibrary context of I<libctx> and a property query of I<propq>.
22b077aed3SPierre ProncheryThe library context and property query can be used to select which providers
23b077aed3SPierre Proncherysupply the fetched algorithms.
24b077aed3SPierre Pronchery
25b077aed3SPierre ProncheryTS_RESP_CTX_new() is similar to TS_RESP_CTX_new_ex() but sets the library context
26b077aed3SPierre Proncheryand property query to NULL. This results in the default (NULL) library context
27b077aed3SPierre Proncherybeing used for any operations requiring algorithm fetches.
28b077aed3SPierre Pronchery
29b077aed3SPierre ProncheryTS_RESP_CTX_free() frees the B<TS_RESP_CTX> object I<ctx>.
30*a7148ab3SEnji CooperIf the argument is NULL, nothing is done.
31b077aed3SPierre Pronchery
32b077aed3SPierre Pronchery=head1 RETURN VALUES
33b077aed3SPierre Pronchery
34b077aed3SPierre ProncheryIf the allocation fails, TS_RESP_CTX_new_ex() and TS_RESP_CTX_new() return NULL,
35b077aed3SPierre Proncheryotherwise it returns a pointer to the newly allocated structure.
36b077aed3SPierre Pronchery
37b077aed3SPierre Pronchery=head1 HISTORY
38b077aed3SPierre Pronchery
39b077aed3SPierre ProncheryThe function TS_RESP_CTX_new_ex() was added in OpenSSL 3.0.
40b077aed3SPierre Pronchery
41b077aed3SPierre Pronchery=head1 COPYRIGHT
42b077aed3SPierre Pronchery
43*a7148ab3SEnji CooperCopyright 2021-2024 The OpenSSL Project Authors. All Rights Reserved.
44b077aed3SPierre Pronchery
45b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
46b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
47b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
48b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
49b077aed3SPierre Pronchery
50b077aed3SPierre Pronchery=cut
51