Skip to content

docs(preferences): clarify that stored data is unencrypted and point to secure alternatives #2571

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

Open
djabif wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(preferences): clarify that stored data is unencrypted and point to secure alternatives #2571

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: 2 additions & 0 deletions preferences/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ on Android. Stored data is cleared if the app is uninstalled.
stores a lot of data, has high read/write load, or requires complex querying,
we recommend taking a look at a SQLite-based solution. One such solution is [Ionic Secure Storage](https://ionic.io/docs/secure-storage), a SQLite-based engine with full encryption support. The [Capacitor Community](https://github.com/capacitor-community/) has also built a number of other storage engines.

Also note that data stored with this API is _not_ encrypted: it is persisted via `UserDefaults` on iOS and `SharedPreferences` on Android, both of which store values in plain text. For sensitive values such as tokens or credentials, consider an encrypted key/value solution such as the [Capawesome Secure Preferences](https://capawesome.io/docs/sdks/capacitor/secure-preferences/) plugin, which encrypts values using the Android Keystore and iOS Keychain.

## Install

```bash
Expand Down