SSL_get_psk_identity.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_GET_PSK_IDENTITY 3ossl"
  58. .TH SSL_GET_PSK_IDENTITY 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_get_psk_identity, SSL_get_psk_identity_hint \- get PSK client identity and hint
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/ssl.h>
  69. \&
  70. \& const char *SSL_get_psk_identity_hint(const SSL *ssl);
  71. \& const char *SSL_get_psk_identity(const SSL *ssl);
  72. .Ve
  73. .SH DESCRIPTION
  74. .IX Header "DESCRIPTION"
  75. \&\fBSSL_get_psk_identity_hint()\fR is used to retrieve the PSK identity hint
  76. used during the connection setup related to SSL object
  77. \&\fBssl\fR. Similarly, \fBSSL_get_psk_identity()\fR is used to retrieve the PSK
  78. identity used during the connection setup.
  79. .SH "RETURN VALUES"
  80. .IX Header "RETURN VALUES"
  81. If non\-\fBNULL\fR, \fBSSL_get_psk_identity_hint()\fR returns the PSK identity
  82. hint and \fBSSL_get_psk_identity()\fR returns the PSK identity. Both are
  83. \&\fBNULL\fR\-terminated. \fBSSL_get_psk_identity_hint()\fR may return \fBNULL\fR if
  84. no PSK identity hint was used during the connection setup.
  85. .PP
  86. Note that the return value is valid only during the lifetime of the
  87. SSL object \fBssl\fR.
  88. .SH "SEE ALSO"
  89. .IX Header "SEE ALSO"
  90. \&\fBssl\fR\|(7)
  91. .SH COPYRIGHT
  92. .IX Header "COPYRIGHT"
  93. Copyright 2006\-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>.