libsodium-wrappers 0.8.2 → 0.8.3

package/README.md

@@ -73,8 +73,8 @@ await sodium.ready;
 
 let key = sodium.crypto_secretstream_xchacha20poly1305_keygen();
 
-let res = sodium.crypto_secretstream_xchacha20poly1305_init_push(key);
-let [state_out, header] = [res.state, res.header];
+let { state: state_out, header } =
+  sodium.crypto_secretstream_xchacha20poly1305_init_push(key);
 let c1 = sodium.crypto_secretstream_xchacha20poly1305_push(state_out,
   sodium.from_string('message 1'), null,
   sodium.crypto_secretstream_xchacha20poly1305_TAG_MESSAGE);
@@ -84,9 +84,11 @@ let c2 = sodium.crypto_secretstream_xchacha20poly1305_push(state_out,
 
 let state_in = sodium.crypto_secretstream_xchacha20poly1305_init_pull(header, key);
 let r1 = sodium.crypto_secretstream_xchacha20poly1305_pull(state_in, c1);
-let [m1, tag1] = [sodium.to_string(r1.message), r1.tag];
+let { message: m1_bytes, tag: tag1 } = r1;
+let m1 = sodium.to_string(m1_bytes);
 let r2 = sodium.crypto_secretstream_xchacha20poly1305_pull(state_in, c2);
-let [m2, tag2] = [sodium.to_string(r2.message), r2.tag];
+let { message: m2_bytes, tag: tag2 } = r2;
+let m2 = sodium.to_string(m2_bytes);
 
 console.log(m1);
 console.log(m2);
@@ -219,6 +221,13 @@ returns the following object:
 { publicKey: (Uint8Array), privateKey: (Uint8Array), keyType: 'x25519' }
 ```
 
+This also applies to newer APIs such as:
+```javascript
+{ state: (StateAddress), header: (Uint8Array) }
+{ ciphertext: (Uint8Array), sharedSecret: (Uint8Array) }
+```
+for `crypto_secretstream_xchacha20poly1305_init_push()` and `crypto_kem_enc()`.
+
 ### Standard vs Sumo version
 
 The standard version (in the `dist/browsers`, `dist/modules`, and
@@ -247,9 +256,10 @@ need to be installed on your system:
 * bun
 * make
 
-Running `make` will install the dev dependencies, clone libsodium,
-build it, test it, build the wrapper, and create the modules and
-minified distribution files.
+Running `make` will install the dev dependencies if needed, build the
+standard and sumo distributions, regenerate API docs and TypeScript
+bindings, pack the generated outputs, and rebuild the browser test
+artifacts.
 
 ### Benchmarks
 

package/dist/modules/libsodium-wrappers.d.ts

@@ -161,6 +161,8 @@ export const crypto_generichash_blake2b_PERSONALBYTES: number;
 export const crypto_generichash_blake2b_SALTBYTES: number;
 export const crypto_hash_BYTES: number;
 export const crypto_hash_sha256_BYTES: number;
+export const crypto_hash_sha3256_BYTES: number;
+export const crypto_hash_sha3512_BYTES: number;
 export const crypto_hash_sha512_BYTES: number;
 export const crypto_ipcrypt_BYTES: number;
 export const crypto_ipcrypt_KEYBYTES: number;
@@ -188,6 +190,22 @@ export const crypto_kdf_hkdf_sha256_KEYBYTES: number;
 export const crypto_kdf_hkdf_sha512_BYTES_MAX: number;
 export const crypto_kdf_hkdf_sha512_BYTES_MIN: number;
 export const crypto_kdf_hkdf_sha512_KEYBYTES: number;
+export const crypto_kem_CIPHERTEXTBYTES: number;
+export const crypto_kem_PRIMITIVE: string;
+export const crypto_kem_PUBLICKEYBYTES: number;
+export const crypto_kem_SECRETKEYBYTES: number;
+export const crypto_kem_SEEDBYTES: number;
+export const crypto_kem_SHAREDSECRETBYTES: number;
+export const crypto_kem_mlkem768_CIPHERTEXTBYTES: number;
+export const crypto_kem_mlkem768_PUBLICKEYBYTES: number;
+export const crypto_kem_mlkem768_SECRETKEYBYTES: number;
+export const crypto_kem_mlkem768_SEEDBYTES: number;
+export const crypto_kem_mlkem768_SHAREDSECRETBYTES: number;
+export const crypto_kem_xwing_CIPHERTEXTBYTES: number;
+export const crypto_kem_xwing_PUBLICKEYBYTES: number;
+export const crypto_kem_xwing_SECRETKEYBYTES: number;
+export const crypto_kem_xwing_SEEDBYTES: number;
+export const crypto_kem_xwing_SHAREDSECRETBYTES: number;
 export const crypto_kx_PUBLICKEYBYTES: number;
 export const crypto_kx_SECRETKEYBYTES: number;
 export const crypto_kx_SEEDBYTES: number;
@@ -1235,6 +1253,52 @@ export function crypto_hash_sha256_init(): StateAddress;
  * @param message_chunk
  */
 export function crypto_hash_sha256_update(state_address: StateAddress, message_chunk: Uint8Array | string): void;
+/**
+ * @param message
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns Uint8Array | string (CRYPTO_HASH_SHA3256_BYTES bytes)
+ */
+export function crypto_hash_sha3256(message: Uint8Array | string, outputFormat?: Uint8ArrayOutputFormat | null): Uint8Array;
+export function crypto_hash_sha3256(message: Uint8Array | string, outputFormat: StringOutputFormat): string;
+/**
+ * @param state_address
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns Uint8Array | string (CRYPTO_HASH_SHA3256_BYTES bytes)
+ */
+export function crypto_hash_sha3256_final(state_address: StateAddress, outputFormat?: Uint8ArrayOutputFormat | null): Uint8Array;
+export function crypto_hash_sha3256_final(state_address: StateAddress, outputFormat: StringOutputFormat): string;
+/**
+ * @returns StateAddress
+ */
+export function crypto_hash_sha3256_init(): StateAddress;
+/**
+ * @param state_address
+ * @param message_chunk
+ */
+export function crypto_hash_sha3256_update(state_address: StateAddress, message_chunk: Uint8Array | string): void;
+/**
+ * @param message
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns Uint8Array | string (CRYPTO_HASH_SHA3512_BYTES bytes)
+ */
+export function crypto_hash_sha3512(message: Uint8Array | string, outputFormat?: Uint8ArrayOutputFormat | null): Uint8Array;
+export function crypto_hash_sha3512(message: Uint8Array | string, outputFormat: StringOutputFormat): string;
+/**
+ * @param state_address
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns Uint8Array | string (CRYPTO_HASH_SHA3512_BYTES bytes)
+ */
+export function crypto_hash_sha3512_final(state_address: StateAddress, outputFormat?: Uint8ArrayOutputFormat | null): Uint8Array;
+export function crypto_hash_sha3512_final(state_address: StateAddress, outputFormat: StringOutputFormat): string;
+/**
+ * @returns StateAddress
+ */
+export function crypto_hash_sha3512_init(): StateAddress;
+/**
+ * @param state_address
+ * @param message_chunk
+ */
+export function crypto_hash_sha3512_update(state_address: StateAddress, message_chunk: Uint8Array | string): void;
 /**
  * @param message
  * @param outputFormat Output format (default: Uint8Array)
@@ -1364,6 +1428,110 @@ export function crypto_kdf_derive_from_key(subkey_len: number, subkey_id: number
  */
 export function crypto_kdf_keygen(outputFormat?: Uint8ArrayOutputFormat | null): Uint8Array;
 export function crypto_kdf_keygen(outputFormat: StringOutputFormat): string;
+/**
+ * @param ciphertext (CRYPTO_KEM_CIPHERTEXTBYTES bytes)
+ * @param privateKey (CRYPTO_KEM_SECRETKEYBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns Uint8Array | string (CRYPTO_KEM_SHAREDSECRETBYTES bytes)
+ */
+export function crypto_kem_dec(ciphertext: Uint8Array, privateKey: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): Uint8Array;
+export function crypto_kem_dec(ciphertext: Uint8Array, privateKey: Uint8Array, outputFormat: StringOutputFormat): string;
+/**
+ * @param publicKey (CRYPTO_KEM_PUBLICKEYBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {ciphertext, sharedSecret} (CRYPTO_KEM_CIPHERTEXTBYTES bytes)
+ */
+export function crypto_kem_enc(publicKey: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): { ciphertext: Uint8Array; sharedSecret: Uint8Array };
+export function crypto_kem_enc(publicKey: Uint8Array, outputFormat: StringOutputFormat): { ciphertext: string; sharedSecret: string };
+/**
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {publicKey, privateKey, keyType} (CRYPTO_KEM_PUBLICKEYBYTES bytes)
+ */
+export function crypto_kem_keypair(outputFormat?: Uint8ArrayOutputFormat | null): { publicKey: Uint8Array; privateKey: Uint8Array; keyType: string };
+export function crypto_kem_keypair(outputFormat: StringOutputFormat): { publicKey: string; privateKey: string; keyType: string };
+/**
+ * @param ciphertext (CRYPTO_KEM_MLKEM768_CIPHERTEXTBYTES bytes)
+ * @param privateKey (CRYPTO_KEM_MLKEM768_SECRETKEYBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns Uint8Array | string (CRYPTO_KEM_MLKEM768_SHAREDSECRETBYTES bytes)
+ */
+export function crypto_kem_mlkem768_dec(ciphertext: Uint8Array, privateKey: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): Uint8Array;
+export function crypto_kem_mlkem768_dec(ciphertext: Uint8Array, privateKey: Uint8Array, outputFormat: StringOutputFormat): string;
+/**
+ * @param publicKey (CRYPTO_KEM_MLKEM768_PUBLICKEYBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {ciphertext, sharedSecret} (CRYPTO_KEM_MLKEM768_CIPHERTEXTBYTES bytes)
+ */
+export function crypto_kem_mlkem768_enc(publicKey: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): { ciphertext: Uint8Array; sharedSecret: Uint8Array };
+export function crypto_kem_mlkem768_enc(publicKey: Uint8Array, outputFormat: StringOutputFormat): { ciphertext: string; sharedSecret: string };
+/**
+ * @param publicKey (CRYPTO_KEM_MLKEM768_PUBLICKEYBYTES bytes)
+ * @param seed
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {ciphertext, sharedSecret} (CRYPTO_KEM_MLKEM768_CIPHERTEXTBYTES bytes)
+ */
+export function crypto_kem_mlkem768_enc_deterministic(publicKey: Uint8Array, seed: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): { ciphertext: Uint8Array; sharedSecret: Uint8Array };
+export function crypto_kem_mlkem768_enc_deterministic(publicKey: Uint8Array, seed: Uint8Array, outputFormat: StringOutputFormat): { ciphertext: string; sharedSecret: string };
+/**
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {publicKey, privateKey, keyType} (CRYPTO_KEM_MLKEM768_PUBLICKEYBYTES bytes)
+ */
+export function crypto_kem_mlkem768_keypair(outputFormat?: Uint8ArrayOutputFormat | null): { publicKey: Uint8Array; privateKey: Uint8Array; keyType: string };
+export function crypto_kem_mlkem768_keypair(outputFormat: StringOutputFormat): { publicKey: string; privateKey: string; keyType: string };
+/**
+ * @param seed (CRYPTO_KEM_MLKEM768_SEEDBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {publicKey, privateKey, keyType} (CRYPTO_KEM_MLKEM768_PUBLICKEYBYTES bytes)
+ */
+export function crypto_kem_mlkem768_seed_keypair(seed: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): { publicKey: Uint8Array; privateKey: Uint8Array; keyType: string };
+export function crypto_kem_mlkem768_seed_keypair(seed: Uint8Array, outputFormat: StringOutputFormat): { publicKey: string; privateKey: string; keyType: string };
+/**
+ * @returns string
+ */
+export function crypto_kem_primitive(): string;
+/**
+ * @param seed (CRYPTO_KEM_SEEDBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {publicKey, privateKey, keyType} (CRYPTO_KEM_PUBLICKEYBYTES bytes)
+ */
+export function crypto_kem_seed_keypair(seed: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): { publicKey: Uint8Array; privateKey: Uint8Array; keyType: string };
+export function crypto_kem_seed_keypair(seed: Uint8Array, outputFormat: StringOutputFormat): { publicKey: string; privateKey: string; keyType: string };
+/**
+ * @param ciphertext (CRYPTO_KEM_XWING_CIPHERTEXTBYTES bytes)
+ * @param privateKey (CRYPTO_KEM_XWING_SECRETKEYBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns Uint8Array | string (CRYPTO_KEM_XWING_SHAREDSECRETBYTES bytes)
+ */
+export function crypto_kem_xwing_dec(ciphertext: Uint8Array, privateKey: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): Uint8Array;
+export function crypto_kem_xwing_dec(ciphertext: Uint8Array, privateKey: Uint8Array, outputFormat: StringOutputFormat): string;
+/**
+ * @param publicKey (CRYPTO_KEM_XWING_PUBLICKEYBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {ciphertext, sharedSecret} (CRYPTO_KEM_XWING_CIPHERTEXTBYTES bytes)
+ */
+export function crypto_kem_xwing_enc(publicKey: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): { ciphertext: Uint8Array; sharedSecret: Uint8Array };
+export function crypto_kem_xwing_enc(publicKey: Uint8Array, outputFormat: StringOutputFormat): { ciphertext: string; sharedSecret: string };
+/**
+ * @param publicKey (CRYPTO_KEM_XWING_PUBLICKEYBYTES bytes)
+ * @param seed
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {ciphertext, sharedSecret} (CRYPTO_KEM_XWING_CIPHERTEXTBYTES bytes)
+ */
+export function crypto_kem_xwing_enc_deterministic(publicKey: Uint8Array, seed: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): { ciphertext: Uint8Array; sharedSecret: Uint8Array };
+export function crypto_kem_xwing_enc_deterministic(publicKey: Uint8Array, seed: Uint8Array, outputFormat: StringOutputFormat): { ciphertext: string; sharedSecret: string };
+/**
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {publicKey, privateKey, keyType} (CRYPTO_KEM_XWING_PUBLICKEYBYTES bytes)
+ */
+export function crypto_kem_xwing_keypair(outputFormat?: Uint8ArrayOutputFormat | null): { publicKey: Uint8Array; privateKey: Uint8Array; keyType: string };
+export function crypto_kem_xwing_keypair(outputFormat: StringOutputFormat): { publicKey: string; privateKey: string; keyType: string };
+/**
+ * @param seed (CRYPTO_KEM_XWING_SEEDBYTES bytes)
+ * @param outputFormat Output format (default: Uint8Array)
+ * @returns {publicKey, privateKey, keyType} (CRYPTO_KEM_XWING_PUBLICKEYBYTES bytes)
+ */
+export function crypto_kem_xwing_seed_keypair(seed: Uint8Array, outputFormat?: Uint8ArrayOutputFormat | null): { publicKey: Uint8Array; privateKey: Uint8Array; keyType: string };
+export function crypto_kem_xwing_seed_keypair(seed: Uint8Array, outputFormat: StringOutputFormat): { publicKey: string; privateKey: string; keyType: string };
 /**
  * @param clientPublicKey (CRYPTO_KX_PUBLICKEYBYTES bytes)
  * @param clientSecretKey (CRYPTO_KX_SECRETKEYBYTES bytes)
@@ -1449,9 +1617,9 @@ export function crypto_pwhash(keyLength: number, password: Uint8Array | string,
  * @param password
  * @param opsLimit
  * @param memLimit
- * @returns Uint8Array (CRYPTO_PWHASH_STRBYTES bytes)
+ * @returns string (CRYPTO_PWHASH_STRBYTES bytes)
  */
-export function crypto_pwhash_str(password: Uint8Array | string, opsLimit: number, memLimit: number): Uint8Array;
+export function crypto_pwhash_str(password: Uint8Array | string, opsLimit: number, memLimit: number): string;
 /**
  * @param hashed_password
  * @param opsLimit
@@ -1968,9 +2136,9 @@ export function randombytes_stir(): void;
 export function randombytes_uniform(upper_bound: number): number;
 /**
  * @param bin
- * @returns Uint8Array
+ * @returns string
  */
-export function sodium_bin2ip(bin: Uint8Array): Uint8Array;
+export function sodium_bin2ip(bin: Uint8Array): string;
 /**
  * @param ip
  * @param outputFormat Output format (default: Uint8Array)