react-native-keychain/index.js

234 lines
7.1 KiB
JavaScript
Raw Normal View History

2016-11-04 10:42:12 +00:00
import { NativeModules, Platform } from 'react-native';
const { RNKeychainManager } = NativeModules;
2015-05-20 16:23:04 +00:00
2018-02-25 16:29:39 +00:00
export const ACCESSIBLE = {
WHEN_UNLOCKED: 'AccessibleWhenUnlocked',
AFTER_FIRST_UNLOCK: 'AccessibleAfterFirstUnlock',
ALWAYS: 'AccessibleAlways',
WHEN_PASSCODE_SET_THIS_DEVICE_ONLY: 'AccessibleWhenPasscodeSetThisDeviceOnly',
WHEN_UNLOCKED_THIS_DEVICE_ONLY: 'AccessibleWhenUnlockedThisDeviceOnly',
AFTER_FIRST_UNLOCK_THIS_DEVICE_ONLY:
'AccessibleAfterFirstUnlockThisDeviceOnly',
ALWAYS_THIS_DEVICE_ONLY: 'AccessibleAlwaysThisDeviceOnly',
};
export const ACCESS_CONTROL = {
USER_PRESENCE: 'UserPresence',
2018-02-25 23:14:48 +00:00
BIOMETRY_ANY: 'BiometryAny',
BIOMETRY_CURRENT_SET: 'BiometryCurrentSet',
2018-02-25 16:29:39 +00:00
DEVICE_PASSCODE: 'DevicePasscode',
APPLICATION_PASSWORD: 'ApplicationPassword',
2018-02-25 23:14:48 +00:00
BIOMETRY_ANY_OR_DEVICE_PASSCODE: 'BiometryAnyOrDevicePasscode',
BIOMETRY_CURRENT_SET_OR_DEVICE_PASSCODE: 'BiometryCurrentSetOrDevicePasscode',
2018-02-25 16:29:39 +00:00
};
export const AUTHENTICATION_TYPE = {
DEVICE_PASSCODE_OR_BIOMETRICS: 'AuthenticationWithBiometricsDevicePasscode',
BIOMETRICS: 'AuthenticationWithBiometrics',
};
2018-02-25 16:05:33 +00:00
export const BIOMETRY_TYPE = {
TOUCH_ID: 'TouchID',
FACE_ID: 'FaceID',
FINGERPRINT: 'Fingerprint',
2018-02-25 16:05:33 +00:00
};
type SecAccessible =
| 'AccessibleWhenUnlocked'
| 'AccessibleAfterFirstUnlock'
| 'AccessibleAlways'
| 'AccessibleWhenPasscodeSetThisDeviceOnly'
| 'AccessibleWhenUnlockedThisDeviceOnly'
| 'AccessibleAfterFirstUnlockThisDeviceOnly'
| 'AccessibleAlwaysThisDeviceOnly';
type SecAccessControl =
| 'UserPresence'
2018-02-25 23:14:48 +00:00
| 'BiometryAny'
| 'BiometryCurrentSet'
| 'DevicePasscode'
| 'ApplicationPassword'
2018-02-25 23:14:48 +00:00
| 'BiometryAnyOrDevicePasscode'
| 'BiometryCurrentSetOrDevicePasscode';
type LAPolicy = 'Authentication' | 'AuthenticationWithBiometrics';
type Options = {
accessControl?: SecAccessControl,
accessGroup?: string,
accessible?: SecAccessible,
authenticationPrompt?: string,
authenticationType?: LAPolicy,
service?: string,
};
/**
* Inquire if the type of local authentication policy (LAPolicy) is supported
* on this device with the device settings the user chose.
* @param {object} options LAPolicy option, iOS only
2018-02-25 16:07:18 +00:00
* @return {Promise} Resolves to `true` when supported, otherwise `false`
*/
export function canImplyAuthentication(options?: Options): Promise {
if (!RNKeychainManager.canCheckAuthentication) {
return Promise.resolve(false);
}
return RNKeychainManager.canCheckAuthentication(options);
}
2018-02-25 16:05:33 +00:00
/**
2018-02-27 12:58:37 +00:00
* Get what type of hardware biometry support the device has.
2018-02-25 16:05:33 +00:00
* @return {Promise} Resolves to a `BIOMETRY_TYPE` when supported, otherwise `null`
*/
export function getSupportedBiometryType(): Promise {
2018-02-25 19:21:01 +00:00
if (!RNKeychainManager.getSupportedBiometryType) {
return Promise.resolve(null);
2018-02-25 16:05:33 +00:00
}
return RNKeychainManager.getSupportedBiometryType();
}
2016-11-04 10:42:12 +00:00
/**
* Saves the `username` and `password` combination for `server`.
* @param {string} server URL to server.
* @param {string} username Associated username or e-mail to be saved.
* @param {string} password Associated password to be saved.
* @param {object} options Keychain options, iOS only
* @return {Promise} Resolves to `true` when successful
2016-11-04 10:42:12 +00:00
*/
export function setInternetCredentials(
server: string,
username: string,
password: string,
options?: Options
2016-11-04 10:42:12 +00:00
): Promise {
return RNKeychainManager.setInternetCredentialsForServer(
server,
username,
password,
options
);
2016-11-04 10:42:12 +00:00
}
2015-05-20 18:39:52 +00:00
2016-11-04 10:42:12 +00:00
/**
* Fetches login combination for `server`.
* @param {string} server URL to server.
* @param {object} options Keychain options, iOS only
* @return {Promise} Resolves to `{ server, username, password }` when successful
2016-11-04 10:42:12 +00:00
*/
export function getInternetCredentials(
server: string,
options?: Options
2016-11-04 10:42:12 +00:00
): Promise {
return RNKeychainManager.getInternetCredentialsForServer(server, options);
2016-11-04 10:42:12 +00:00
}
2015-05-20 18:39:52 +00:00
2016-11-04 10:42:12 +00:00
/**
* Deletes all internet password keychain entries for `server`.
* @param {string} server URL to server.
* @param {object} options Keychain options, iOS only
* @return {Promise} Resolves to `true` when successful
2016-11-04 10:42:12 +00:00
*/
export function resetInternetCredentials(
server: string,
options?: Options
2016-11-04 10:42:12 +00:00
): Promise {
return RNKeychainManager.resetInternetCredentialsForServer(server, options);
}
function getOptionsArgument(serviceOrOptions?: string | Options) {
if (Platform.OS !== 'ios') {
return typeof serviceOrOptions === 'object'
? serviceOrOptions.service
: serviceOrOptions;
}
return typeof serviceOrOptions === 'string'
? { service: serviceOrOptions }
: serviceOrOptions;
2016-11-04 10:42:12 +00:00
}
2015-05-20 16:23:04 +00:00
2016-11-04 10:42:12 +00:00
/**
* Saves the `username` and `password` combination for `service`.
* @param {string} username Associated username or e-mail to be saved.
* @param {string} password Associated password to be saved.
* @param {string|object} serviceOrOptions Reverse domain name qualifier for the service, defaults to `bundleId` or an options object.
* @return {Promise} Resolves to `true` when successful
2016-11-04 10:42:12 +00:00
*/
export function setGenericPassword(
username: string,
password: string,
serviceOrOptions?: string | Options
2016-11-04 10:42:12 +00:00
): Promise {
return RNKeychainManager.setGenericPasswordForOptions(
getOptionsArgument(serviceOrOptions),
username,
password
);
2016-11-04 10:42:12 +00:00
}
2015-05-29 16:25:56 +00:00
2016-11-04 10:42:12 +00:00
/**
* Fetches login combination for `service`.
* @param {string|object} serviceOrOptions Reverse domain name qualifier for the service, defaults to `bundleId` or an options object.
* @return {Promise} Resolves to `{ service, username, password }` when successful
2016-11-04 10:42:12 +00:00
*/
export function getGenericPassword(
serviceOrOptions?: string | Options
2016-11-04 10:42:12 +00:00
): Promise {
return RNKeychainManager.getGenericPasswordForOptions(
getOptionsArgument(serviceOrOptions)
);
2016-11-04 10:42:12 +00:00
}
2015-05-29 16:25:56 +00:00
2016-11-04 10:42:12 +00:00
/**
* Deletes all generic password keychain entries for `service`.
* @param {string|object} serviceOrOptions Reverse domain name qualifier for the service, defaults to `bundleId` or an options object.
* @return {Promise} Resolves to `true` when successful
2016-11-04 10:42:12 +00:00
*/
export function resetGenericPassword(
serviceOrOptions?: string | Options
2016-11-04 10:42:12 +00:00
): Promise {
return RNKeychainManager.resetGenericPasswordForOptions(
getOptionsArgument(serviceOrOptions)
);
2015-05-20 18:39:52 +00:00
}
/**
* Asks the user for a shared web credential.
* @return {Promise} Resolves to `{ server, username, password }` if approved and
* `false` if denied and throws an error if not supported on platform or there's no shared credentials
*/
export function requestSharedWebCredentials(): Promise {
if (Platform.OS !== 'ios') {
return Promise.reject(
new Error(
`requestSharedWebCredentials() is not supported on ${Platform.OS} yet`
)
);
}
return RNKeychainManager.requestSharedWebCredentials();
}
/**
* Sets a shared web credential.
* @param {string} server URL to server.
* @param {string} username Associated username or e-mail to be saved.
* @param {string} password Associated password to be saved.
* @return {Promise} Resolves to `true` when successful
*/
export function setSharedWebCredentials(
server: string,
username: string,
password: string
): Promise {
if (Platform.OS !== 'ios') {
return Promise.reject(
new Error(
`setSharedWebCredentials() is not supported on ${Platform.OS} yet`
)
);
}
return RNKeychainManager.setSharedWebCredentialsForServer(
server,
username,
password
);
}