@simplito/privmx-webendpoint/dist/service/CryptoApi.d.ts

PrivMX Web Endpoint library

/*!
PrivMX Web Endpoint.
Copyright © 2024 Simplito sp. z o.o.

This file is part of the PrivMX Platform (https://privmx.dev).
This software is Licensed under the PrivMX Free License.

See the License for the specific language governing permissions and
limitations under the License.
*/
import { BaseApi } from "./BaseApi";
import { CryptoApiNative } from "../api/CryptoApiNative";
import { BIP39 } from "../Types";
export declare class CryptoApi extends BaseApi {
    private native;
    constructor(native: CryptoApiNative, ptr: number);
    /**
     * Creates a signature of data using given key.
     *
     * @param {Uint8Array} data buffer to sign
     * @param {string} privateKey key used to sign data
     * @returns {Uint8Array} signature
     */
    signData(data: Uint8Array, privateKey: string): Promise<Uint8Array>;
    /**
     * Validate a signature of data using given key.
     *
     * @param {Uint8Array} data buffer
     * @param {Uint8Array} signature signature of data to verify
     * @param {string} publicKey public ECC key in BASE58DER format used to validate data
     * @return data validation result
     */
    verifySignature(data: Uint8Array, signature: Uint8Array, publicKey: string): Promise<boolean>;
    /**
     * Generates a new private ECC key.
     *
     * @param {string} [randomSeed] optional string used as the base to generate the new key
     * @returns {string} generated ECC key in WIF format
     */
    generatePrivateKey(randomSeed?: string | undefined): Promise<string>;
    /**
     * (deprecated) Generates a new private ECC key from a password using pbkdf2.
     *
     * @param {string} password the password used to generate the new key
     * @param {string} salt random string (additional input for the hashing function)
  
     * @returns {string} generated ECC key in WIF format
     */
    derivePrivateKey(password: string, salt: string): Promise<string>;
    /**
     * Generates a new private ECC key from a password using pbkdf2.
     *
     * @param {string} password the password used to generate the new key
     * @param {string} salt random string (additional input for the hashing function)
  
     * @returns {string} generated ECC key in WIF format
     */
    derivePrivateKey2(password: string, salt: string): Promise<string>;
    /**
     * Generates a new public ECC key as a pair to an existing private key.
     * @param {string} privateKey private ECC key in WIF format
     * @returns {string} generated ECC key in BASE58DER format
     */
    derivePublicKey(privateKey: string): Promise<string>;
    /**
     * Generates a new symmetric key.
     * @returns {Uint8Array} generated key.
     */
    generateKeySymmetric(): Promise<Uint8Array>;
    /**
     * Encrypts buffer with a given key using AES.
     *
     * @param {Uint8Array} data buffer to encrypt
     * @param {Uint8Array} symmetricKey key used to encrypt data
     * @returns {Uint8Array} encrypted data buffer
     */
    encryptDataSymmetric(data: Uint8Array, symmetricKey: Uint8Array): Promise<Uint8Array>;
    /**
     * Decrypts buffer with a given key using AES.
     *
     * @param {Uint8Array} data buffer to decrypt
     * @param {Uint8Array} symmetricKey key used to decrypt data
     * @returns {Uint8Array} plain (decrypted) data buffer
     */
    decryptDataSymmetric(data: Uint8Array, symmetricKey: Uint8Array): Promise<Uint8Array>;
    /**
     * Converts given private key in PEM format to its WIF format.
     *
     * @param {string} pemKey private key to convert
     * @returns {string} private key in WIF format
     */
    convertPEMKeytoWIFKey(pemKey: string): Promise<string>;
    /**
     * Generates ECC key and BIP-39 mnemonic from a password using BIP-39.
     *
     * @param {number} strength size of BIP-39 entropy, must be a multiple of 32
     * @param {string} password the password used to generate the Key
     * @returns {BIP39} object containing ECC Key and associated with it BIP-39 mnemonic and entropy
     */
    generateBip39(strength: number, password?: string): Promise<BIP39>;
    /**
     * Generates ECC key using BIP-39 mnemonic.
     *
     * @param {string} mnemonic the BIP-39 mnemonic used to generate the Key
     * @param {string} password the password used to generate the Key
     * @return BIP39_t object containing ECC Key and associated with it BIP-39 mnemonic and entropy
     */
    fromMnemonic(mnemonic: string, password?: string): Promise<BIP39>;
    /**
     * Generates ECC key using BIP-39 entropy.
     *
     * @param {Uint8Array} entropy the BIP-39 entropy used to generate the Key
     * @param {string} password the password used to generate the Key
     * @return {BIP39} object containing ECC Key and associated with it BIP-39 mnemonic and entropy
     */
    fromEntropy(entropy: Uint8Array, password?: string): Promise<BIP39>;
    /**
     * Converts BIP-39 entropy to mnemonic.
     *
     * @param {Uint8Array} entropy BIP-39 entropy
     * @return {string} BIP-39 mnemonic
     */
    entropyToMnemonic(entropy: Uint8Array): Promise<string>;
    /**
     * Converts BIP-39 mnemonic to entropy.
     *
     * @param {string} mnemonic BIP-39 mnemonic
     * @return {Uint8Array} BIP-39 entropy
     */
    mnemonicToEntropy(mnemonic: string): Promise<Uint8Array>;
    /**
     * Generates a seed used to generate a key using BIP-39 mnemonic with PBKDF2.
     *
     * @param {string} mnemonic BIP-39 mnemonic
     * @param {string} password the password used to generate the seed
     * @return {Uint8Array} generated seed
     */
    mnemonicToSeed(mnemonic: string, password?: string): Promise<Uint8Array>;
}