react-native-pvt-secure-key-store

v2.0.15

React Native Library for securely storing keys to iOS and Android devices in KeyChain and KeyStore respectively. For more information about how to use this package see README

Latest version published 4 months ago

License: ISC

NPM

GitHub

Package Health Score

62 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.15	\|	07/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (2)

GitHub Stars: 239
Forks: 68
Contributors: 30

Direct Usage Popularity

The npm package react-native-pvt-secure-key-store receives a total of 2 downloads a week. As such, we scored react-native-pvt-secure-key-store popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package react-native-pvt-secure-key-store, we found that it has been starred 239 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: Yes

With more than 10 contributors for the react-native-pvt-secure-key-store repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like react-native-pvt-secure-key-store is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

No Recent Commits

Open Issues: 28
Open PR: 14
Last Release: 4 months ago
Last Commit: 2 years ago

Further analysis of the maintenance status of react-native-pvt-secure-key-store based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that react-native-pvt-secure-key-store demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 0 Direct
Versions: 7
Install Size: 522 kB
Dist-tags: 1
# of Files: 74
Maintainers: 1
TS Typings: No

react-native-pvt-secure-key-store has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

react-native-secure-key-store

React Native Library for securely storing keys to iOS and Android devices in KeyChain and KeyStore respectively

Getting started

$ npm install react-native-secure-key-store --save

$ yarn add react-native-secure-key-store

Mostly automatic installation

$ react-native link react-native-secure-key-store

Manual installation

iOS

In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
Go to node_modules ➜ react-native-secure-key-store and add RNSecureKeyStore.xcodeproj
In XCode, in the project navigator, select your project. Add libRNSecureKeyStore.a to your project's Build Phases ➜ Link Binary With Libraries
Run your project (Cmd+R)<

Android

Open up android/app/src/main/java/[...]/MainApplication.java

Add import com.reactlibrary.securekeystore.RNSecureKeyStorePackage; to the imports at the top of the file
Add new RNSecureKeyStorePackage() to the list returned by the getPackages() method

Append the following lines to android/settings.gradle:

include ':react-native-secure-key-store'
project(':react-native-secure-key-store').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-secure-key-store/android')

Insert the following lines inside the dependencies block in android/app/build.gradle:
```
compile project(':react-native-secure-key-store')
```

Usage

import RNSecureKeyStore, {ACCESSIBLE} from "react-native-secure-key-store";

// For storing key
RNSecureKeyStore.set("key1", "value1", {accessible: ACCESSIBLE.ALWAYS_THIS_DEVICE_ONLY})
	.then((res) =&gt; {
		console.log(res);
	}, (err) =&gt; {
		console.log(err);
	});

// For retrieving key
RNSecureKeyStore.get("key1")
	.then((res) =&gt; {
		console.log(res);
	}, (err) =&gt; {
		console.log(err);
	});

// For removing key
RNSecureKeyStore.remove("key1")
	.then((res) =&gt; {
		console.log(res);
	}, (err) =&gt; {
		console.log(err);
	});

For demo app, checkout example directory.

Options

Key	Platform	Description	Default
`accessible`	iOS only	This dictates 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.

Handle App uninstalls (iOS only)

By default, this library resets the device's Keychain when it detects the app has been uninstalled.

If you don't want this to occur, you can disable this behavior at any given time by doing:

RNSecureKeyStore.setResetOnAppUninstallTo(false)

Testing

For Testing using Jest, add RNSecureKeyStoreMock implementation under your test/mocks folder. This mock implementation makes easy for you to make testing that dependes on react-native-secure-key-store

License

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

FAQs

What is react-native-pvt-secure-key-store?

React Native Library for securely storing keys to iOS and Android devices in KeyChain and KeyStore respectively. Visit Snyk Advisor to see a full health score report for react-native-pvt-secure-key-store, including popularity, security, maintenance & community analysis.

Is react-native-pvt-secure-key-store popular?

The npm package react-native-pvt-secure-key-store receives a total of 2 weekly downloads. As such, react-native-pvt-secure-key-store popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-native-pvt-secure-key-store well maintained?

We found indications that react-native-pvt-secure-key-store maintenance is sustainable demonstrating some project activity. We saw a total of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is react-native-pvt-secure-key-store safe to use?

The npm package react-native-pvt-secure-key-store was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 12 November-2024, at 03:29 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (2)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

react-native-secure-key-store

Getting started

Mostly automatic installation

Manual installation

iOS

Android

Usage

Options

Keychain.ACCESSIBLE enum

Handle App uninstalls (iOS only)

Testing

License

FAQs

What is react-native-pvt-secure-key-store?

Is react-native-pvt-secure-key-store popular?

Is react-native-pvt-secure-key-store well maintained?

Is react-native-pvt-secure-key-store safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`Keychain.ACCESSIBLE` enum