diff options
author | Pauli <paul.dale@oracle.com> | 2017-03-30 07:38:30 +1000 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2017-03-30 14:16:41 +0200 |
commit | c4de074e6385a86a43a30fee574e77f9dcabb022 (patch) | |
tree | 7eb54e6fb75dfa521707d049acea50f41a020f9f /doc/man1/sess_id.pod | |
parent | 3cb47b4ec1514248996ca037a5e7890ea7fdc855 (diff) |
Documentation updates
Fix capitilistion of list items.
Wrap long lines.
Add full stops to the ends of sentances.
Change ciphersuite to cipher suite in all of doc.
[skip ci]
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3082)
Diffstat (limited to 'doc/man1/sess_id.pod')
-rw-r--r-- | doc/man1/sess_id.pod | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/doc/man1/sess_id.pod b/doc/man1/sess_id.pod index 19ac9a75b1..5084b3f467 100644 --- a/doc/man1/sess_id.pod +++ b/doc/man1/sess_id.pod @@ -57,21 +57,21 @@ output if this option is not specified. =item B<-text> -prints out the various public or private key components in +Prints out the various public or private key components in plain text in addition to the encoded version. =item B<-cert> -if a certificate is present in the session it will be output using this option, +If a certificate is present in the session it will be output using this option, if the B<-text> option is also present then it will be printed out in text form. =item B<-noout> -this option prevents output of the encoded version of the session. +This option prevents output of the encoded version of the session. =item B<-context ID> -this option can set the session id so the output session information uses the +This option can set the session id so the output session information uses the supplied ID. The ID can be any string of characters. This option won't normally be used. @@ -98,36 +98,37 @@ Theses are described below in more detail. =item B<Protocol> -this is the protocol in use TLSv1.2, TLSv1.1, TLSv1 or SSLv3. +This is the protocol in use TLSv1.2, TLSv1.1, TLSv1 or SSLv3. =item B<Cipher> -the cipher used this is the actual raw SSL or TLS cipher code, see the SSL +The cipher used this is the actual raw SSL or TLS cipher code, see the SSL or TLS specifications for more information. =item B<Session-ID> -the SSL session ID in hex format. +The SSL session ID in hex format. =item B<Session-ID-ctx> -the session ID context in hex format. +The session ID context in hex format. =item B<Master-Key> -this is the SSL session master key. +This is the SSL session master key. =item B<Start Time> -this is the session start time represented as an integer in standard Unix format. +This is the session start time represented as an integer in standard +Unix format. =item B<Timeout> -the timeout in seconds. +The timeout in seconds. =item B<Verify return code> -this is the return code when an SSL client certificate is verified. +This is the return code when an SSL client certificate is verified. =back @@ -138,10 +139,11 @@ The PEM encoded session format uses the header and footer lines: -----BEGIN SSL SESSION PARAMETERS----- -----END SSL SESSION PARAMETERS----- -Since the SSL session output contains the master key it is possible to read the contents -of an encrypted session using this information. Therefore appropriate security precautions -should be taken if the information is being output by a "real" application. This is -however strongly discouraged and should only be used for debugging purposes. +Since the SSL session output contains the master key it is +possible to read the contents of an encrypted session using this +information. Therefore appropriate security precautions should be taken if +the information is being output by a "real" application. This is however +strongly discouraged and should only be used for debugging purposes. =head1 BUGS @@ -153,7 +155,7 @@ L<ciphers(1)>, L<s_server(1)> =head1 COPYRIGHT -Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy |