TS_RESP_CTX_new.3ossl 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "TS_RESP_CTX_NEW 3ossl"
  58. .TH TS_RESP_CTX_NEW 3ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. TS_RESP_CTX_new_ex, TS_RESP_CTX_new,
  65. TS_RESP_CTX_free \- Timestamp response context object creation
  66. .SH SYNOPSIS
  67. .IX Header "SYNOPSIS"
  68. .Vb 1
  69. \& #include <openssl/ts.h>
  70. \&
  71. \& TS_RESP_CTX *TS_RESP_CTX_new_ex(OSSL_LIB_CTX *libctx, const char *propq);
  72. \& TS_RESP_CTX *TS_RESP_CTX_new(void);
  73. \& void TS_RESP_CTX_free(TS_RESP_CTX *ctx);
  74. .Ve
  75. .SH DESCRIPTION
  76. .IX Header "DESCRIPTION"
  77. Creates a response context that can be used for generating responses.
  78. .PP
  79. \&\fBTS_RESP_CTX_new_ex()\fR allocates and initializes a TS_RESP_CTX structure with a
  80. library context of \fIlibctx\fR and a property query of \fIpropq\fR.
  81. The library context and property query can be used to select which providers
  82. supply the fetched algorithms.
  83. .PP
  84. \&\fBTS_RESP_CTX_new()\fR is similar to \fBTS_RESP_CTX_new_ex()\fR but sets the library context
  85. and property query to NULL. This results in the default (NULL) library context
  86. being used for any operations requiring algorithm fetches.
  87. .PP
  88. \&\fBTS_RESP_CTX_free()\fR frees the \fBTS_RESP_CTX\fR object \fIctx\fR.
  89. If the argument is NULL, nothing is done.
  90. .SH "RETURN VALUES"
  91. .IX Header "RETURN VALUES"
  92. If the allocation fails, \fBTS_RESP_CTX_new_ex()\fR and \fBTS_RESP_CTX_new()\fR return NULL,
  93. otherwise it returns a pointer to the newly allocated structure.
  94. .SH HISTORY
  95. .IX Header "HISTORY"
  96. The function \fBTS_RESP_CTX_new_ex()\fR was added in OpenSSL 3.0.
  97. .SH COPYRIGHT
  98. .IX Header "COPYRIGHT"
  99. Copyright 2021\-2024 The OpenSSL Project Authors. All Rights Reserved.
  100. .PP
  101. Licensed under the Apache License 2.0 (the "License"). You may not use
  102. this file except in compliance with the License. You can obtain a copy
  103. in the file LICENSE in the source distribution or at
  104. <https://www.openssl.org/source/license.html>.