Git/testssl.sh
1
0
Fork 0
mirror of https://github.com/drwetter/testssl.sh.git synced 2025-10-31 13:55:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Spelling

Browse Source
This commit is contained in:
Magnus Larsen
2020-06-22 19:16:20 +02:00
parent 2bff63b7db
commit 069c5ae917
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/testssl.1.md
View File

@@ -410,7 +410,6 @@ As of writing, these checks are missing:
#### STARTTLS #### STARTTLS
This program rates STARTTLS connections, exactly according to the specification. However, this program adds a grade warning about STARTTLS is being used. This is not apart of the rating specification, and limits the grade a STARTTLS connection can have, to a maximum of `A-`. This program rates STARTTLS connections, exactly according to the specification. However, this program adds a grade warning about STARTTLS is being used. This is not apart of the rating specification, and limits the grade a STARTTLS connection can have, to a maximum of `A-`.
#### Implementing new grades caps or -warnings #### Implementing new grades caps or -warnings
To implement a new grading cap, simply call the `set_grade_cap()` function, with the grade and a reason: To implement a new grading cap, simply call the `set_grade_cap()` function, with the grade and a reason:
```bash ```bash
@@ -423,14 +422,14 @@ set_grade_warning "Documentation is always right"
#### Implementing a new check which contains grade caps #### Implementing a new check which contains grade caps
When implementing a new check (be it vulnerability or not) that sets grade caps, the `set_rating_state()` has to be updated (i.e. the `$do_mycheck` variable-name has to be added to the loop, and `$nr_enabled` if-statement has to be incremented) When implementing a new check (be it vulnerability or not) that sets grade caps, the `set_rating_state()` has to be updated (i.e. the `$do_mycheck` variable-name has to be added to the loop, and `$nr_enabled` if-statement has to be incremented)
The `set_rating_state()` automatically disables ratinng, if all the required checks are *not* enabled. The `set_rating_state()` automatically disables rating, if all the required checks are *not* enabled.
This is to prevent giving out a misleading or wrong grade. This is to prevent giving out a misleading or wrong grade.
#### Implementing a new revision #### Implementing a new revision
When a new revision of the rating specification comes around, the following has to be done: When a new revision of the rating specification comes around, the following has to be done:
* New grade caps has to be either: * New grade caps has to be either:
1. Added to the script wherever relevant, or 1. Added to the script wherever relevant, or
2. Added to the above list of missing checks (if *i.* is not possible) 2. Added to the above list of missing checks (if above is not possible)
* New grade warnings has to be added wherever relevant * New grade warnings has to be added wherever relevant
* The revision output in `run_rating()` function has to updated * The revision output in `run_rating()` function has to updated