X509_STORE_new.3ossl 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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 "X509_STORE_NEW 3ossl"
  58. .TH X509_STORE_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. X509_STORE_new, X509_STORE_up_ref, X509_STORE_free,
  65. X509_STORE_lock,X509_STORE_unlock
  66. \&\- X509_STORE allocation, freeing and locking functions
  67. .SH SYNOPSIS
  68. .IX Header "SYNOPSIS"
  69. .Vb 1
  70. \& #include <openssl/x509_vfy.h>
  71. \&
  72. \& X509_STORE *X509_STORE_new(void);
  73. \& void X509_STORE_free(X509_STORE *xs);
  74. \& int X509_STORE_lock(X509_STORE *xs);
  75. \& int X509_STORE_unlock(X509_STORE *xs);
  76. \& int X509_STORE_up_ref(X509_STORE *xs);
  77. .Ve
  78. .SH DESCRIPTION
  79. .IX Header "DESCRIPTION"
  80. The \fBX509_STORE_new()\fR function returns a new X509_STORE.
  81. .PP
  82. \&\fBX509_STORE_up_ref()\fR increments the reference count associated with the
  83. X509_STORE object.
  84. .PP
  85. \&\fBX509_STORE_lock()\fR locks the store from modification by other threads,
  86. \&\fBX509_STORE_unlock()\fR unlocks it.
  87. .PP
  88. \&\fBX509_STORE_free()\fR frees up a single X509_STORE object.
  89. If the argument is NULL, nothing is done.
  90. .SH "RETURN VALUES"
  91. .IX Header "RETURN VALUES"
  92. \&\fBX509_STORE_new()\fR returns a newly created X509_STORE or NULL if the call fails.
  93. .PP
  94. \&\fBX509_STORE_up_ref()\fR, \fBX509_STORE_lock()\fR and \fBX509_STORE_unlock()\fR return
  95. 1 for success and 0 for failure.
  96. .PP
  97. \&\fBX509_STORE_free()\fR does not return values.
  98. .SH "SEE ALSO"
  99. .IX Header "SEE ALSO"
  100. \&\fBX509_STORE_set_verify_cb_func\fR\|(3)
  101. \&\fBX509_STORE_get0_param\fR\|(3)
  102. .SH HISTORY
  103. .IX Header "HISTORY"
  104. The \fBX509_STORE_up_ref()\fR, \fBX509_STORE_lock()\fR and \fBX509_STORE_unlock()\fR
  105. functions were added in OpenSSL 1.1.0.
  106. .SH COPYRIGHT
  107. .IX Header "COPYRIGHT"
  108. Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved.
  109. .PP
  110. Licensed under the Apache License 2.0 (the "License"). You may not use
  111. this file except in compliance with the License. You can obtain a copy
  112. in the file LICENSE in the source distribution or at
  113. <https://www.openssl.org/source/license.html>.