2
0

openssl-sess_id.pod.in 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-sess_id - SSL/TLS session handling command
  5. =head1 SYNOPSIS
  6. B<openssl> B<sess_id>
  7. [B<-help>]
  8. [B<-inform> B<DER>|B<PEM>]
  9. [B<-outform> B<DER>|B<PEM>|B<NSS>]
  10. [B<-in> I<filename>]
  11. [B<-out> I<filename>]
  12. [B<-text>]
  13. [B<-cert>]
  14. [B<-noout>]
  15. [B<-context> I<ID>]
  16. =head1 DESCRIPTION
  17. This command processes the encoded version of the SSL session
  18. structure and optionally prints out SSL session details (for example
  19. the SSL session master key) in human readable format. Since this is a
  20. diagnostic tool that needs some knowledge of the SSL protocol to use
  21. properly, most users will not need to use it.
  22. The precise format of the data can vary across OpenSSL versions and
  23. is not documented.
  24. =head1 OPTIONS
  25. =over 4
  26. =item B<-help>
  27. Print out a usage message.
  28. =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>|B<NSS>
  29. The input and output formats; the default is PEM.
  30. See L<openssl-format-options(1)> for details.
  31. For B<NSS> output, the session ID and master key are reported in NSS "keylog"
  32. format.
  33. =item B<-in> I<filename>
  34. This specifies the input filename to read session information from or standard
  35. input by default.
  36. =item B<-out> I<filename>
  37. This specifies the output filename to write session information to or standard
  38. output if this option is not specified.
  39. =item B<-text>
  40. Prints out the various public or private key components in
  41. plain text in addition to the encoded version.
  42. =item B<-cert>
  43. If a certificate is present in the session it will be output using this option,
  44. if the B<-text> option is also present then it will be printed out in text form.
  45. =item B<-noout>
  46. This option prevents output of the encoded version of the session.
  47. =item B<-context> I<ID>
  48. This option can set the session id so the output session information uses the
  49. supplied ID. The ID can be any string of characters. This option won't normally
  50. be used.
  51. =back
  52. =head1 OUTPUT
  53. Typical output:
  54. SSL-Session:
  55. Protocol : TLSv1
  56. Cipher : 0016
  57. Session-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED
  58. Session-ID-ctx: 01000000
  59. Master-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD
  60. Key-Arg : None
  61. Start Time: 948459261
  62. Timeout : 300 (sec)
  63. Verify return code 0 (ok)
  64. These are described below in more detail.
  65. =over 4
  66. =item B<Protocol>
  67. This is the protocol in use TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 or SSLv3.
  68. =item B<Cipher>
  69. The cipher used this is the actual raw SSL or TLS cipher code, see the SSL
  70. or TLS specifications for more information.
  71. =item B<Session-ID>
  72. The SSL session ID in hex format.
  73. =item B<Session-ID-ctx>
  74. The session ID context in hex format.
  75. =item B<Master-Key>
  76. This is the SSL session master key.
  77. =item B<Start Time>
  78. This is the session start time represented as an integer in standard
  79. Unix format.
  80. =item B<Timeout>
  81. The timeout in seconds.
  82. =item B<Verify return code>
  83. This is the return code when an SSL client certificate is verified.
  84. =back
  85. =head1 NOTES
  86. Since the SSL session output contains the master key it is
  87. possible to read the contents of an encrypted session using this
  88. information. Therefore, appropriate security precautions should be taken if
  89. the information is being output by a "real" application. This is however
  90. strongly discouraged and should only be used for debugging purposes.
  91. =head1 BUGS
  92. The cipher and start time should be printed out in human readable form.
  93. =head1 SEE ALSO
  94. L<openssl(1)>,
  95. L<openssl-ciphers(1)>,
  96. L<openssl-s_server(1)>
  97. =head1 COPYRIGHT
  98. Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  99. Licensed under the Apache License 2.0 (the "License"). You may not use
  100. this file except in compliance with the License. You can obtain a copy
  101. in the file LICENSE in the source distribution or at
  102. L<https://www.openssl.org/source/license.html>.
  103. =cut