npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

killuhwhal3-rn-secure-storage

v2.0.1

Published

Secure Storage for React Native (Android & iOS) - Keychain & Keystore - forked

Downloads

19

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

killuhwhalekilluhwhale

Keywords

react-nativeiosandroidKeyChain serviceKeyStore serviceDevice Securitykeystorekeychainsecure-preferencestokenreact-token

Readme

RNSecureStorage

Secure Storage for React Native (Android & iOS) - Keychain & Keystore

Updated fork

  1. Forgot initial issue which caused me to fork to solve. I think it was a type issue w/ typescript
  2. https://github.com/talut/rn-secure-storage/issues/63#issuecomment-977788452
    • Android complains about security, updated from above suggestion

v2.0.8

v3.0.0-beta.0

This version still under development. But you can look and try. v3.0.0-development Branch

After v2 this package has AndroidX support. If you want to use without AndroidX please use v1.1.1

Facebook RN blog post about v0.60 and AndroidX support: https://facebook.github.io/react-native/blog/2019/07/03/version-60

Go to F.A.Q for more information.

Not your main language ? Check out the translations here

IOS

RNSecureStorage is using Keychain for secure storing.

Android

Under API 23 RNSecureStorage is using secure-preferences by @scottyab

Above API 23 RNSecureStorage is using Android Keystore

Getting Started

With NPM

npm install --save rn-secure-storage

With YARN

yarn add rn-secure-storage

IOS

If you don't have CocoaPods installed: sudo gem install cocoapods

cd ios && pod install

Android There is no required action for Android.

Manual Linking

Manual Installation (If something went wrong with react-native link)

Usage

Note: Don't use any special chars at key like test@key. This kinda key names can be a problem for IOS/Android


import RNSecureStorage, { ACCESSIBLE } from 'rn-secure-storage'

SET

// {accessible: ACCESSIBLE.WHEN_UNLOCKED} -> This for IOS
RNSecureStorage.set("key1", "this is a value", {accessible: ACCESSIBLE.WHEN_UNLOCKED})
.then((res) => {
console.log(res);
}, (err) => {
console.log(err);
});

GET

RNSecureStorage.get("key1").then((value) => {
console.log(value) // Will return direct value
}).catch((err) => {
console.log(err)
})

REMOVE

RNSecureStorage.remove("key1").then((val) => {
console.log(val)
}).catch((err) => {
console.log(err)
});

EXISTS

// res -> is can be True or False
RNSecureStorage.exists("key1")
.then((res) => {
console.log(res ? "Key exists": "Key not exists")
}, (err) => {
console.log(err);
});

Options

| Key | Platform | Description | Default | |---|---|---|---| |accessible|iOS only|This indicates when a keychain item is accessible, see possible values in Keychain.ACCESSIBLE. |Keychain.ACCESSIBLE.WHEN_UNLOCKED|

Keychain.ACCESSIBLE enum

| Key | Description | |-----|-------------| |WHEN_UNLOCKED|The data in the keychain item can be accessed only while the device is unlocked by the user.| |AFTER_FIRST_UNLOCK|The data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user.| |ALWAYS|The data in the keychain item can always be accessed regardless of whether the device is locked.| |WHEN_PASSCODE_SET_THIS_DEVICE_ONLY|The data in the keychain can only be accessed when the device is unlocked. Only available if a passcode is set on the device. Items with this attribute never migrate to a new device.| |WHEN_UNLOCKED_THIS_DEVICE_ONLY|The data in the keychain item can be accessed only while the device is unlocked by the user. Items with this attribute do not migrate to a new device.| |AFTER_FIRST_UNLOCK_THIS_DEVICE_ONLY|The data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user. Items with this attribute never migrate to a new device.| |ALWAYS_THIS_DEVICE_ONLY|The data in the keychain item can always be accessed regardless of whether the device is locked. Items with this attribute never migrate to a new device.|

Example

You can find the usage example of the package in the example folder.

git clone https://github.com/talut/rn-secure-package

cd rn-secure-package/example

npm install

react-native run-ios/android

Version 2.0.7

Version 2.0.6

Version 2.0.5

Version 2.0.4

Version 2.0.3

Version 2.0.2

  • When phone default locale including RTL then this workaround is setting English locale before generating a key pair and changing it back after all.

Version 2.0.1 (AndroidX Support added)

  • Update to AndroidX. Make sure to enable it in your project's android/gradle.properties.

Version 1.1.1

Version 1.1.0

  • TypeScript support added. Thanks @akiver

Version 1.0.9

  • Gradle version updated.
  • Log messages updated. (For IOS)
  • IOS keychain service name updated right now this package is using main bundle name. If you already using this package in production After this update all IOS user will log out from app automatically.

Version 1.0.82 (a little bug fix)

  • google() repo added because Gradle v3.1.4 can't found.

Version 1.0.7

  • Android & IOS returing value/messages are updated.
  • Issue:1 is solved.

Translations

F.A.Q

  • Why should I use this package?
  • You can use other packages like react-native-keychain I know that package has more options. But you can store only username and password, while with RNSecureStorage you can store a lot of [key,value] pairs
  • Why shouldn't I use react-native-secure-key-store
  • You can use that package but you can't get any good solution with lowest API of Android. Also that package is set to minSDK:18. Thats means you might encounter some problems ...
  • Hey can I trust your code/package?
  • You can see all of my code in the repo and can review it. Also if you want, you can easily can fork my repo and change what bothers you. This package is under MIT license. So I can't give you any warranty. But you should know, I'm using this package in my projects.
  • Will you maintain this package?
  • Yeah, I'm planning to do so. But you know time can change everything. -How can I support you? -If you're using my package that's enough for me

Note: This package is more improved version of react-native-secure-key-store, RNSecureStorage has "under api 23" support

Thanks

License

This project is licensed under the MIT License - see the LICENSE.md file for details