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