Add documentation about the current and corrected exit codes

This commit is contained in:
Dirk 2018-02-14 23:40:08 +01:00
parent a0dabf9acf
commit ba8d613aa5
3 changed files with 20 additions and 5 deletions

View File

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "TESTSSL" "1" "January 2018" "" ""
.TH "TESTSSL" "1" "February 2018" "" ""
.
.SH "NAME"
\fBtestssl\fR
@ -663,7 +663,16 @@ TLSWG Draft: The Transport Layer Security (TLS) Protocol Version 1\.3
.SH "EXIT STATUS"
.
.IP "\(bu" 4
0 testssl\.sh finished successfully
0 testssl\.sh finished successfully without errors and without unambiguous results
.
.IP "\(bu" 4
1 testssl\.sh has encountered exactly one ambiguous situation or an error during run
.
.IP "\(bu" 4
1+n same as previous\. The errors or ambiguous results are added, also per IP\.
.
.IP "\(bu" 4
50\-200 reserved for returning a vulnerability scoring for system monitoring or a CI tools
.
.IP "\(bu" 4
245 no bash used

View File

@ -507,7 +507,10 @@ to create the hashes for HPKP.</li>
<h2 id="EXIT-STATUS">EXIT STATUS</h2>
<ul>
<li>0 testssl.sh finished successfully</li>
<li>0 testssl.sh finished successfully without errors and without unambiguous results</li>
<li>1 testssl.sh has encountered exactly one ambiguous situation or an error during run</li>
<li>1+n same as previous. The errors or ambiguous results are added, also per IP.</li>
<li>50-200 reserved for returning a vulnerability scoring for system monitoring or a CI tools</li>
<li>245 no bash used</li>
<li>249 temp file creation problem</li>
<li>251 feature not yet supported</li>
@ -549,7 +552,7 @@ to create the hashes for HPKP.</li>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>January 2018</li>
<li class='tc'>February 2018</li>
<li class='tr'>testssl(1)</li>
</ol>

View File

@ -432,7 +432,10 @@ does the same on the plain text IMAP port. Please note that for plain TLS-encryp
## EXIT STATUS
* 0 testssl.sh finished successfully
* 0 testssl.sh finished successfully without errors and without unambiguous results
* 1 testssl.sh has encountered exactly one ambiguous situation or an error during run
* 1+n same as previous. The errors or ambiguous results are added, also per IP.
* 50-200 reserved for returning a vulnerability scoring for system monitoring or a CI tools
* 245 no bash used
* 249 temp file creation problem
* 251 feature not yet supported