@aws-crypto/material-management-node

What is @aws-crypto/material-management-node?

@aws-crypto/material-management-node is a package provided by AWS that offers cryptographic materials management for Node.js applications. It is part of the AWS Encryption SDK and is used to handle encryption and decryption operations, manage cryptographic keys, and ensure secure data handling.

What are @aws-crypto/material-management-node's main functionalities?

Keyring Management

This feature allows you to create and manage keyrings, which are collections of cryptographic keys used for encryption and decryption. The code sample demonstrates how to create a KMS keyring using AWS KMS keys.

const { KmsKeyringNode } = require('@aws-crypto/client-node');

const keyring = new KmsKeyringNode({
  generatorKeyId: 'arn:aws:kms:us-west-2:123456789012:key/abcd1234-a123-456a-a12b-a123b4cd56ef',
  keyIds: ['arn:aws:kms:us-west-2:123456789012:key/abcd1234-a123-456a-a12b-a123b4cd56ef']
});

Encryption

This feature enables you to encrypt data using the specified keyring. The code sample shows how to encrypt a plaintext string using the keyring created earlier.

const { encrypt } = require('@aws-crypto/client-node');

const plaintext = 'Hello, World!';
const { result } = await encrypt(keyring, plaintext);
console.log(result);

Decryption

This feature allows you to decrypt data that was previously encrypted using a keyring. The code sample demonstrates how to decrypt a ciphertext string using the keyring.

const { decrypt } = require('@aws-crypto/client-node');

const ciphertext = '...'; // Encrypted data
const { plaintext, messageHeader } = await decrypt(keyring, ciphertext);
console.log(plaintext.toString());

Other packages similar to @aws-crypto/material-management-node

node-forge

node-forge is a JavaScript library that provides a wide range of cryptographic functionalities, including key generation, encryption, decryption, and digital signatures. Unlike @aws-crypto/material-management-node, node-forge is not specifically tied to AWS services and offers more general-purpose cryptographic tools.

crypto-js

crypto-js is a popular library for cryptographic operations in JavaScript. It provides a variety of algorithms for hashing, encryption, and decryption. While it offers similar functionalities to @aws-crypto/material-management-node, it does not provide integrated key management services like AWS KMS.

jose

jose is a library for JavaScript Object Signing and Encryption (JOSE) standards, including JSON Web Tokens (JWT), JSON Web Encryption (JWE), and JSON Web Signatures (JWS). It is more focused on web token-based security, whereas @aws-crypto/material-management-node is more general-purpose and integrated with AWS services.

README

aws-encryption-sdk-javascript

The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the Developer Guide.

This package should only be used as part of the AWS Encryption SDK for Javascript. For more information about the packages in this project and how they can be used together, see the main node package readme

Installing

npm install @aws-crypto/material-management-node

Testing

npm test

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE.txt and NOTICE.txt for more information.