@openwallet-foundation/askar-react-native 0.3.0

package/askar.podspec

@@ -0,0 +1,31 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "askar"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "12.0" }
+  s.source       = { :git => "https://github.com/openwallet-foundation/askar-wrapper-javascript", :tag => "#{s.version}" }
+
+  s.header_mappings_dir = "cpp"
+
+  s.pod_target_xcconfig = {
+    :USE_HEADERMAP => "No",
+    'CLANG_CXX_LANGUAGE_STANDARD' => "c++20",
+  }
+
+  # TODO(rename): rename to askar when lib name is changed
+  s.ios.vendored_frameworks = "native/mobile/ios/aries_askar.xcframework"
+
+  s.source_files = "ios/**/*.{h,m,mm}", "cpp/**/*.{h,cpp}"
+  
+  s.dependency "React-Core"
+  s.dependency "React-callinvoker"
+  s.dependency "React"
+end

package/build/askar-react-native/src/NativeBindings.d.ts

@@ -0,0 +1,144 @@
+import type { CallbackWithResponse, ReturnObject } from './serialize';
+type LocalKeyHandle = string;
+export interface NativeBindings {
+    version(options: Record<string, never>): string;
+    getCurrentError(options: Record<string, never>): string;
+    entryListCount(options: {
+        entryListHandle: string;
+    }): ReturnObject<number>;
+    entryListFree(options: {
+        entryListHandle: string;
+    }): ReturnObject<never>;
+    entryListGetCategory(options: {
+        entryListHandle: string;
+        index: number;
+    }): ReturnObject<string>;
+    entryListGetName(options: {
+        entryListHandle: string;
+        index: number;
+    }): ReturnObject<string>;
+    entryListGetTags(options: {
+        entryListHandle: string;
+        index: number;
+    }): ReturnObject<string>;
+    entryListGetValue(options: {
+        entryListHandle: string;
+        index: number;
+    }): ReturnObject<ArrayBuffer>;
+    keyAeadDecrypt(options: {
+        localKeyHandle: string;
+        ciphertext: ArrayBuffer;
+        nonce: ArrayBuffer;
+        tag?: ArrayBuffer;
+        aad?: ArrayBuffer;
+    }): ReturnObject<ArrayBuffer>;
+    keyAeadEncrypt(options: {
+        localKeyHandle: string;
+        message: ArrayBuffer;
+        nonce?: ArrayBuffer;
+        aad?: ArrayBuffer;
+    }): ReturnObject<{
+        noncePos: number;
+        tagPos: number;
+        buffer: ArrayBuffer;
+    }>;
+    keyAeadGetPadding(options: {
+        localKeyHandle: string;
+        msgLen: number;
+    }): ReturnObject<number>;
+    keyAeadGetParams(options: {
+        localKeyHandle: string;
+    }): ReturnObject<{
+        nonceLength: number;
+        tagLength: number;
+    }>;
+    keyAeadRandomNonce(options: unknown): ReturnObject<ArrayBuffer>;
+    keyConvert(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyCryptoBox(options: unknown): ReturnObject<ArrayBuffer>;
+    keyCryptoBoxOpen(options: unknown): ReturnObject<ArrayBuffer>;
+    keyCryptoBoxRandomNonce(options: Record<string, never>): ReturnObject<ArrayBuffer>;
+    keyCryptoBoxSeal(options: unknown): ReturnObject<ArrayBuffer>;
+    keyCryptoBoxSealOpen(options: unknown): ReturnObject<ArrayBuffer>;
+    keyDeriveEcdh1pu(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyDeriveEcdhEs(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyEntryListCount(options: unknown): ReturnObject<number>;
+    keyEntryListFree(options: unknown): ReturnObject<never>;
+    keyEntryListGetAlgorithm(options: unknown): ReturnObject<string>;
+    keyEntryListGetMetadata(options: unknown): ReturnObject<string>;
+    keyEntryListGetName(options: unknown): ReturnObject<string>;
+    keyEntryListGetTags(options: unknown): ReturnObject<string>;
+    keyEntryListLoadLocal(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyFree(options: unknown): ReturnObject<never>;
+    keyFromJwk(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyFromKeyExchange(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyFromPublicBytes(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyFromSecretBytes(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyFromSeed(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyGenerate(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyGetAlgorithm(options: unknown): ReturnObject<string>;
+    keyGetEphemeral(options: unknown): ReturnObject<number>;
+    keyGetJwkPublic(options: unknown): ReturnObject<string>;
+    keyGetJwkSecret(options: unknown): ReturnObject<ArrayBuffer>;
+    keyGetJwkThumbprint(options: unknown): ReturnObject<string>;
+    keyGetPublicBytes(options: unknown): ReturnObject<ArrayBuffer>;
+    keyGetSecretBytes(options: unknown): ReturnObject<ArrayBuffer>;
+    keySignMessage(options: unknown): ReturnObject<ArrayBuffer>;
+    keyUnwrapKey(options: unknown): ReturnObject<LocalKeyHandle>;
+    keyVerifySignature(options: unknown): ReturnObject<number>;
+    keyWrapKey(options: unknown): ReturnObject<{
+        buffer: ArrayBuffer;
+        tagPos: number;
+        noncePos: number;
+    }>;
+    scanFree(options: unknown): ReturnObject<never>;
+    scanNext(options: unknown): ReturnObject<never>;
+    scanStart(options: unknown): ReturnObject<number>;
+    sessionClose(options: unknown): ReturnObject<never>;
+    sessionCount(options: unknown): ReturnObject<never>;
+    sessionFetch(options: unknown): ReturnObject<never>;
+    sessionFetchAll(options: unknown): ReturnObject<never>;
+    sessionFetchAllKeys(options: unknown): ReturnObject<never>;
+    sessionFetchKey(options: unknown): ReturnObject<never>;
+    sessionInsertKey(options: unknown): ReturnObject<never>;
+    sessionRemoveAll(options: unknown): ReturnObject<never>;
+    sessionRemoveKey(options: unknown): ReturnObject<never>;
+    sessionStart(options: unknown): ReturnObject<never>;
+    sessionUpdate(options: unknown): ReturnObject<never>;
+    sessionUpdateKey(options: unknown): ReturnObject<never>;
+    setCustomLogger(options: unknown): ReturnObject<never>;
+    setDefaultLogger(options: unknown): ReturnObject<never>;
+    setMaxLogLevel(options: unknown): ReturnObject<never>;
+    storeClose(options: unknown): ReturnObject<never>;
+    storeCopyTo(options: unknown): ReturnObject<never>;
+    storeCreateProfile(options: unknown): ReturnObject<never>;
+    storeGenerateRawKey(options: {
+        seed?: ArrayBuffer;
+    }): ReturnObject<string>;
+    storeGetDefaultProfile(options: unknown): ReturnObject<never>;
+    storeGetProfileName(options: unknown): ReturnObject<never>;
+    storeListProfiles(options: unknown): ReturnObject<never>;
+    storeOpen(options: {
+        specUri: string;
+        keyMethod?: string;
+        passKey?: string;
+        profile?: string;
+        cb: CallbackWithResponse<number>;
+    }): ReturnObject<never>;
+    storeProvision(options: unknown): ReturnObject<never>;
+    storeRekey(options: unknown): ReturnObject<never>;
+    storeRemove(options: unknown): ReturnObject<never>;
+    storeRemoveProfile(options: unknown): ReturnObject<never>;
+    storeSetDefaultProfile(options: unknown): ReturnObject<never>;
+    migrateIndySdk(options: unknown): ReturnObject<never>;
+    stringListCount(options: {
+        stringListHandle: string;
+    }): ReturnObject<number>;
+    stringListFree(options: {
+        stringListHandle: string;
+    }): ReturnObject<never>;
+    stringListGetItem(options: {
+        stringListHandle: string;
+        index: number;
+    }): ReturnObject<string>;
+}
+export {};

package/build/askar-react-native/src/NativeBindings.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=NativeBindings.js.map

package/build/askar-react-native/src/NativeBindings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeBindings.js","sourceRoot":"","sources":["../../../src/NativeBindings.ts"],"names":[],"mappings":""}

package/build/askar-react-native/src/ReactNativeAskar.d.ts

@@ -0,0 +1,100 @@
+import type { Askar, AskarErrorObject, EntryListCountOptions, EntryListFreeOptions, EntryListGetCategoryOptions, EntryListGetNameOptions, EntryListGetTagsOptions, EntryListGetValueOptions, KeyAeadDecryptOptions, KeyAeadEncryptOptions, KeyAeadGetPaddingOptions, KeyAeadGetParamsOptions, KeyAeadRandomNonceOptions, KeyConvertOptions, KeyCryptoBoxOpenOptions, KeyCryptoBoxOptions, KeyCryptoBoxSealOpenOptions, KeyCryptoBoxSealOptions, KeyDeriveEcdh1puOptions, KeyDeriveEcdhEsOptions, KeyEntryListCountOptions, KeyEntryListFreeOptions, KeyEntryListGetAlgorithmOptions, KeyEntryListGetMetadataOptions, KeyEntryListGetNameOptions, KeyEntryListGetTagsOptions, KeyEntryListLoadLocalOptions, KeyFreeOptions, KeyFromJwkOptions, KeyFromKeyExchangeOptions, KeyFromPublicBytesOptions, KeyFromSecretBytesOptions, KeyFromSeedOptions, KeyGenerateOptions, KeyGetAlgorithmOptions, KeyGetEphemeralOptions, KeyGetJwkPublicOptions, KeyGetJwkSecretOptions, KeyGetJwkThumbprintOptions, KeyGetPublicBytesOptions, KeyGetSecretBytesOptions, KeySignMessageOptions, KeyUnwrapKeyOptions, KeyVerifySignatureOptions, KeyWrapKeyOptions, MigrateIndySdkOptions, ScanFreeOptions, ScanNextOptions, ScanStartOptions, SessionCloseOptions, SessionCountOptions, SessionFetchAllKeysOptions, SessionFetchAllOptions, SessionFetchKeyOptions, SessionFetchOptions, SessionInsertKeyOptions, SessionRemoveAllOptions, SessionRemoveKeyOptions, SessionStartOptions, SessionUpdateKeyOptions, SessionUpdateOptions, StoreCloseOptions, StoreCopyToOptions, StoreCreateProfileOptions, StoreGenerateRawKeyOptions, StoreGetDefaultProfileOptions, StoreGetProfileNameOptions, StoreListProfilesOptions, StoreOpenOptions, StoreProvisionOptions, StoreRekeyOptions, StoreRemoveOptions, StoreRemoveProfileOptions, StoreSetDefaultProfileOptions } from '@openwallet-foundation/askar-shared';
+import type { NativeBindings } from './NativeBindings';
+import { AeadParams, EncryptedBuffer, EntryListHandle, KeyEntryListHandle, LocalKeyHandle, ScanHandle, SessionHandle, StoreHandle } from '@openwallet-foundation/askar-shared';
+export declare class ReactNativeAskar implements Askar {
+    private askar;
+    constructor(bindings: NativeBindings);
+    /**
+     * Fetch the error from the native library and return it as a JS error
+     *
+     * NOTE:
+     * Checks whether the error code of the returned error matches the error code that was passed to the function.
+     * If it doesn't, we throw an error with the original errorCode, and a custom message explaining we weren't able
+     * to retrieve the error message from the native library. This should however not break functionality as long as
+     * error codes are used rather than error messages for error handling.
+     *
+     */
+    private getAskarError;
+    private handleError;
+    private promisify;
+    private promisifyWithResponse;
+    version(): string;
+    getCurrentError(): AskarErrorObject;
+    clearCustomLogger(): void;
+    setCustomLogger(): void;
+    setDefaultLogger(): void;
+    setMaxLogLevel(): void;
+    entryListCount(options: EntryListCountOptions): number;
+    entryListFree(options: EntryListFreeOptions): void;
+    entryListGetCategory(options: EntryListGetCategoryOptions): string;
+    entryListGetName(options: EntryListGetNameOptions): string;
+    entryListGetTags(options: EntryListGetTagsOptions): string | null;
+    entryListGetValue(options: EntryListGetValueOptions): Uint8Array;
+    keyAeadDecrypt(options: KeyAeadDecryptOptions): Uint8Array;
+    keyAeadEncrypt(options: KeyAeadEncryptOptions): EncryptedBuffer;
+    keyAeadGetPadding(options: KeyAeadGetPaddingOptions): number;
+    keyAeadGetParams(options: KeyAeadGetParamsOptions): AeadParams;
+    keyAeadRandomNonce(options: KeyAeadRandomNonceOptions): Uint8Array;
+    keyConvert(options: KeyConvertOptions): LocalKeyHandle;
+    keyCryptoBox(options: KeyCryptoBoxOptions): Uint8Array;
+    keyCryptoBoxOpen(options: KeyCryptoBoxOpenOptions): Uint8Array;
+    keyCryptoBoxRandomNonce(): Uint8Array;
+    keyCryptoBoxSeal(options: KeyCryptoBoxSealOptions): Uint8Array;
+    keyCryptoBoxSealOpen(options: KeyCryptoBoxSealOpenOptions): Uint8Array;
+    keyDeriveEcdh1pu(options: KeyDeriveEcdh1puOptions): LocalKeyHandle;
+    keyDeriveEcdhEs(options: KeyDeriveEcdhEsOptions): LocalKeyHandle;
+    keyEntryListCount(options: KeyEntryListCountOptions): number;
+    keyEntryListFree(options: KeyEntryListFreeOptions): void;
+    keyEntryListGetAlgorithm(options: KeyEntryListGetAlgorithmOptions): string;
+    keyEntryListGetMetadata(options: KeyEntryListGetMetadataOptions): string | null;
+    keyEntryListGetName(options: KeyEntryListGetNameOptions): string;
+    keyEntryListGetTags(options: KeyEntryListGetTagsOptions): string | null;
+    keyEntryListLoadLocal(options: KeyEntryListLoadLocalOptions): LocalKeyHandle;
+    keyFree(options: KeyFreeOptions): void;
+    keyFromJwk(options: KeyFromJwkOptions): LocalKeyHandle;
+    keyFromKeyExchange(options: KeyFromKeyExchangeOptions): LocalKeyHandle;
+    keyFromPublicBytes(options: KeyFromPublicBytesOptions): LocalKeyHandle;
+    keyFromSecretBytes(options: KeyFromSecretBytesOptions): LocalKeyHandle;
+    keyFromSeed(options: KeyFromSeedOptions): LocalKeyHandle;
+    keyGenerate(options: KeyGenerateOptions): LocalKeyHandle;
+    keyGetAlgorithm(options: KeyGetAlgorithmOptions): string;
+    keyGetEphemeral(options: KeyGetEphemeralOptions): number;
+    keyGetJwkPublic(options: KeyGetJwkPublicOptions): string;
+    keyGetJwkSecret(options: KeyGetJwkSecretOptions): Uint8Array;
+    keyGetJwkThumbprint(options: KeyGetJwkThumbprintOptions): string;
+    keyGetPublicBytes(options: KeyGetPublicBytesOptions): Uint8Array;
+    keyGetSecretBytes(options: KeyGetSecretBytesOptions): Uint8Array;
+    keySignMessage(options: KeySignMessageOptions): Uint8Array;
+    keyUnwrapKey(options: KeyUnwrapKeyOptions): LocalKeyHandle;
+    keyVerifySignature(options: KeyVerifySignatureOptions): boolean;
+    keyWrapKey(options: KeyWrapKeyOptions): EncryptedBuffer;
+    scanFree(options: ScanFreeOptions): void;
+    scanNext(options: ScanNextOptions): Promise<EntryListHandle | null>;
+    scanStart(options: ScanStartOptions): Promise<ScanHandle>;
+    sessionClose(options: SessionCloseOptions): Promise<void>;
+    sessionCount(options: SessionCountOptions): Promise<number>;
+    sessionFetch(options: SessionFetchOptions): Promise<EntryListHandle | null>;
+    sessionFetchAll(options: SessionFetchAllOptions): Promise<EntryListHandle | null>;
+    sessionFetchAllKeys(options: SessionFetchAllKeysOptions): Promise<KeyEntryListHandle | null>;
+    sessionFetchKey(options: SessionFetchKeyOptions): Promise<KeyEntryListHandle | null>;
+    sessionInsertKey(options: SessionInsertKeyOptions): Promise<void>;
+    sessionRemoveAll(options: SessionRemoveAllOptions): Promise<number>;
+    sessionRemoveKey(options: SessionRemoveKeyOptions): Promise<void>;
+    sessionStart(options: SessionStartOptions): Promise<SessionHandle>;
+    sessionUpdate(options: SessionUpdateOptions): Promise<void>;
+    sessionUpdateKey(options: SessionUpdateKeyOptions): Promise<void>;
+    storeClose(options: StoreCloseOptions): Promise<void>;
+    storeCopyTo(options: StoreCopyToOptions): Promise<void>;
+    storeCreateProfile(options: StoreCreateProfileOptions): Promise<string>;
+    storeGenerateRawKey(options: StoreGenerateRawKeyOptions): string;
+    storeGetProfileName(options: StoreGetProfileNameOptions): Promise<string>;
+    storeGetDefaultProfile(options: StoreGetDefaultProfileOptions): Promise<string>;
+    storeListProfiles(options: StoreListProfilesOptions): Promise<string[]>;
+    storeOpen(options: StoreOpenOptions): Promise<StoreHandle>;
+    storeProvision(options: StoreProvisionOptions): Promise<StoreHandle>;
+    storeRekey(options: StoreRekeyOptions): Promise<void>;
+    storeRemove(options: StoreRemoveOptions): Promise<number>;
+    storeRemoveProfile(options: StoreRemoveProfileOptions): Promise<number>;
+    storeSetDefaultProfile(options: StoreSetDefaultProfileOptions): Promise<void>;
+    migrateIndySdk(options: MigrateIndySdkOptions): Promise<void>;
+}