SSL_get0_peer_scts.3ossl 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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 "SSL_GET0_PEER_SCTS 3ossl"
  58. .TH SSL_GET0_PEER_SCTS 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. SSL_get0_peer_scts \- get SCTs received
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/ssl.h>
  69. \&
  70. \& const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s);
  71. .Ve
  72. .SH DESCRIPTION
  73. .IX Header "DESCRIPTION"
  74. \&\fBSSL_get0_peer_scts()\fR returns the signed certificate timestamps (SCTs) that have
  75. been received. If this is the first time that this function has been called for
  76. a given \fBSSL\fR instance, it will examine the TLS extensions, OCSP response and
  77. the peer's certificate for SCTs. Future calls will return the same SCTs.
  78. .SH RESTRICTIONS
  79. .IX Header "RESTRICTIONS"
  80. If no Certificate Transparency validation callback has been set (using
  81. \&\fBSSL_CTX_set_ct_validation_callback\fR or \fBSSL_set_ct_validation_callback\fR),
  82. this function is not guaranteed to return all of the SCTs that the peer is
  83. capable of sending.
  84. .SH "RETURN VALUES"
  85. .IX Header "RETURN VALUES"
  86. \&\fBSSL_get0_peer_scts()\fR returns a list of SCTs found, or NULL if an error occurs.
  87. .SH "SEE ALSO"
  88. .IX Header "SEE ALSO"
  89. \&\fBssl\fR\|(7),
  90. \&\fBSSL_CTX_set_ct_validation_callback\fR\|(3)
  91. .SH COPYRIGHT
  92. .IX Header "COPYRIGHT"
  93. Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  94. .PP
  95. Licensed under the Apache License 2.0 (the "License"). You may not use
  96. this file except in compliance with the License. You can obtain a copy
  97. in the file LICENSE in the source distribution or at
  98. <https://www.openssl.org/source/license.html>.