Skip to content

README.md

Latest commit

 

History

History
113 lines (61 loc) · 2.23 KB

README.md

File metadata and controls

113 lines (61 loc) · 2.23 KB
Raw

react-native-secure-keystore

A React native library helps to securely store keys in Hardware Key Store and use them to create signatures.

note: This library only supported for android.

Installation

npm install react-native-secure-keystore

Usage

  1. for RSA based Key Pair
import SecureKeyStore  from "react-native-secure-keystore";

// ...

if(!SecureKeyStore.deviceSupportsHardware) {
  return
}

const alias = "1234ab";
const data = "any data";

const publicKey = await SecureKeyStore.generateKeyPair(alias);

const signature = await SecureKeyStore.sign(alias, data)
  1. for symmetric key
import SecureKeyStore  from "react-native-secure-keystore";

// ...

if(!SecureKeyStore.deviceSupportsHardware) {
  return
}

const alias = "1234ab";
const data = "any data";

await SecureKeyStore.generateKey(alias);

const encryptedData = await SecureKeyStore.encryptData(alias, data)
const decryptedData = await SecureKeyStore.decryptData(alias, encryptedData)

API documentation

deviceSupportsHardware

deviceSupportsHardware() => boolean

Check if the device supports hardware key store

generateKey

generateKey(alias: string) => void

generates a symmetric key for encryption and decryption

generateKeyPair

generateKey(alias: string) => string

generates a asymmetric RSA key Pair for signing

encryptData

encryptData(alias: string, data: string) => string

Encrypts the given data using the key that is assigned to the alias. Returns back encrypted data as a string

decryptData

decryptData(alias: string, encryptionText: string) => string

Decrypts the given encryptionText using the key that is assigned to the alias. Returns back the data as a string

sign

sign(alias: string, data: string) => string

Create a signature for the given data using the key that is assigned to the alias. Returns back the signature as a string

hasAlias

hasAlias(alias: string) => boolean

Check if the given alias is present in the key store

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Made with create-react-native-library