Add documentation for new breadcrumb functionality #174
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thinkst-quinn
force-pushed
the
ssh_key_breadcrumbs
branch
from
46e7569 to
9f39ae7
Compare
| ::: | ||
|
|
||
| ### Breadcrumb Credentials | ||
| Certain Breadcrumbs generate and store valid credentials that act as an identifier for the Breadcrumb and make them more appealing to attackers. When creating these Breadcrumbs you must provide a reminder, which we will alert you with if the credentials are used in an attack on any of your Canaries. |
Contributor
There was a problem hiding this comment.
Suggested change
| Certain Breadcrumbs generate and store valid credentials that act as an identifier for the Breadcrumb and make them more appealing to attackers. When creating these Breadcrumbs you must provide a reminder, which we will alert you with if the credentials are used in an attack on any of your Canaries. | |
| Certain Breadcrumbs generate and store valid credentials that act as an identifier for the Breadcrumb and make them more appealing to attackers. When creating these Breadcrumbs you must provide a reminder, which will be included in an alert if the credentials are used in an attack on any of your Canaries. |
|
|
||
| As these Breadcrumb kinds produce static credentials, you can generate them without supplying a `node_id` to create a set of valid credentials which will still alert on use without creating configuration files referencing a specific Canary. | ||
|
|
||
| These Breadcrumbs are currently excluded from the archive produced by Downloading without a specified kind. |
Contributor
There was a problem hiding this comment.
just checking if Downloading was meant to be downloading
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
The recent Breadcrumbs work introduced a number of changes to the Breadcrumb API endpoints and added a new type of Flock API key. This Pull Request adds these new details and tweaks the advice given for breadcrumbs to make use of the new features.
Types of changes
Checklist
pre-commitin the repo)