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: add permissions notes #6

Merged
merged 1 commit into from
Aug 20, 2021
Merged
Changes from all commits
Commits
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
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,34 @@ This Web Extension integrate [secretlint](https://github.com/secretlint/secretli
- Output found credentials to "Console" panel(option)
- Output found credentials to "Secretlint" panel

## Permissions

This extension requires following permissions

- `"<all_urls>"`
- It is used for extending devTools and "Console Integration"
- [devtools API](https://developer.mozilla.org/ja/docs/Mozilla/Add-ons/WebExtensions/Extending_the_developer_tools) requires this permission
- "Console Integration" uses [content_scripts](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/content_scripts). Content Scripts require this permission
- Related issue: [Reduce to use content scripts · Issue #5](https://github.com/secretlint/webextension/issues/5)
- `"webNavigation"`
- It is used for clearing lint messages when move pages
- `"storage"`
- It is used for user settings

📝 Other Notes

**In Memory Process**

This extension is written by JavaScript and It do not send your request/response to another server.
All process is done in memory.

This exntension only scans secrents when you open developer tools.
**Scan timing**

This exntension only scans secrents during you open developer tools.
This limitation come from [devtools API](https://developer.mozilla.org/ja/docs/Mozilla/Add-ons/WebExtensions/Extending_the_developer_tools).

If you close the devTools, this extension does not scan any request/response.

## Motivation

Everyone makes mistakes.
Expand Down