Skip to content

chore(doc): document traversal related dsl returning paths. #325

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.

Sign up for GitHub

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

Merged
Zenithar merged 1 commit into from
Jan 30, 2025
Merged

chore(doc): document traversal related dsl returning paths. #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,5 +137,5 @@ thirdparty-licenses: ## Generate the list of 3rd party dependencies and write to

.PHONY: local-wiki
local-wiki: ## Generate and serve the mkdocs wiki on localhost
poetry install || pip install mkdocs-material mkdocs-awesome-pages-plugin markdown-captions
poetry install --no-root || pip install mkdocs-material mkdocs-awesome-pages-plugin markdown-captions
poetry run mkdocs serve || mkdocs serve
23 changes: 19 additions & 4 deletions docs/queries/dsl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,9 +398,14 @@ GraphTraversal<S, Path> attacks()

Example usage:

!!!note
The `attacks()` step returns paths, which can be further processed with other steps. You can use
the `elementMap()` step to display the properties of the vertices and edges in the path.
Invoking the `attacks()` step alone will raise a query error.

```groovy
// All attacks possible from a specific container in the graph
kh.containers("pwned-container").attacks()
kh.containers("pwned-container").attacks().by(elementMap())
```

### Critical Step
Expand Down Expand Up @@ -432,12 +437,17 @@ GraphTraversal<S, Path> criticalPaths(int maxHops)

Example usage:

!!!note
The `criticalPaths()` step returns paths, which can be further processed with other steps. You can use
the `elementMap()` step to display the properties of the vertices and edges in the path.
Invoking the `criticalPaths()` step alone will raise a query error.

```groovy
// All attack paths from services to a critical asset
kh.services().criticalPaths()
kh.services().criticalPaths().by(elementMap())

// All attack paths (up to 5 hops) from a compromised credential to a critical asset
kh.group("engineering").criticalPaths(5)
kh.group("engineering").criticalPaths(5).by(elementMap())
```

### CriticalPathsFilter Step
Expand All @@ -450,9 +460,14 @@ GraphTraversal<S, Path> criticalPathsFilter(int maxHops, String... exclusions)

Example usage:

!!!note
The `criticalPathsFilter()` step returns paths, which can be further processed with other steps. You can use
the `elementMap()` step to display the properties of the vertices and edges in the path.
Invoking the `criticalPathsFilter()` step alone will raise a query error.

```groovy
// All attack paths (up to 10 hops) from services to a critical asset excluding the TOKEN_BRUTEFORCE and TOKEN_LIST attacks
kh.services().criticalPathsFilter(10, "TOKEN_BRUTEFORCE", "TOKEN_LIST")
kh.services().criticalPathsFilter(10, "TOKEN_BRUTEFORCE", "TOKEN_LIST").by(elementMap())
```

### HasCriticalPath Step
Expand Down