SSL_SESSION_print.3ossl 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  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_SESSION_PRINT 3ossl"
  58. .TH SSL_SESSION_PRINT 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_SESSION_print,
  65. SSL_SESSION_print_fp,
  66. SSL_SESSION_print_keylog
  67. \&\- printf information about a session
  68. .SH SYNOPSIS
  69. .IX Header "SYNOPSIS"
  70. .Vb 1
  71. \& #include <openssl/ssl.h>
  72. \&
  73. \& int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
  74. \& int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
  75. \& int SSL_SESSION_print_keylog(BIO *bp, const SSL_SESSION *x);
  76. .Ve
  77. .SH DESCRIPTION
  78. .IX Header "DESCRIPTION"
  79. \&\fBSSL_SESSION_print()\fR prints summary information about the session provided in
  80. \&\fBses\fR to the BIO \fBfp\fR.
  81. .PP
  82. \&\fBSSL_SESSION_print_fp()\fR does the same as \fBSSL_SESSION_print()\fR except it prints it
  83. to the FILE \fBfp\fR.
  84. .PP
  85. \&\fBSSL_SESSION_print_keylog()\fR prints session information to the provided BIO <bp>
  86. in NSS keylog format.
  87. .SH "RETURN VALUES"
  88. .IX Header "RETURN VALUES"
  89. \&\fBSSL_SESSION_print()\fR, \fBSSL_SESSION_print_fp()\fR and SSL_SESSION_print_keylog return
  90. 1 on success or 0 on error.
  91. .SH "SEE ALSO"
  92. .IX Header "SEE ALSO"
  93. \&\fBssl\fR\|(7)
  94. .SH COPYRIGHT
  95. .IX Header "COPYRIGHT"
  96. Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
  97. .PP
  98. Licensed under the Apache License 2.0 (the "License"). You may not use
  99. this file except in compliance with the License. You can obtain a copy
  100. in the file LICENSE in the source distribution or at
  101. <https://www.openssl.org/source/license.html>.