Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Mini FAQ
  • Loading branch information
erosman authored Feb 25, 2024
1 parent 9432e68 commit b3f11f5
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,20 @@ The repository has the source code for version 8.0+ for *Firefox*, *Chrome*, an
- **webRequestAuthProvider**: Used to provide proxy authentication
- **host permission**: Used to provide proxy authentication (to any URL `"<all_urls>"`)

### Optional Permissions
#### Optional Permissions

- **browsingData**: Used for "Delete Browsing Data" button to delete cookies, indexedDB, and localStorage, only if requested by the user
- **privacy**: Used for "Limit WebRTC" button to toggle `browser.privacy.network.webRTCIPHandlingPolicy`, only if requested by the user

No remote code is used in this extension.

### Why is there a crypto library in [lib](https://github.com/foxyproxy/browser-extension/tree/main/src/lib)?

The crypto library was already included in [FoxyProxy 3.x](https://github.com/foxyproxy/Foxyproxy_Chrome/blob/f1bca1c50dfa30908c79a9ea477f31eda2abacf4/app/scripts/stored-credentials.js#L4) to encrypt user credentials. It is needed to migrate encrypted settings from the old version (which had no updates for many years, as you mentioned) to 2023. It is not used to encrypt anything; only to decrypt old data when upgrading from version 3.x -> 8.x.
## Mini FAQ

- **Why is there a [CryptoJS](https://code.google.com/archive/p/crypto-js/) library in [lib](https://github.com/foxyproxy/browser-extension/tree/main/src/lib)?**
The CryptoJS library was already included in [FoxyProxy 3.x](https://github.com/foxyproxy/Foxyproxy_Chrome/blob/f1bca1c50dfa30908c79a9ea477f31eda2abacf4/app/scripts/stored-credentials.js#L4) to encrypt user credentials. It is needed to migrate encrypted settings from the old version (which had no updates for many years, as you mentioned). It is not used to encrypt anything; only to decrypt old data when upgrading from version 3.x -> 8.x.
The library is not used in Firefox and will be removed once users migrate to v8+.

- **Remote Code**
No remote code is used in this extension.

## Screenshots

### Dark Theme
Expand Down

0 comments on commit b3f11f5

Please sign in to comment.