"crypto/asymmetricCrypto" | @coast-team/mute-crypto-helper

Index

Functions

Functions

decrypt

decrypt(ciphertext: Uint8Array, encryptionPrivateKey: CryptoKey): Promise<Uint8Array>

- Defined in crypto/asymmetricCrypto.ts:124
decrypt decrypts the given ciphertext.

Parameters
- ciphertext: Uint8Array
- encryptionPrivateKey: CryptoKey
  
  The private key associated to the public key used to encrypt.
Returns Promise<Uint8Array>

encrypt

encrypt(plaintext: Uint8Array, encryptionPublicKey: CryptoKey): Promise<Uint8Array>

- Defined in crypto/asymmetricCrypto.ts:114
encrypt returns the ciphertext of the given plaintext.

Parameters
- plaintext: Uint8Array
- encryptionPublicKey: CryptoKey
  
  The public key used to encrypt.
Returns Promise<Uint8Array>

exportKey

exportKey(key: CryptoKey): Promise<JsonWebKey>

- Defined in crypto/asymmetricCrypto.ts:59
exportKey exports a CryptoKeyPair to an {@link ICryptoKeyPairData}. The CryptoKeyPair should be the same as returned by {@link generateSigningKey} or generateEncryptionKey.

Parameters
- key: CryptoKey
Returns Promise<JsonWebKey>

generateEncryptionKeyPair

generateEncryptionKeyPair(): Promise<CryptoKeyPair>

- Defined in crypto/asymmetricCrypto.ts:47
generateSigningKey generates a cryptoKeyPair with sane defaults to be used for asymmetric encryption purpose.

see

defaultAsymmetricEncryptionParam

Returns Promise<CryptoKeyPair>

generateSigningKeyPair

generateSigningKeyPair(): Promise<CryptoKeyPair>

- Defined in crypto/asymmetricCrypto.ts:34
generateSigningKey generates a cryptoKeyPair with sane defaults to be used for signing purpose.

see

defaultAsymmetricSigningParam

Returns Promise<CryptoKeyPair>

importKey

importKey(key: JsonWebKey): Promise<CryptoKey>

- Defined in crypto/asymmetricCrypto.ts:67
importKey imports an ICryptoKeyPairData to a CryptoKeyPair. The ICryptoKeyPairData should be the same as returned by exportKey.

Parameters
- key: JsonWebKey
Returns Promise<CryptoKey>

sign

sign(plaintext: Uint8Array, signingPrivateKey: CryptoKey): Promise<Uint8Array>

- Defined in crypto/asymmetricCrypto.ts:95
sign returns the signature of the given plaintext

Parameters
- plaintext: Uint8Array
- signingPrivateKey: CryptoKey
  
  The private key used to sign.
Returns Promise<Uint8Array>

verifySignature

verifySignature(plaintext: Uint8Array, signature: Uint8Array, signingPublicKey: CryptoKey): Promise<boolean>

- Defined in crypto/asymmetricCrypto.ts:105
verifySignature verifies that the given signature and plaintext match.

Parameters
- plaintext: Uint8Array
- signature: Uint8Array
- signingPublicKey: CryptoKey
  
  THe public Key associated with the private key used to sign initially.
Returns Promise<boolean>

Generated using TypeDoc