Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improving documentation #525

Draft
wants to merge 31 commits into
base: master
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
264bfb9
fix: Identifiers Scan arg help
mich41v4294 Apr 19, 2024
5c59a01
fix: dump-seeds docstrings after #522
Apr 19, 2024
16050bc
added docstrings for sa_dump_seeds
Apr 19, 2024
d83c7e9
bumped readthedocs python version
Apr 19, 2024
8f7d535
added commands.scan.uds to docs
Apr 19, 2024
744a696
changed to gallia.commands
Apr 19, 2024
ba62669
added scan modes md docs
Apr 19, 2024
d24ba13
added memory scan inline docstrings
Apr 19, 2024
07feacd
added isotp discovery documentation
Apr 19, 2024
8ccf8e5
modified isotp discovery docs to focus on launching
Apr 19, 2024
5d4e458
added docstrings for some primitives
mich41v4294 Apr 22, 2024
4a31701
fixed dump-seeds docstring
mich41v4294 Apr 22, 2024
4624419
fix primitives cli commands docstrings
mich41v4294 May 15, 2024
f2ca68d
moved functionality explanation to .md docs
mich41v4294 May 15, 2024
932eb80
removed cli arguments explanation from scan_modes
mich41v4294 May 15, 2024
5d88c29
specified session did in arghelp
mich41v4294 May 15, 2024
2ab9626
removed gallia.commands from api docs
mich41v4294 May 15, 2024
ba8bc5f
added WriteMemoryByAddress data remark
mich41v4294 May 15, 2024
66199aa
minor changes in scan_modes
mich41v4294 May 15, 2024
c4d21c8
added Reset Scan documentation
mich41v4294 May 16, 2024
2f4bd7c
added services scan documentation
mich41v4294 May 16, 2024
2dd3be6
documented identifiers scan
mich41v4294 May 16, 2024
7f67d09
documented session scan
mich41v4294 May 16, 2024
86138f1
docstrings db handler
mich41v4294 May 16, 2024
93bea16
minor changes in scan_modes md
mich41v4294 May 16, 2024
b28adb6
added wireshark note in dumpcap not available message
mich41v4294 May 17, 2024
0fa6596
added nix-shell install instructions
mich41v4294 May 17, 2024
dd6b238
reordered scanning modes
mich41v4294 May 17, 2024
9fde259
minor changes in scan_modes.md
mich41v4294 May 17, 2024
b22a8ca
added scan reference guide
mich41v4294 May 17, 2024
ae3710e
added new md docs to menu
mich41v4294 May 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
minor changes in scan_modes md
  • Loading branch information
mich41v4294 committed May 16, 2024
commit 93bea16946f93fec47c1b6be79e1263049e6b981
2 changes: 1 addition & 1 deletion docs/uds/scan_modes.md
Original file line number Diff line number Diff line change
@@ -223,7 +223,7 @@ The scan is finished if no new session transition is found.
- Records all successful and failed session transitions, including the path taken to reach each session.
- Optionally stores the session transition information in a database for further analysis.

### Key Advantages:
### Key Advantages

- **Comprehensive Discovery:** Thoroughly explores the entire session space of the ECU, uncovering hidden or non-standard sessions.
- **Session Transition Mapping:** Provides a clear picture of how different sessions can be reached, aiding in understanding the ECU's behavior and potential attack surfaces.