You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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]>
Copy file name to clipboardExpand all lines: doc/CONTRIBUTORS.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ pip install -r requirements.txt
92
92
93
93
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.
94
94
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.
96
96
97
97
## Running isort and black
98
98
@@ -146,10 +146,10 @@ pre-commit install
146
146
147
147
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`.
148
148
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:
150
150
151
151
```bash
152
-
git checkout master
152
+
git checkout main
153
153
git pull
154
154
git checkout -b my_new_branch
155
155
```
@@ -245,10 +245,10 @@ Many beginners get stuck trying to figure out how to start. You're not alone!
245
245
246
246
Here's three things we recommend:
247
247
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.
250
250
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.
251
251
252
252
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.
253
253
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.
Copy file name to clipboardExpand all lines: doc/CSV2CVE.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This tool takes a comma-delimited file (.csv) with the format `vendor,product,ve
4
4
5
5
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.
6
6
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!)
8
8
9
9
> Note: For backward compatibility, we still support `csv2cve` command for producing CVEs from csv but we recommend using new `--input-file` command instead.
As the name implies, this tool is intended for use with binaries. If you have
187
187
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:
265
265
| sun | sunos | 5.4 | 4 ||||
266
266
| ssh | ssh2 | 2.0 | Mitigated ||||
267
267
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:
269
269
270
270
```console
271
271
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
326
326
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/)
327
327
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/)
328
328
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).
330
330
331
331
> 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.
Copy file name to clipboardExpand all lines: test/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# 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)
3
3
4
4
## Running all tests
5
5
@@ -64,8 +64,8 @@ deactivate
64
64
```
65
65
66
66
## 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)
69
69
* 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:
0 commit comments