Skip to content

Commit 1c15cac

Browse files
committed
Update the docs
Signed-off-by: ziad hany <ziadhany2016@gmail.com>
1 parent a36cec8 commit 1c15cac

3 files changed

Lines changed: 44 additions & 41 deletions
-118 KB
Binary file not shown.
109 KB
Loading

docs/tutorial_analyze_symbols_reachability.rst

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Reachability Status
2121

2222
The reachability status can have one of the following values:
2323

24-
- ``REACHABLE``: "Yes"
24+
- ``REACHABLE``: "yes"
2525
(We found evidence that the vulnerable symbol is reachable and the vulnerable code exists.)
26-
- ``UNKNOWN``: "UNKNOWN"
26+
- ``UNKNOWN``: "unknown"
2727
(We cannot determine reachability with confidence.)
28-
- ``NOT_REACHABLE``: "No"
28+
- ``NOT_REACHABLE``: "no"
2929
(We found evidence that the vulnerable symbol is not reachable.)
3030

3131

@@ -51,46 +51,49 @@ Run the ``analyze_symbols_reachability`` pipeline
5151
.. code-block:: json
5252
:emphasize-lines: 2
5353
54+
{
55+
"purl": "pkg:pypi/b2sdk@1.14.0",
56+
"advisories": [
5457
{
55-
"pypa/b2sdk/PYSEC-2022-33": {
56-
"reachable": "YES",
57-
"details": [
58-
{
59-
"resource_path": "b2sdk-1.14.0/b2sdk/account_info/sqlite_account_info.py",
60-
"patch": {
61-
"vcs_url": "https://github.com/backblaze/b2-sdk-python",
62-
"commit_hash": "62476638986e5b6d7459aca5ef8ce220760226e0"
63-
},
64-
"reachability_status": "YES",
65-
"evidence": [
66-
{
67-
"symbol_name": "SqliteAccountInfo._create_database",
68-
"called": true,
69-
"defined": true,
70-
"imported": false,
71-
"fingerprint": "43b2cc475fd9704759ab9c05a4e96e2b24859f9c63873773db7c35fc4ff09991",
72-
"reachable_from": [
73-
"SqliteAccountInfo._validate_database"
74-
]
75-
},
76-
{
77-
"symbol_name": "SqliteAccountInfo",
78-
"called": false,
79-
"defined": true,
80-
"imported": false,
81-
"fingerprint": "8878c1a51c52f9f13f4e877c072a045ef5104ae4eeebadec92ba28f19a792e9f",
82-
"reachable_from": []
83-
}
84-
],
85-
"vulnerable_symbols": [
86-
"SqliteAccountInfo",
87-
"SqliteAccountInfo._create_database"
88-
],
89-
"fixed_symbols": [
90-
"SqliteAccountInfo",
91-
"SqliteAccountInfo._create_database"
92-
]
58+
"advisory_uid": "pypa/b2sdk/PYSEC-2022-33",
59+
"is_reachable": "yes",
60+
"details": [
61+
{
62+
"resource_path": "b2sdk-1.14.0/b2sdk/account_info/sqlite_account_info.py",
63+
"patch": {
64+
"vcs_url": "https://github.com/backblaze/b2-sdk-python",
65+
"commit_hash": "62476638986e5b6d7459aca5ef8ce220760226e0"
9366
},
67+
"is_reachable": "yes",
68+
"tool_details": [
69+
{
70+
"symbol_name": "SqliteAccountInfo._create_database",
71+
"is_called": true,
72+
"is_defined": true,
73+
"is_imported": false,
74+
"is_exact": true,
75+
"reachable_from": [
76+
"SqliteAccountInfo._validate_database"
77+
]
78+
},
79+
{
80+
"symbol_name": "SqliteAccountInfo",
81+
"is_called": false,
82+
"is_defined": true,
83+
"is_imported": false,
84+
"is_exact": true,
85+
"reachable_from": []
86+
}
87+
],
88+
"vulnerable_symbols": [
89+
"SqliteAccountInfo",
90+
"SqliteAccountInfo._create_database"
91+
],
92+
"fixed_symbols": [
93+
"SqliteAccountInfo",
94+
"SqliteAccountInfo._create_database"
95+
]
96+
},
9497
// ... more details
9598
]
9699
}

0 commit comments

Comments
 (0)