Skip to content

Commit b3617e2

Browse files
author
John Andersen
authored
Rename master to main in various docs (#1071)
* checkers: README: Replace branch master links with main branch Signed-off-by: John Andersen <[email protected]> * doc: CSV2CVE: Replace branch master links with main branch Signed-off-by: John Andersen <[email protected]> * doc: MANUAL: Replace branch master links with main branch Signed-off-by: John Andersen <[email protected]> * doc: CONTRIBUTORS: Replace branch master links with main branch Signed-off-by: John Andersen <[email protected]> * test: README: Replace branch master links with main branch Signed-off-by: John Andersen <[email protected]>
1 parent 552171b commit b3617e2

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

cve_bin_tool/checkers/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ That helps other contributors know that that particular checker is going to be
113113
hard to do. Once you've done that, you can abandon the checker and find something
114114
easier to work on, or you can try to think outside the box to find another way
115115
to detect the version. One example is how we did it for the
116-
[sqlite3 get_version_map() fuction](https://github.com/intel/cve-bin-tool/blob/master/cve_bin_tool/checkers/sqlite.py#L104)
116+
[sqlite3 get_version_map() fuction](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/checkers/sqlite.py#L104)
117117
where the checker uses version hashes from the website that are *also* stored
118118
as strings in the binary.
119119

@@ -234,7 +234,7 @@ That regex might look like this: `3\?Xiph.Org libVorbis ([0-9]+\.[0-9]+\.[0-9]+)
234234

235235
> If you can't get a signature match using just regex you may end up needing to
236236
> overwrite the
237-
> [`get_version()`](https://github.com/intel/cve-bin-tool/blob/master/cve_bin_tool/checkers/__init__.py#L120-L132)
237+
> [`get_version()`](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/checkers/__init__.py#L120-L132)
238238
> method for the checker, but that should be a last resort if you can't find a
239239
> regex that works for `VERSION_PATTERNS`.
240240
>
@@ -284,7 +284,7 @@ There are two types of tests you want to add to prove that your checker works as
284284
2. Tests to show that the checker correctly detects real binaries.
285285

286286
You can read about how to add these in
287-
[tests/README.md](https://github.com/intel/cve-bin-tool/blob/master/test/README.md)
287+
[tests/README.md](https://github.com/intel/cve-bin-tool/blob/main/test/README.md)
288288

289289
## Running tests
290290

doc/CONTRIBUTORS.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ pip install -r requirements.txt
9292

9393
The CVE Binary Tool has a set of tests that can be run using `pytest` command. Usually all the short tests should pass, although sometimes internet connectivity issues will cause problems.
9494

95-
[There is a README file in the tests directory](https://github.com/intel/cve-bin-tool/blob/master/test/README.md) which contains more info about how to run just specific tests, or how to run the longer tests which involve downloading full software packages to test the tool. The long tests sometimes fail due to package name changes, which may not be your fault unless you modified one of them.
95+
[There is a README file in the tests directory](https://github.com/intel/cve-bin-tool/blob/main/test/README.md) which contains more info about how to run just specific tests, or how to run the longer tests which involve downloading full software packages to test the tool. The long tests sometimes fail due to package name changes, which may not be your fault unless you modified one of them.
9696

9797
## Running isort and black
9898

@@ -146,10 +146,10 @@ pre-commit install
146146

147147
Git allows you to have "branches" with variant versions of the code. You can see what's available using `git branch` and switch to one using `git checkout branch_name`.
148148

149-
To make your life easier, we recommend that the `master` branch always be kept in sync with the repo at `https://github.com/intel/cve-bin-tool`, as in you never check in any code to that branch. That way, you can use that "clean" master branch as a basis for each new branch you start as follows:
149+
To make your life easier, we recommend that the `main` branch always be kept in sync with the repo at `https://github.com/intel/cve-bin-tool`, as in you never check in any code to that branch. That way, you can use that "clean" main branch as a basis for each new branch you start as follows:
150150

151151
```bash
152-
git checkout master
152+
git checkout main
153153
git pull
154154
git checkout -b my_new_branch
155155
```
@@ -245,10 +245,10 @@ Many beginners get stuck trying to figure out how to start. You're not alone!
245245

246246
Here's three things we recommend:
247247
1. Try something marked as a "[good first issue](https://github.com/intel/cve-bin-tool/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)" We try to mark issues that might be easier for beginners.
248-
2. [Add tests to an existing checker](https://github.com/intel/cve-bin-tool/blob/master/test/README.md). This will give you some practice with the test suite.
249-
3. [Add a new checker](https://github.com/intel/cve-bin-tool/blob/master/cve_bin_tool/checkers/README.md) This will give you some deeper understanding of how the tool works and what a signature looks like. We have a few new checker requests listed in the "good first issue" list, or any linux library that has known CVEs (preferably recent ones) is probably interesting enough.
248+
2. [Add tests to an existing checker](https://github.com/intel/cve-bin-tool/blob/main/test/README.md). This will give you some practice with the test suite.
249+
3. [Add a new checker](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/checkers/README.md) This will give you some deeper understanding of how the tool works and what a signature looks like. We have a few new checker requests listed in the "good first issue" list, or any linux library that has known CVEs (preferably recent ones) is probably interesting enough.
250250
4. Suggest fixes for documentaiton. If you try some instruction and it doesn't work, or you notice a typo, those are always easy first commits! One place we're a bit weak is instructions for Windows users.
251251

252252
If you get stuck or find something that you think should work but doesn't, ask for help in an issue or stop by [the cve-bin-tool gitter](https://gitter.im/cve-bin-tool/community) to ask questions.
253253

254-
Note that our "good first issue" bugs are in high demand during the February-April due to the start of Google Summer of Code. It's totally fine to comment on a bug and say you're interested in working on it, but if you don't actually have any pull request with a tentative fix up within a week or so, someone else may pick it up and finish it. If you want to spend more time thinking, the new checkers (especially ones no one has asked for) might be a good place for a relaxed first commit.
254+
Note that our "good first issue" bugs are in high demand during the February-April due to the start of Google Summer of Code. It's totally fine to comment on a bug and say you're interested in working on it, but if you don't actually have any pull request with a tentative fix up within a week or so, someone else may pick it up and finish it. If you want to spend more time thinking, the new checkers (especially ones no one has asked for) might be a good place for a relaxed first commit.

doc/CSV2CVE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This tool takes a comma-delimited file (.csv) with the format `vendor,product,ve
44

55
This is meant as a helper tool for folk who know the list of product being used in their software, so that you don't have to rely on binary detection heuristics. There exist other tools that do this, but it seemed potentially useful to provide both in the same suite of tools, and it also saves users from having to download two copies of the same data.
66

7-
At the moment, you must use the exact vendor and product strings used in the National Vulnerability Database. You can read more on how to find the correct string in [the checker documentation](https://github.com/intel/cve-bin-tool/blob/master/cve_bin_tool/checkers/README.md). Future work could extend this to use the mappings already in the CVE Binary Tool or to use other mappings such as common linux package names for a given distribution. (Contributions welcome!)
7+
At the moment, you must use the exact vendor and product strings used in the National Vulnerability Database. You can read more on how to find the correct string in [the checker documentation](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/checkers/README.md). Future work could extend this to use the mappings already in the CVE Binary Tool or to use other mappings such as common linux package names for a given distribution. (Contributions welcome!)
88

99
> Note: For backward compatibility, we still support `csv2cve` command for producing CVEs from csv but we recommend using new `--input-file` command instead.
1010
@@ -76,4 +76,4 @@ $ python -m cve_bin_tool.csv2cve test.csv
7676
│ libjpeg-turbo │ libjpeg-turbo │ 2.0.1 │ CVE-2018-19664 │ MEDIUM │
7777
│ libjpeg-turbo │ libjpeg-turbo │ 2.0.1 │ CVE-2018-20330 │ HIGH │
7878
└────────────────┴────────────────┴─────────┴───────────────────┴───────────┘
79-
```
79+
```

doc/MANUAL.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ As such, it cannot tell if someone has backported fixes to an otherwise
106106
vulnerable version, it merely provides a mapping between strings, versions, and
107107
known CVEs.
108108

109-
A [list of currently available checkers](https://github.com/intel/cve-bin-tool/tree/master/cve_bin_tool/checkers)
109+
A [list of currently available checkers](https://github.com/intel/cve-bin-tool/tree/main/cve_bin_tool/checkers)
110110
can be found in the checkers directory or using `cve-bin-tool --help` command, as can the
111-
[instructions on how to add a new checker](https://github.com/intel/cve-bin-tool/blob/master/cve_bin_tool/checkers/README.md).
111+
[instructions on how to add a new checker](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/checkers/README.md).
112112
Support for new checkers can be requested via
113113
[GitHub issues](https://github.com/intel/cve-bin-tool/issues).
114114
(Please note, you will need to be logged in to add a new issue.)
@@ -181,7 +181,7 @@ supported, as is usage within cygwin on windows.
181181
This tool does not scan for all possible known public vulnerabilities, it only
182182
scans for specific commonly vulnerable open source components. A complete
183183
list of currently supported library checkers can be found in [the checkers
184-
directory](https://github.com/intel/cve-bin-tool/tree/master/cve_bin_tool/checkers).
184+
directory](https://github.com/intel/cve-bin-tool/tree/main/cve_bin_tool/checkers).
185185

186186
As the name implies, this tool is intended for use with binaries. If you have
187187
access to a known list of product names and versions, we do have an option `--input-file`
@@ -265,7 +265,7 @@ For Example if input_file contains following data:
265265
| sun | sunos | 5.4 | 4 | | | |
266266
| ssh | ssh2 | 2.0 | Mitigated | | | |
267267

268-
You can test it using our [test input file](https://github.com/intel/cve-bin-tool/blob/master/test/json/test_triage.json) with following command:
268+
You can test it using our [test input file](https://github.com/intel/cve-bin-tool/blob/main/test/json/test_triage.json) with following command:
269269

270270
```console
271271
cve-bin-tool -i="test/json/test_triage.json"
@@ -326,7 +326,7 @@ We currently have number of command line options and we understand that it won't
326326
1. TOML which is popular amongst Python developer and very similar to INI file. If you are not familiar with TOML checkout official [TOML documentation](https://toml.io/en/)
327327
2. YAML which is popular amongst devops community and since many of our users are devops. We also support YAML as config file format. You can find out more about YAML at [yaml.org](https://yaml.org/)
328328

329-
You can see our sample TOML config file [here](https://github.com/intel/cve-bin-tool/blob/master/test/config/cve_bin_tool_config.toml) and sample YAML config file [here](https://github.com/intel/cve-bin-tool/blob/master/test/config/cve_bin_tool_config.yaml).
329+
You can see our sample TOML config file [here](https://github.com/intel/cve-bin-tool/blob/main/test/config/cve_bin_tool_config.toml) and sample YAML config file [here](https://github.com/intel/cve-bin-tool/blob/main/test/config/cve_bin_tool_config.yaml).
330330

331331
> You have to specify either a directory to scan and/or an input file containing vendor, product and version fields either in JSON or CSV format.
332332

test/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# cve-bin-tool tests
2-
You can see all existing tests in [`test/`](https://github.com/intel/cve-bin-tool/tree/master/test)
2+
You can see all existing tests in [`test/`](https://github.com/intel/cve-bin-tool/tree/main/test)
33

44
## Running all tests
55

@@ -64,8 +64,8 @@ deactivate
6464
```
6565

6666
## Adding new tests: CVE mapping tests
67-
* You can see the code for scanner tests in ['test/test_scanner.py'](https://github.com/intel/cve-bin-tool/blob/master/test/test_scanner.py)
68-
* You can see checker wise test data in ['test/test_data'](https://github.com/intel/cve-bin-tool/blob/master/test/test_data)
67+
* You can see the code for scanner tests in ['test/test_scanner.py'](https://github.com/intel/cve-bin-tool/blob/main/test/test_scanner.py)
68+
* You can see checker wise test data in ['test/test_data'](https://github.com/intel/cve-bin-tool/blob/main/test/test_data)
6969
* If you just want to add a new mapping test for a checker, add a dictionary of *product*, *version* and *version_strings* in the mapping_test_data list . Here, *version_strings* are the list of strings that contain version signature or strings that commonly can be found in the module. For example: this is how the current mapping_test_data for gnutls look like. You should add the details of the new test case data at the end of `mapping_test_data` list:
7070
```python
7171
mapping_test_data = [

0 commit comments

Comments
 (0)