internxt-crypto 0.0.9-alpha → 0.0.10-alpha

package/dist/derive-key.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Derives a symmetric key from the base key and context string
+ *
+ * @param context - The context string.
+ * The context string should be hardcoded, globally unique, and application-specific.
+ * @param baseKey - The base key (NOT PASSWORD!)
+ * @returns The derived secret key
+ */
+declare function deriveSymmetricKeyFromContext(context: string, baseKey: Uint8Array): Uint8Array;
+/**
+ * Derives a symmetric CryptoKey from the base key and context string
+ *
+ * @param context - The context string.
+ * The context string should be hardcoded, globally unique, and application-specific.
+ * @param baseKey - The base key (NOT PASSWORD!)
+ * @returns The derived secret CryptoKey
+ */
+declare function deriveSymmetricCryptoKeyFromContext(context: string, baseKey: Uint8Array): Promise<CryptoKey>;
+/**
+ * Derives a symmetric key from two keys
+ *
+ * @param key1 - The 32-bytes key
+ * @param key2 - The 32-bytes key
+ * @returns The derived secret key
+ */
+declare function deriveSymmetricKeyFromTwoKeys(key1: Uint8Array, key2: Uint8Array): Uint8Array;
+/**
+ * Derives a symmetric CryptoKey from two keys
+ *
+ * @param key1 - The 32-bytes key
+ * @param key2 - The 32-bytes key
+ * @returns The derived secret CryptoKey
+ */
+declare function deriveSymmetricCryptoKeyFromTwoKeys(key1: Uint8Array, key2: Uint8Array): Promise<CryptoKey>;
+/**
+ * Derives a symmetric key from two keys and context
+ *
+ * @param key1 - The 32-bytes key
+ * @param key2 - The 32-bytes key
+ * @param context - The context string
+ * @returns The derived symmetric key
+ */
+declare function deriveKeyFromTwoKeysAndContext(key1: Uint8Array, key2: Uint8Array, context: string): Uint8Array;
+
+/**
+ * Derives a symmetric key from a user's password with a randomly sampled salt
+ *
+ * @param password - The user's password
+ * @returns The derived secret key and randomly sampled salt
+ */
+declare function getKeyFromPassword(password: string): Promise<{
+    key: Uint8Array;
+    salt: Uint8Array;
+}>;
+/**
+ * Derives a symmetric key from a user's password and salt
+ *
+ * @param password - The user's password
+ * @param salt - The given salt
+ * @returns The derived secret key
+ */
+declare function getKeyFromPasswordAndSalt(password: string, salt: Uint8Array): Promise<Uint8Array>;
+/**
+ * Derives a HEX symmetric key from a user's password with a randomly sampled salt
+ *
+ * @param password - The user's password
+ * @returns The derived HEX secret key and randomly sampled HEX salt
+ */
+declare function getKeyFromPasswordHex(password: string): Promise<{
+    keyHex: string;
+    saltHex: string;
+}>;
+/**
+ * Derives a HEX symmetric key from a user's password and salt
+ *
+ * @param password - The user's password
+ * @param saltHex - The given HEX salt
+ * @returns The derived HEX secret key
+ */
+declare function getKeyFromPasswordAndSaltHex(password: string, saltHex: string): Promise<string>;
+/**
+ * Verifies the derived key
+ *
+ * @param password - The user's password
+ * @param saltHex - The given HEX salt
+ * @param keyHex - The derived HEX key
+ * @returns The result of the key verification
+ */
+declare function verifyKeyFromPasswordHex(password: string, saltHex: string, keyHex: string): Promise<boolean>;
+
+export { deriveKeyFromTwoKeysAndContext, deriveSymmetricCryptoKeyFromContext, deriveSymmetricCryptoKeyFromTwoKeys, deriveSymmetricKeyFromContext, deriveSymmetricKeyFromTwoKeys, getKeyFromPassword, getKeyFromPasswordAndSalt, getKeyFromPasswordAndSaltHex, getKeyFromPasswordHex, verifyKeyFromPasswordHex };