@doko/react-native-yubikit 0.0.2

package/src/specs/NativeYubikitOpenPgp.ts

@@ -0,0 +1,148 @@
+import { TurboModuleRegistry, type TurboModule } from 'react-native';
+
+interface Version {
+  major: number;
+  minor: number;
+  micro: number;
+}
+
+interface OpenPgpAlgorithmAttributes {
+  keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT';
+  algorithm: string;
+  curve?:
+    | 'SECP256R1'
+    | 'SECP256K1'
+    | 'SECP384R1'
+    | 'SECP521R1'
+    | 'BrainpoolP256R1'
+    | 'BrainpoolP384R1'
+    | 'BrainpoolP512R1'
+    | 'X25519'
+    | 'Ed25519';
+  keySize?: number;
+}
+
+interface OpenPgpApplicationRelatedData {
+  aid: string;
+  historical: string;
+  signatureCounter: number;
+}
+
+export interface Spec extends TurboModule {
+  getVersion(deviceHandle: string): Promise<Version>;
+  getApplicationRelatedData(
+    deviceHandle: string
+  ): Promise<OpenPgpApplicationRelatedData>;
+
+  verifyUserPin(
+    deviceHandle: string,
+    pin: string,
+    extended?: boolean
+  ): Promise<void>;
+  verifyAdminPin(deviceHandle: string, pin: string): Promise<void>;
+  unverifyUserPin(deviceHandle: string): Promise<void>;
+  unverifyAdminPin(deviceHandle: string): Promise<void>;
+
+  getSignatureCounter(deviceHandle: string): Promise<number>;
+  getChallenge(deviceHandle: string, length: number): Promise<string>;
+
+  reset(deviceHandle: string): Promise<void>;
+
+  setPinAttempts(
+    deviceHandle: string,
+    userAttempts: number,
+    resetAttempts: number,
+    adminAttempts: number
+  ): Promise<void>;
+
+  changeUserPin(
+    deviceHandle: string,
+    pin: string,
+    newPin: string
+  ): Promise<void>;
+  changeAdminPin(
+    deviceHandle: string,
+    pin: string,
+    newPin: string
+  ): Promise<void>;
+
+  setSignaturePinPolicy(
+    deviceHandle: string,
+    policy: 'ALWAYS' | 'ONCE'
+  ): Promise<void>;
+
+  getUif(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT'
+  ): Promise<'OFF' | 'ON' | 'FIXED' | 'CACHED' | 'CACHED_FIXED'>;
+  setUif(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT',
+    uif: 'OFF' | 'ON' | 'FIXED' | 'CACHED' | 'CACHED_FIXED'
+  ): Promise<void>;
+
+  getAlgorithmInformation(deviceHandle: string): Promise<
+    Array<{
+      keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT';
+      attributes: OpenPgpAlgorithmAttributes[];
+    }>
+  >;
+
+  setAlgorithmAttributes(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT',
+    attributes: OpenPgpAlgorithmAttributes
+  ): Promise<void>;
+
+  getCertificate(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT'
+  ): Promise<string>;
+  putCertificate(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT',
+    certificate: string
+  ): Promise<void>;
+  deleteCertificate(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT'
+  ): Promise<void>;
+
+  generateRsaKey(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT',
+    keySize: number
+  ): Promise<string>;
+  generateEcKey(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT',
+    curve:
+      | 'SECP256R1'
+      | 'SECP256K1'
+      | 'SECP384R1'
+      | 'SECP521R1'
+      | 'BrainpoolP256R1'
+      | 'BrainpoolP384R1'
+      | 'BrainpoolP512R1'
+      | 'X25519'
+      | 'Ed25519'
+  ): Promise<string>;
+  getPublicKey(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT'
+  ): Promise<string>;
+  deleteKey(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT'
+  ): Promise<void>;
+
+  sign(deviceHandle: string, payload: string): Promise<string>;
+  decrypt(deviceHandle: string, payload: string): Promise<string>;
+  authenticate(deviceHandle: string, payload: string): Promise<string>;
+  attestKey(
+    deviceHandle: string,
+    keyRef: 'SIG' | 'DEC' | 'AUT' | 'ATT'
+  ): Promise<string>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('YubikitOpenPgp');

package/src/specs/NativeYubikitPiv.ts

@@ -0,0 +1,108 @@
+import { TurboModuleRegistry, type TurboModule } from 'react-native';
+
+interface PivPinMetadata {
+  attemptsRemaining: number;
+}
+
+interface PivManagementKeyMetadata {
+  keyType: 'TDES' | 'AES128' | 'AES192' | 'AES256';
+  defaultValue: boolean;
+  touchRequired: boolean;
+}
+
+interface PivSlotMetadata {
+  keyType:
+    | 'RSA1024'
+    | 'RSA2048'
+    | 'RSA3072'
+    | 'RSA4096'
+    | 'ECCP256'
+    | 'ECCP384'
+    | 'ED25519'
+    | 'X25519';
+  pinPolicy:
+    | 'DEFAULT'
+    | 'NEVER'
+    | 'ONCE'
+    | 'ALWAYS'
+    | 'MATCH_ONCE'
+    | 'MATCH_ALWAYS';
+  touchPolicy: 'DEFAULT' | 'NEVER' | 'ALWAYS' | 'CACHED';
+  generated: boolean;
+  publicKey?: string;
+}
+
+interface PivBioMetadata {
+  attemptsRemaining?: number;
+  temporaryPin?: boolean;
+}
+
+export interface Spec extends TurboModule {
+  reset(deviceHandle: string): Promise<void>;
+  getSerialNumber(deviceHandle: string): Promise<number>;
+
+  authenticate(deviceHandle: string, managementKey: string): Promise<void>;
+  setManagementKey(
+    deviceHandle: string,
+    keyType: string,
+    managementKey: string,
+    requireTouch: boolean
+  ): Promise<void>;
+
+  verifyPin(deviceHandle: string, pin: string): Promise<void>;
+  getPinAttempts(deviceHandle: string): Promise<number>;
+  changePin(
+    deviceHandle: string,
+    oldPin: string,
+    newPin: string
+  ): Promise<void>;
+  changePuk(
+    deviceHandle: string,
+    oldPuk: string,
+    newPuk: string
+  ): Promise<void>;
+  unblockPin(deviceHandle: string, puk: string, newPin: string): Promise<void>;
+  setPinAttempts(
+    deviceHandle: string,
+    pinAttempts: number,
+    pukAttempts: number
+  ): Promise<void>;
+
+  getPinMetadata(deviceHandle: string): Promise<PivPinMetadata>;
+  getPukMetadata(deviceHandle: string): Promise<PivPinMetadata>;
+  getManagementKeyMetadata(
+    deviceHandle: string
+  ): Promise<PivManagementKeyMetadata>;
+  getSlotMetadata(deviceHandle: string, slot: string): Promise<PivSlotMetadata>;
+
+  getCertificate(deviceHandle: string, slot: string): Promise<string>;
+  putCertificate(
+    deviceHandle: string,
+    slot: string,
+    certificate: string,
+    compress?: boolean
+  ): Promise<void>;
+  deleteCertificate(deviceHandle: string, slot: string): Promise<void>;
+  attestKey(deviceHandle: string, slot: string): Promise<string>;
+
+  generateKey(
+    deviceHandle: string,
+    slot: string,
+    keyType: string,
+    pinPolicy: string,
+    touchPolicy: string
+  ): Promise<string>;
+
+  deleteKey(deviceHandle: string, slot: string): Promise<void>;
+
+  rawSignOrDecrypt(
+    deviceHandle: string,
+    slot: string,
+    keyType: string,
+    payload: string
+  ): Promise<string>;
+
+  getBioMetadata(deviceHandle: string): Promise<PivBioMetadata>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('YubikitPiv');

package/src/specs/NativeYubikitSupport.ts

@@ -0,0 +1,61 @@
+import { TurboModuleRegistry, type TurboModule } from 'react-native';
+
+interface Version {
+  major: number;
+  minor: number;
+  micro: number;
+}
+
+interface DeviceConfig {
+  enabledCapabilities?: {
+    usb?: number;
+    nfc?: number;
+  };
+  autoEjectTimeout?: number;
+  challengeResponseTimeout?: number;
+  nfcRestricted?: boolean;
+  deviceFlags?: number;
+}
+
+interface DeviceInfo {
+  config?: DeviceConfig;
+  serialNumber?: number;
+  version: Version;
+  versionName: string;
+  formFactor:
+    | 'UNKNOWN'
+    | 'USB_A_KEYCHAIN'
+    | 'USB_A_NANO'
+    | 'USB_C_KEYCHAIN'
+    | 'USB_C_NANO'
+    | 'USB_C_LIGHTNING'
+    | 'USB_A_BIO'
+    | 'USB_C_BIO';
+  supportedCapabilities: {
+    usb?: number;
+    nfc?: number;
+  };
+  hasTransportUsb: boolean;
+  hasTransportNfc: boolean;
+  isLocked: boolean;
+  isFips: boolean;
+  isSky: boolean;
+  partNumber?: string;
+  fipsCapable: number;
+  fipsApproved: number;
+  pinComplexity: boolean;
+  resetBlocked: number;
+  fpsVersion?: Version;
+  stmVersion?: Version;
+  versionQualifier?: string;
+}
+
+export interface Spec extends TurboModule {
+  /** Read DeviceInfo from any supported connection. */
+  readInfo(deviceHandle: string, pid?: number): Promise<DeviceInfo>;
+
+  /** Get a human-readable name for a YubiKey. */
+  getName(info: DeviceInfo, keyType?: string): string;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('YubikitSupport');

package/src/specs/NativeYubikitYubiOtp.ts

@@ -0,0 +1,82 @@
+import { TurboModuleRegistry, type TurboModule } from 'react-native';
+
+interface Version {
+  major: number;
+  minor: number;
+  micro: number;
+}
+
+interface ConfigurationState {
+  slot1Configured: boolean;
+  slot2Configured: boolean;
+  slot1TouchTriggered: boolean;
+  slot2TouchTriggered: boolean;
+  ledInverted: boolean;
+}
+
+interface OtpSlotConfiguration {
+  type:
+    | 'YubiOtp'
+    | 'HOTP'
+    | 'HmacSha1'
+    | 'StaticPassword'
+    | 'StaticTicket'
+    | 'Update';
+  fixed?: string;
+  uid?: string;
+  key?: string;
+  secret?: string;
+  scanCodes?: string;
+  digits?: number;
+  imf?: number;
+  requireTouch?: boolean;
+  lt64?: boolean;
+  appendCr?: boolean;
+  serialApiVisible?: boolean;
+  serialUsbVisible?: boolean;
+  allowUpdate?: boolean;
+  dormant?: boolean;
+  invertLed?: boolean;
+}
+
+export interface Spec extends TurboModule {
+  getConfigurationState(deviceHandle: string): Promise<ConfigurationState>;
+  getVersion(deviceHandle: string): Promise<Version>;
+  getSerialNumber(deviceHandle: string): Promise<number>;
+
+  swapConfigurations(deviceHandle: string): Promise<void>;
+
+  deleteConfiguration(
+    deviceHandle: string,
+    slot: 'ONE' | 'TWO',
+    currentAccessCode?: string
+  ): Promise<void>;
+  putConfiguration(
+    deviceHandle: string,
+    slot: 'ONE' | 'TWO',
+    configuration: OtpSlotConfiguration,
+    accessCode?: string,
+    currentAccessCode?: string
+  ): Promise<void>;
+  updateConfiguration(
+    deviceHandle: string,
+    slot: 'ONE' | 'TWO',
+    configuration: OtpSlotConfiguration,
+    accessCode?: string,
+    currentAccessCode?: string
+  ): Promise<void>;
+  setNdefConfiguration(
+    deviceHandle: string,
+    slot: 'ONE' | 'TWO',
+    uri?: string,
+    currentAccessCode?: string
+  ): Promise<void>;
+
+  calculateHmacSha1(
+    deviceHandle: string,
+    slot: 'ONE' | 'TWO',
+    challenge: string
+  ): Promise<string>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('YubikitYubiOtp');

package/src/support.ts

@@ -0,0 +1,18 @@
+import NativeYubikitSupport from './specs/NativeYubikitSupport';
+import type { DeviceInfo, YubiKeyType } from './types';
+
+export function readInfo(
+  deviceHandle: string,
+  pid?: number
+): Promise<DeviceInfo> {
+  return NativeYubikitSupport.readInfo(
+    deviceHandle,
+    pid
+  ) as Promise<DeviceInfo>;
+}
+
+export function getName(info: DeviceInfo, keyType?: YubiKeyType): string {
+  return NativeYubikitSupport.getName(info, keyType);
+}
+
+export { NativeYubikitSupport };