### crypto_xof_turboshake128_init_with_domain Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes a TurboSHAKE128 extendable-output function context with a specific domain separation value. ```APIDOC ## crypto_xof_turboshake128_init_with_domain ### Description Initializes a TurboSHAKE128 extendable-output function context with a custom domain separation value. ### Method N/A (Function call) ### Parameters - **domain** (bytes) - Required - The domain separation value. ### Response - **state** (pointer) - An initialized state for the TurboSHAKE128 context. ``` -------------------------------- ### crypto_xof_turboshake256_init_with_domain Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes a TurboSHAKE256 extendable-output function context with a specific domain separation value. ```APIDOC ## crypto_xof_turboshake256_init_with_domain ### Description Initializes a TurboSHAKE256 extendable-output function context with a custom domain separation value. ### Method N/A (Function call) ### Parameters - **domain** (bytes) - Required - The domain separation value. ### Response - **state** (pointer) - An initialized state for the TurboSHAKE256 context. ``` -------------------------------- ### crypto_xof_turboshake128_init Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes a TurboSHAKE128 extendable-output function context. ```APIDOC ## crypto_xof_turboshake128_init ### Description Initializes a TurboSHAKE128 extendable-output function context. ### Method N/A (Function call) ### Response - **state** (pointer) - An initialized state for the TurboSHAKE128 context. ``` -------------------------------- ### crypto_xof_shake128_init_with_domain Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes a SHAKE128 extendable-output function context with a specific domain separation value. ```APIDOC ## crypto_xof_shake128_init_with_domain ### Description Initializes a SHAKE128 extendable-output function context with a custom domain separation value. ### Method N/A (Function call) ### Parameters - **domain** (bytes) - Required - The domain separation value. ### Response - **state** (pointer) - An initialized state for the SHAKE128 context. ``` -------------------------------- ### crypto_xof_shake128_init Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes a SHAKE128 extendable-output function context. ```APIDOC ## crypto_xof_shake128_init ### Description Initializes a SHAKE128 extendable-output function context. ### Method N/A (Function call) ### Response - **state** (pointer) - An initialized state for the SHAKE128 context. ``` -------------------------------- ### crypto_xof_shake256_init Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes a SHAKE256 extendable-output function context. ```APIDOC ## crypto_xof_shake256_init ### Description Initializes a SHAKE256 extendable-output function context. ### Method N/A (Function call) ### Response - **state** (pointer) - An initialized state for the SHAKE256 context. ``` -------------------------------- ### crypto_xof_turboshake256_init Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes a TurboSHAKE256 extendable-output function context. ```APIDOC ## crypto_xof_turboshake256_init ### Description Initializes a TurboSHAKE256 extendable-output function context. ### Method N/A (Function call) ### Response - **state** (pointer) - An initialized state for the TurboSHAKE256 context. ``` -------------------------------- ### crypto_xof_shake256_init_with_domain Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes a SHAKE256 extendable-output function context with a specific domain separation value. ```APIDOC ## crypto_xof_shake256_init_with_domain ### Description Initializes a SHAKE256 extendable-output function context with a custom domain separation value. ### Method N/A (Function call) ### Parameters - **domain** (bytes) - Required - The domain separation value. ### Response - **state** (pointer) - An initialized state for the SHAKE256 context. ``` -------------------------------- ### crypto_sign_init Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes the state for generic detached signing or verification. This prepares the hashing context for processing message data. ```APIDOC ## crypto_sign_init ### Description Initializes the state for generic detached signing operations. ### Method N/A (Function call) ### Parameters None ### Response - **state** (pointer) - An initialized state for the hashing context. ``` -------------------------------- ### Key Exchange (KX) Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Provides functions for secure key exchange, including key pair generation, session key derivation, and constants for key sizes. ```APIDOC ## crypto_kx_client_session_keys ### Description Derives session keys for the client in a key exchange. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kx_keypair ### Description Generates a public and secret key pair for key exchange. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kx_primitive ### Description Returns the name of the default key exchange primitive. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kx_publickeybytes ### Description Size of the public key in bytes for key exchange. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kx_secretkeybytes ### Description Size of the secret key in bytes for key exchange. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kx_seed_keypair ### Description Generates a public and secret key pair for key exchange using a seed. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kx_seedbytes ### Description Size of the seed in bytes for key exchange key generation. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kx_server_session_keys ### Description Derives session keys for the server in a key exchange. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kx_sessionkeybytes ### Description Size of the session key in bytes for key exchange. ### Method N/A (Function call) ### Endpoint N/A ``` -------------------------------- ### Key Derivation Functions (KDF) Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Provides functions for key derivation using various algorithms like BLAKE2b and HKDF-SHA256/512. Includes functions for deriving keys from a master key, context management, and size constants. ```APIDOC ## crypto_kdf_blake2b_bytes_max ### Description Maximum number of bytes that can be derived using crypto_kdf_blake2b. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_blake2b_bytes_min ### Description Minimum number of bytes that can be derived using crypto_kdf_blake2b. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_blake2b_contextbytes ### Description Size of the context in bytes for crypto_kdf_blake2b. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_blake2b_derive_from_key ### Description Derives a key from a master key using BLAKE2b. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_blake2b_keybytes ### Description Size of the key in bytes for crypto_kdf_blake2b. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_bytes_max ### Description Maximum number of bytes that can be derived by the default KDF primitive. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_bytes_min ### Description Minimum number of bytes that can be derived by the default KDF primitive. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_contextbytes ### Description Size of the context in bytes for the default KDF primitive. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_derive_from_key ### Description Derives a key from a master key using the default KDF primitive. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_bytes_max ### Description Maximum number of bytes that can be derived using crypto_kdf_hkdf_sha256. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_bytes_min ### Description Minimum number of bytes that can be derived using crypto_kdf_hkdf_sha256. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_expand ### Description Expands a seed to a larger key using HKDF-SHA256. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_extract ### Description Extracts a fixed-size key from a variable-length input using HKDF-SHA256. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_extract_final ### Description Finalizes the HKDF-SHA256 extraction process. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_extract_init ### Description Initializes the HKDF-SHA256 extraction process. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_extract_update ### Description Updates the HKDF-SHA256 extraction state with input data. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_keybytes ### Description Size of the key in bytes for crypto_kdf_hkdf_sha256. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_keygen ### Description Generates a random key suitable for HKDF-SHA256. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha256_statebytes ### Description Size of the state in bytes for HKDF-SHA256 operations. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_bytes_max ### Description Maximum number of bytes that can be derived using crypto_kdf_hkdf_sha512. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_bytes_min ### Description Minimum number of bytes that can be derived using crypto_kdf_hkdf_sha512. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_expand ### Description Expands a seed to a larger key using HKDF-SHA512. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_extract ### Description Extracts a fixed-size key from a variable-length input using HKDF-SHA512. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_extract_final ### Description Finalizes the HKDF-SHA512 extraction process. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_extract_init ### Description Initializes the HKDF-SHA512 extraction process. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_extract_update ### Description Updates the HKDF-SHA512 extraction state with input data. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_keybytes ### Description Size of the key in bytes for crypto_kdf_hkdf_sha512. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_keygen ### Description Generates a random key suitable for HKDF-SHA512. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_hkdf_sha512_statebytes ### Description Size of the state in bytes for HKDF-SHA512 operations. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_keybytes ### Description Size of the key in bytes for the default KDF primitive. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_keygen ### Description Generates a random key suitable for the default KDF primitive. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kdf_primitive ### Description Returns the name of the default KDF primitive. ### Method N/A (Function call) ### Endpoint N/A ``` -------------------------------- ### Memory and Comparison Functions Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Functions for secure memory operations, comparisons, and initialization. ```APIDOC ## sodium_compare ### Description Compares two memory regions for equality in constant time. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_is_zero ### Description Checks if a memory region consists entirely of zero bytes in constant time. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_memcmp ### Description Compares two memory regions for equality. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_memzero ### Description Clears a memory region by filling it with zero bytes. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_init ### Description Initializes the libsodium library. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_set_misuse_handler ### Description Sets a custom handler for library misuse events. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### crypto_verify_64 Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Compares two 64-byte strings for equality in constant time. Used for verifying MACs or other fixed-size hashes. ```APIDOC ## crypto_verify_64 ### Description Compares two 64-byte strings for equality in constant time. ### Method N/A (Function call) ### Parameters - **s1** (bytes) - Required - The first 64-byte string. - **s2** (bytes) - Required - The second 64-byte string. ### Response - **result** (integer) - Returns 0 if the strings are equal, non-zero otherwise. ``` -------------------------------- ### TurboShake Functions Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Reference implementations for the TurboShake hash function. ```APIDOC ## turboshake128_ref ### Description Performs a single round of TurboShake128. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake128_ref_init ### Description Initializes the TurboShake128 state. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake128_ref_init_with_domain ### Description Initializes the TurboShake128 state with a domain separation value. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake128_ref_update ### Description Updates the TurboShake128 state with input data. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake128_ref_squeeze ### Description Extracts the hash output from the TurboShake128 state. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake256_ref ### Description Performs a single round of TurboShake256. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake256_ref_init ### Description Initializes the TurboShake256 state. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake256_ref_init_with_domain ### Description Initializes the TurboShake256 state with a domain separation value. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake256_ref_update ### Description Updates the TurboShake256 state with input data. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## turboshake256_ref_squeeze ### Description Extracts the hash output from the TurboShake256 state. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### SoftAES Functions Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Reference implementations for AES block encryption and decryption. ```APIDOC ## softaes_block_encrypt ### Description Encrypts a single block using SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## softaes_block_encryptlast ### Description Encrypts the last block using SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## softaes_block_decrypt ### Description Decrypts a single block using SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## softaes_block_decryptlast ### Description Decrypts the last block using SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## softaes_expand_key128 ### Description Expands a 128-bit key for SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## softaes_expand_key256 ### Description Expands a 256-bit key for SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## softaes_inv_mix_columns ### Description Performs the inverse MixColumns operation for SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## softaes_invert_key_schedule128 ### Description Inverts the key schedule for 128-bit SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## softaes_invert_key_schedule256 ### Description Inverts the key schedule for 256-bit SoftAES. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### crypto_sign_ed25519ph_init Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Initializes the state for Ed25519ph (prehash) signing or verification. This prepares the hashing context for processing message data. ```APIDOC ## crypto_sign_ed25519ph_init ### Description Initializes the state for Ed25519ph (prehash) operations. ### Method N/A (Function call) ### Parameters None ### Response - **state** (pointer) - An initialized state for the hashing context. ``` -------------------------------- ### SHA3-256 Hashing Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Provides functions for initializing, updating, and finalizing SHA3-256 hash computations. It also includes constants for state size and output size. ```APIDOC ## crypto_hash_sha3256_init ### Description Initializes a SHA3-256 hashing state. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3256_statebytes ### Description Returns the size of the SHA3-256 hashing state in bytes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3256_update ### Description Updates the SHA3-256 hashing state with new input data. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3256 ### Description Computes the SHA3-256 hash of the input message. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3256_bytes ### Description Returns the size of the SHA3-256 hash output in bytes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3256_final ### Description Finalizes the SHA3-256 hash computation and returns the hash value. ### Method N/A (Function call) ### Endpoint N/A ``` -------------------------------- ### crypto_sign_open Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Verifies a signature and opens a signed message. If the signature is valid, the original message is returned. ```APIDOC ## crypto_sign_open ### Description Verifies a signature and returns the original message if valid. ### Method N/A (Function call) ### Parameters - **signed_message** (bytes) - Required - The signed message, including the signature. - **public_key** (bytes) - Required - The public key of the signer. ### Response - **message** (bytes) - The original message if the signature is valid. - **error** - An error indicator if the signature is invalid. ``` -------------------------------- ### crypto_verify_64_bytes Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Returns the size in bytes for crypto_verify_64. ```APIDOC ## crypto_verify_64_bytes ### Description Returns the fixed size in bytes for the crypto_verify_64 function. ### Method N/A (Function call) ### Response - **size** (integer) - The size, which is 64. ``` -------------------------------- ### SHA-256 Hashing Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Provides functions for initializing, updating, and finalizing SHA-256 hash computations. It also includes constants for state size and output size. ```APIDOC ## crypto_hash_sha256_init ### Description Initializes a SHA-256 hashing state. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha256_statebytes ### Description Returns the size of the SHA-256 hashing state in bytes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha256_update ### Description Updates the SHA-256 hashing state with new input data. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha256 ### Description Computes the SHA-256 hash of the input message. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha256_bytes ### Description Returns the size of the SHA-256 hash output in bytes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha256_final ### Description Finalizes the SHA-256 hash computation and returns the hash value. ### Method N/A (Function call) ### Endpoint N/A ``` -------------------------------- ### crypto_verify_32 Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Compares two 32-byte strings for equality in constant time. Used for verifying MACs or other fixed-size hashes. ```APIDOC ## crypto_verify_32 ### Description Compares two 32-byte strings for equality in constant time. ### Method N/A (Function call) ### Parameters - **s1** (bytes) - Required - The first 32-byte string. - **s2** (bytes) - Required - The second 32-byte string. ### Response - **result** (integer) - Returns 0 if the strings are equal, non-zero otherwise. ``` -------------------------------- ### crypto_verify_16 Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Compares two 16-byte strings for equality in constant time. Used for verifying MACs or other fixed-size hashes. ```APIDOC ## crypto_verify_16 ### Description Compares two 16-byte strings for equality in constant time. ### Method N/A (Function call) ### Parameters - **s1** (bytes) - Required - The first 16-byte string. - **s2** (bytes) - Required - The second 16-byte string. ### Response - **result** (integer) - Returns 0 if the strings are equal, non-zero otherwise. ``` -------------------------------- ### Version and Information Functions Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Functions to retrieve library version information and check for critical sections. ```APIDOC ## sodium_library_version_major ### Description Returns the major version number of the libsodium library. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_library_version_minor ### Description Returns the minor version number of the libsodium library. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_version_string ### Description Returns a string representing the libsodium library version. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_crit_enter ### Description Enters a critical section, disabling interrupts. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_crit_leave ### Description Leaves a critical section, re-enabling interrupts. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### SHA3-512 Hashing Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Provides functions for initializing, updating, and finalizing SHA3-512 hash computations. It also includes constants for state size and output size. ```APIDOC ## crypto_hash_sha3512_init ### Description Initializes a SHA3-512 hashing state. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3512_statebytes ### Description Returns the size of the SHA3-512 hashing state in bytes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3512_update ### Description Updates the SHA3-512 hashing state with new input data. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3512 ### Description Computes the SHA3-512 hash of the input message. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3512_bytes ### Description Returns the size of the SHA3-512 hash output in bytes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha3512_final ### Description Finalizes the SHA3-512 hash computation and returns the hash value. ### Method N/A (Function call) ### Endpoint N/A ``` -------------------------------- ### X-Wing KEM Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Provides functions for the X-Wing KEM, including key generation, encapsulation, decapsulation, and constants for ciphertext, public key, secret key, and shared secret sizes. ```APIDOC ## crypto_kem_xwing_ciphertextbytes ### Description Size of the ciphertext in bytes for X-Wing KEM. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_dec ### Description Decrypts a ciphertext to recover the shared secret using X-Wing KEM. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_enc ### Description Encapsulates a shared secret into a ciphertext using X-Wing KEM. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_enc_deterministic ### Description Encapsulates a shared secret into a ciphertext deterministically using X-Wing KEM. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_keypair ### Description Generates a public and secret key pair for X-Wing KEM. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_publickeybytes ### Description Size of the public key in bytes for X-Wing KEM. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_secretkeybytes ### Description Size of the secret key in bytes for X-Wing KEM. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_seed_keypair ### Description Generates a public and secret key pair for X-Wing KEM using a seed. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_seedbytes ### Description Size of the seed in bytes for X-Wing KEM key generation. ### Method N/A (Function call) ### Endpoint N/A ## crypto_kem_xwing_sharedsecretbytes ### Description Size of the shared secret in bytes for X-Wing KEM. ### Method N/A (Function call) ### Endpoint N/A ``` -------------------------------- ### crypto_verify_32_bytes Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Returns the size in bytes for crypto_verify_32. ```APIDOC ## crypto_verify_32_bytes ### Description Returns the fixed size in bytes for the crypto_verify_32 function. ### Method N/A (Function call) ### Response - **size** (integer) - The size, which is 32. ``` -------------------------------- ### Password Hashing (pwhash) Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Provides functions for secure password hashing using Argon2i and Argon2id algorithms. Includes constants for algorithm variants, memory and operation limits, and password/salt sizes. ```APIDOC ## crypto_pwhash ### Description Hashes a password using the default pwhash algorithm. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_alg_argon2i13 ### Description Identifier for the Argon2i algorithm with 13 passes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_alg_argon2id13 ### Description Identifier for the Argon2id algorithm with 13 passes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_alg_default ### Description Identifier for the default pwhash algorithm. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i ### Description Hashes a password using the Argon2i algorithm. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_alg_argon2i13 ### Description Identifier for the Argon2i algorithm with 13 passes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_bytes_max ### Description Maximum number of bytes for the output hash of Argon2i. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_bytes_min ### Description Minimum number of bytes for the output hash of Argon2i. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_memlimit_interactive ### Description Recommended memory limit for interactive Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_memlimit_max ### Description Maximum memory limit for Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_memlimit_min ### Description Minimum memory limit for Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_memlimit_moderate ### Description Recommended memory limit for moderate Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_memlimit_sensitive ### Description Recommended memory limit for sensitive Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_opslimit_interactive ### Description Recommended operations limit for interactive Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_opslimit_max ### Description Maximum operations limit for Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_opslimit_min ### Description Minimum operations limit for Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_opslimit_moderate ### Description Recommended operations limit for moderate Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_opslimit_sensitive ### Description Recommended operations limit for sensitive Argon2i hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_passwd_max ### Description Maximum length of the password in bytes for Argon2i. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_passwd_min ### Description Minimum length of the password in bytes for Argon2i. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_saltbytes ### Description Size of the salt in bytes for Argon2i. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_str ### Description Formats an Argon2i hash into a string. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_str_needs_rehash ### Description Checks if an Argon2i hash string needs to be rehashed with current parameters. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_str_verify ### Description Verifies a password against an Argon2i hash string. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_strbytes ### Description Maximum length of the Argon2i hash string. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2i_strprefix ### Description Prefix of the Argon2i hash string. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id ### Description Hashes a password using the Argon2id algorithm. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_alg_argon2id13 ### Description Identifier for the Argon2id algorithm with 13 passes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_bytes_max ### Description Maximum number of bytes for the output hash of Argon2id. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_bytes_min ### Description Minimum number of bytes for the output hash of Argon2id. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_memlimit_interactive ### Description Recommended memory limit for interactive Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_memlimit_max ### Description Maximum memory limit for Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_memlimit_min ### Description Minimum memory limit for Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_memlimit_moderate ### Description Recommended memory limit for moderate Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_memlimit_sensitive ### Description Recommended memory limit for sensitive Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_opslimit_interactive ### Description Recommended operations limit for interactive Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_opslimit_max ### Description Maximum operations limit for Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_opslimit_min ### Description Minimum operations limit for Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_opslimit_moderate ### Description Recommended operations limit for moderate Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_opslimit_sensitive ### Description Recommended operations limit for sensitive Argon2id hashing. ### Method N/A (Function call) ### Endpoint N/A ## crypto_pwhash_argon2id_passwd_max ### Description Maximum length of the password in bytes for Argon2id. ### Method N/A (Function call) ### Endpoint N/A ``` -------------------------------- ### SHA-512 Hashing Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Provides functions for initializing, updating, and finalizing SHA-512 hash computations. It also includes constants for state size and output size. ```APIDOC ## crypto_hash_sha512_init ### Description Initializes a SHA-512 hashing state. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha512_statebytes ### Description Returns the size of the SHA-512 hashing state in bytes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha512_update ### Description Updates the SHA-512 hashing state with new input data. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha512 ### Description Computes the SHA-512 hash of the input message. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha512_bytes ### Description Returns the size of the SHA-512 hash output in bytes. ### Method N/A (Function call) ### Endpoint N/A ## crypto_hash_sha512_final ### Description Finalizes the SHA-512 hash computation and returns the hash value. ### Method N/A (Function call) ### Endpoint N/A ``` -------------------------------- ### crypto_xof_turboshake128 Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Computes a variable-length output (XOF) using the TurboSHAKE128 algorithm. This is an extendable-output function. ```APIDOC ## crypto_xof_turboshake128 ### Description Computes a variable-length output (XOF) using the TurboSHAKE128 algorithm. ### Method N/A (Function call) ### Parameters - **output** (bytes) - Required - Buffer to store the output. - **output_len** (integer) - Required - The desired length of the output. - **input** (bytes) - Required - The input data. - **input_len** (integer) - Required - The length of the input data. ### Response None ``` -------------------------------- ### crypto_xof_turboshake256 Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Computes a variable-length output (XOF) using the TurboSHAKE256 algorithm. This is an extendable-output function. ```APIDOC ## crypto_xof_turboshake256 ### Description Computes a variable-length output (XOF) using the TurboSHAKE256 algorithm. ### Method N/A (Function call) ### Parameters - **output** (bytes) - Required - Buffer to store the output. - **output_len** (integer) - Required - The desired length of the output. - **input** (bytes) - Required - The input data. - **input_len** (integer) - Required - The length of the input data. ### Response None ``` -------------------------------- ### crypto_xof_shake256 Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Computes a variable-length output (XOF) using the SHAKE256 algorithm. This is a extendable-output function. ```APIDOC ## crypto_xof_shake256 ### Description Computes a variable-length output (XOF) using the SHAKE256 algorithm. ### Method N/A (Function call) ### Parameters - **output** (bytes) - Required - Buffer to store the output. - **output_len** (integer) - Required - The desired length of the output. - **input** (bytes) - Required - The input data. - **input_len** (integer) - Required - The length of the input data. ### Response None ``` -------------------------------- ### crypto_xof_shake128 Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Computes a variable-length output (XOF) using the SHAKE128 algorithm. This is a extendable-output function. ```APIDOC ## crypto_xof_shake128 ### Description Computes a variable-length output (XOF) using the SHAKE128 algorithm. ### Method N/A (Function call) ### Parameters - **output** (bytes) - Required - Buffer to store the output. - **output_len** (integer) - Required - The desired length of the output. - **input** (bytes) - Required - The input data. - **input_len** (integer) - Required - The length of the input data. ### Response None ``` -------------------------------- ### crypto_verify_16_bytes Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Returns the size in bytes for crypto_verify_16. ```APIDOC ## crypto_verify_16_bytes ### Description Returns the fixed size in bytes for the crypto_verify_16 function. ### Method N/A (Function call) ### Response - **size** (integer) - The size, which is 16. ``` -------------------------------- ### Memory Allocation and Protection Functions Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Functions for secure memory allocation, deallocation, locking, and protection. ```APIDOC ## sodium_malloc ### Description Allocates memory securely. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_free ### Description Frees memory allocated by sodium_malloc. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_mlock ### Description Locks memory in RAM to prevent swapping. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_munlock ### Description Unlocks memory, allowing it to be swapped. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_mprotect_noaccess ### Description Sets memory protection to no access. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_mprotect_readonly ### Description Sets memory protection to read-only. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_mprotect_readwrite ### Description Sets memory protection to read-write. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_stackzero ### Description Clears the stack in constant time. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Padding and Unpadding Functions Source: https://github.com/jedisct1/libsodium/blob/master/test/symbols/all-symbols.txt Functions for padding and unpadding data according to specific schemes. ```APIDOC ## sodium_pad ### Description Pads data to a specified block size. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## sodium_unpad ### Description Removes padding from data. ### Method N/A (Function Call) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ```