Class XChaCha20Poly1305

Converts a raw private key in bytes to its corresponding JSON Web Key (JWK) format.

Remarks

This method takes a symmetric key represented as a byte array (Uint8Array) and converts it into a JWK object for use with the XChaCha20-Poly1305 algorithm. The process involves encoding the key into base64url format and setting the appropriate JWK parameters.

The resulting JWK object includes the following properties:

• kty: Key Type, set to 'oct' for Octet Sequence (representing a symmetric key).
• k: The symmetric key, base64url-encoded.
• kid: Key ID, generated based on the JWK thumbprint.

Example

const privateKeyBytes = new Uint8Array([...]); // Replace with actual symmetric key bytes
const privateKey = await XChaCha20Poly1305.bytesToPrivateKey({ privateKeyBytes });
Copy

Decrypts the provided data using XChaCha20-Poly1305.

Remarks

This method performs XChaCha20-Poly1305 decryption on the given encrypted data using the specified key, nonce, and authentication tag. It supports optional additional authenticated data (AAD) for enhanced security. The nonce must be 24 bytes long, consistent with XChaCha20's specifications.

Example

const encryptedData = new Uint8Array([...]); // Encrypted data
const nonce = new Uint8Array(24); // 24-byte nonce
const additionalData = new Uint8Array([...]); // Optional AAD
const key = { ... }; // A Jwk object representing the XChaCha20-Poly1305 key
const decryptedData = await XChaCha20Poly1305.decrypt({
  data: encryptedData,
  nonce,
  additionalData,
  key
});
Copy

Encrypts the provided data using XChaCha20-Poly1305.

Remarks

This method performs XChaCha20-Poly1305 encryption on the given data using the specified key and nonce. It supports optional additional authenticated data (AAD) for enhanced security. The nonce must be 24 bytes long, as per XChaCha20's specifications. The method returns the encrypted data along with an authentication tag as a Uint8Array, ensuring both confidentiality and integrity of the data.

Example

const data = new TextEncoder().encode('Messsage');
const nonce = utils.randomBytes(24); // 24-byte nonce
const additionalData = new TextEncoder().encode('Associated data'); // Optional AAD
const key = { ... }; // A Jwk object representing an XChaCha20-Poly1305 key
const encryptedData = await XChaCha20Poly1305.encrypt({
  data,
  nonce,
  additionalData,
  key
});
Copy

Generates a symmetric key for XChaCha20-Poly1305 in JSON Web Key (JWK) format.

Remarks

This method creates a new symmetric key suitable for use with the XChaCha20-Poly1305 algorithm. The key is generated using cryptographically secure random number generation to ensure its uniqueness and security. The XChaCha20-Poly1305 algorithm requires a 256-bit key (32 bytes), and this method adheres to that specification.

Key components included in the JWK:

• kty: Key Type, set to 'oct' for Octet Sequence.
• k: The symmetric key component, base64url-encoded.
• kid: Key ID, generated based on the JWK thumbprint.

Example

const privateKey = await XChaCha20Poly1305.generateKey();
Copy

Converts a private key from JSON Web Key (JWK) format to a raw byte array (Uint8Array).

This method takes a symmetric key in JWK format and extracts its raw byte representation. It decodes the 'k' parameter of the JWK value, which represents the symmetric key in base64url encoding, into a byte array.

Example

const privateKey = { ... }; // A symmetric key in JWK format
const privateKeyBytes = await XChaCha20Poly1305.privateKeyToBytes({ privateKey });
Copy