SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 05:40:11 +01:00
Code Issues Releases Activity Actions

Document regular expression syntax used for filtering URLs. (#433)

Browse source 
* Document regular expression syntax used for filtering URLs.

* Typo: describes -> described

* Forget to add aggregator doc

---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
This commit is contained in:
Sascha L. Teichmann 2023-08-17 17:02:10 +02:00 • committed by GitHub
parent d49049c3af
commit 0b914f7e7a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/csaf_aggregator.md
View file

@ -95,7 +95,7 @@ lock_file // path to lockfile, to stop other instances if one is n
interim_years // limiting the years for which interim documents are searched (default 0) interim_years // limiting the years for which interim documents are searched (default 0)
verbose // print more diagnostic output, e.g. https requests (default false) verbose // print more diagnostic output, e.g. https requests (default false)
allow_single_provider // debugging option (default false) allow_single_provider // debugging option (default false)
ignorepattern // patterns of advisory URLs to be ignored ignorepattern // patterns of advisory URLs to be ignored (see checker doc for details)
client_cert // path to client certificate to access access-protected advisories client_cert // path to client certificate to access access-protected advisories
client_key // path to client key to access access-protected advisories client_key // path to client key to access access-protected advisories
client_passphrase // client passphrase to access access-protected advisories client_passphrase // client passphrase to access access-protected advisories

4
docs/csaf_checker.md
View file

@ -100,7 +100,7 @@ There are following variants:
All interval boundaries are inclusive. All interval boundaries are inclusive.
You can ignore certain advisories while checking by specifying a list You can ignore certain advisories while checking by specifying a list
of regular expressions to match their URLs by using the `ignorepattern` of regular expressions[^1] to match their URLs by using the `ignorepattern`
option. option.
E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain
the sub strings **white** or **red**. the sub strings **white** or **red**.
@ -119,3 +119,5 @@ If a provider hosts one or more advisories with a TLP level of AMBER or RED, the
To check these advisories, authorization can be given via custom headers or certificates. To check these advisories, authorization can be given via custom headers or certificates.
The authorization method chosen needs to grant access to all advisories, as otherwise the The authorization method chosen needs to grant access to all advisories, as otherwise the
checker will be unable to check the advisories it doesn't have permission for, falsifying the result. checker will be unable to check the advisories it doesn't have permission for, falsifying the result.
[^1]: Accepted syntax is described [here](https://github.com/google/re2/wiki/Syntax).

4
docs/csaf_downloader.md
View file

@ -103,7 +103,7 @@ of this name. Otherwise the advisories are each stored in a folder named
by the year they are from. by the year they are from.
You can ignore certain advisories while downloading by specifying a list You can ignore certain advisories while downloading by specifying a list
of regular expressions to match their URLs by using the `ignorepattern` of regular expressions[^1] to match their URLs by using the `ignorepattern`
option. option.
E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain
@ -112,3 +112,5 @@ In the config file this has to be noted as:
``` ```
ignorepattern = [".*white.*", ".*red.*"] ignorepattern = [".*white.*", ".*red.*"]
``` ```
[^1]: Accepted syntax is described [here](https://github.com/google/re2/wiki/Syntax).