Skip to content

Commit 61405cc

Browse files
Tednoob17Tednoob17
committed
Add documentation for V2 pipeline identifiers
Signed-off-by: Tedsig42 <teddams047@gmail.com>
1 parent 2ff2906 commit 61405cc

File tree

3 files changed

+139
-2
lines changed

3 files changed

+139
-2
lines changed

‎docs/source/command-line-interface.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ For example::
4242
``$ ./manage.py import <importer-name>``
4343
------------------------------------------
4444

45-
Import vulnerability data using the given importer name.
45+
Import vulnerability data using the given importer name. For V2 pipelines,
46+
this name is the ``pipeline_id``.
4647

4748
Other variations:
4849

@@ -53,7 +54,8 @@ Other variations:
5354
``$ ./manage.py improve <improver-name>``
5455
------------------------------------------
5556

56-
Improve the imported vulnerability data using the given improver name.
57+
Improve the imported vulnerability data using the given improver name. For V2
58+
pipelines, this name is the ``pipeline_id``.
5759

5860
Other variations:
5961

‎docs/source/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ In this documentation you will find information on:
4343

4444
reference_importer_overview
4545
reference_improver_overview
46+
reference_v2_pipeline_identifiers
4647
reference_framework_overview
4748
reference_model_overview
4849
command-line-interface

‎docs/source/reference_v2_pipeline_identifiers.rst‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
.. _v2-pipeline-identifiers:
2+
3+
V2 Pipeline Identifiers
4+
=======================
5+
6+
This page documents the ``pipeline_id`` values used by V2 importers and V2 improvers.
7+
8+
Use these identifiers with the Django management commands:
9+
10+
.. code-block:: bash
11+
12+
./manage.py import <pipeline_id>
13+
./manage.py improve <pipeline_id>
14+
15+
To list what is currently available in your environment:
16+
17+
.. code-block:: bash
18+
19+
./manage.py import --list
20+
./manage.py improve --list
21+
22+
23+
V2 Importers
24+
------------
25+
26+
The following V2 importer pipeline identifiers are registered in
27+
``vulnerabilities/importers/__init__.py``.
28+
29+
- ``alpine_linux_importer_v2``
30+
- ``aosp_dataset_fix_commits``
31+
- ``apache_httpd_importer_v2``
32+
- ``apache_kafka_importer_v2``
33+
- ``apache_tomcat_importer_v2``
34+
- ``archlinux_importer_v2``
35+
- ``curl_importer_v2``
36+
- ``debian_importer_v2``
37+
- ``elixir_security_importer_v2``
38+
- ``epss_importer_v2``
39+
- ``fireeye_importer_v2``
40+
- ``gentoo_importer_v2``
41+
- ``github_osv_importer_v2``
42+
- ``gitlab_importer_v2``
43+
- ``istio_importer_v2``
44+
- ``mattermost_importer_v2``
45+
- ``mozilla_importer_v2``
46+
- ``nginx_importer_v2``
47+
- ``nodejs_security_wg``
48+
- ``nvd_importer_v2``
49+
- ``openssl_importer_v2``
50+
- ``oss_fuzz_importer_v2``
51+
- ``postgresql_importer_v2``
52+
- ``project-kb-msr-2019_v2``
53+
- ``project-kb-statements_v2``
54+
- ``pypa_importer_v2``
55+
- ``pysec_importer_v2``
56+
- ``redhat_importer_v2``
57+
- ``retiredotnet_importer_v2``
58+
- ``ruby_importer_v2``
59+
- ``suse_importer_v2``
60+
- ``ubuntu_osv_importer_v2``
61+
- ``vulnrichment_importer_v2``
62+
- ``xen_importer_v2``
63+
64+
65+
V2 Fix Commit Collection Importers
66+
----------------------------------
67+
68+
These V2 importers are also registered in ``vulnerabilities/importers/__init__.py``.
69+
They collect fix commit references for specific upstream repositories.
70+
71+
- ``collect_linux_fix_commits``
72+
- ``collect_busybox_fix_commits``
73+
- ``collect_nginx_fix_commits``
74+
- ``collect_apache_tomcat_fix_commits``
75+
- ``collect_mysql_server_fix_commits``
76+
- ``collect_postgresql_fix_commits``
77+
- ``collect_mongodb_fix_commits``
78+
- ``collect_redis_fix_commits``
79+
- ``collect_sqlite_fix_commits``
80+
- ``collect_php_fix_commits``
81+
- ``collect_python_cpython_fix_commits``
82+
- ``collect_ruby_fix_commits``
83+
- ``collect_go_fix_commits``
84+
- ``collect_node_js_fix_commits``
85+
- ``collect_rust_fix_commits``
86+
- ``collect_openjdk_fix_commits``
87+
- ``collect_swift_fix_commits``
88+
- ``collect_django_fix_commits``
89+
- ``collect_rails_fix_commits``
90+
- ``collect_laravel_fix_commits``
91+
- ``collect_spring_framework_fix_commits``
92+
- ``collect_react_fix_commits``
93+
- ``collect_angular_fix_commits``
94+
- ``collect_wordpress_fix_commits``
95+
- ``collect_docker_moby_fix_commits``
96+
- ``collect_kubernetes_fix_commits``
97+
- ``collect_qemu_fix_commits``
98+
- ``collect_xen_project_fix_commits``
99+
- ``collect_virtualbox_fix_commits``
100+
- ``collect_containerd_fix_commits``
101+
- ``collect_ansible_fix_commits``
102+
- ``collect_terraform_fix_commits``
103+
- ``collect_wireshark_fix_commits``
104+
- ``collect_tcpdump_fix_commits``
105+
- ``collect_git_fix_commits``
106+
- ``collect_jenkins_fix_commits``
107+
- ``collect_gitlab_fix_commits``
108+
109+
110+
V2 Improvers
111+
------------
112+
113+
The following V2 improver pipeline identifiers are registered in
114+
``vulnerabilities/improvers/__init__.py``.
115+
116+
- ``collect_ssvc_trees``
117+
- ``compute_advisory_todo_v2``
118+
- ``compute_package_risk_v2``
119+
- ``compute_version_rank_v2``
120+
- ``enhance_with_exploitdb_v2``
121+
- ``enhance_with_kev_v2``
122+
- ``enhance_with_metasploit_v2``
123+
- ``flag_ghost_packages_v2``
124+
- ``relate_severities_v2``
125+
- ``unfurl_version_range_v2``
126+
127+
128+
V2 Improvers Defined In Code
129+
----------------------------
130+
131+
The following V2 improver currently exists in ``vulnerabilities/pipelines/v2_improvers``
132+
but is not listed in the improver registry at the time of writing.
133+
134+
- ``collect_fix_commits_v2``

0 commit comments

Comments
 (0)