https://github.com/raisinten/aes-crypto-js

Lightweight and convenient AES encryption/decryption library to make it easier to migrate away from the deprecated crypto-js library
https://github.com/raisinten/aes-crypto-js

aes crypto-js

Last synced: about 5 hours ago
JSON representation

Lightweight and convenient AES encryption/decryption library to make it easier to migrate away from the deprecated crypto-js library

• Host: GitHub
• URL: https://github.com/raisinten/aes-crypto-js
• Owner: RaisinTen
• License: mit
• Created: 2024-07-09T11:01:06.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-12T13:33:11.000Z (4 months ago)
• Last Synced: 2024-09-30T16:41:04.660Z (about 1 month ago)
• Topics: aes, crypto-js
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@raisinten/aes-crypto-js
• Size: 18.6 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aes-crypto-js

The `@raisinten/aes-crypto-js` library provides a lightweight and convenient AES encryption/decryption API to make it easier to migrate away from the [deprecated `crypto-js` library](https://github.com/brix/crypto-js).

## Usage

```js

const { encryptAES, decryptAES } = require('@raisinten/aes-crypto-js');

const plainText = 'Hello, world!';

const secret = 'umm, shhh ...';

const encrypted = encryptAES(plainText, secret);

console.log(encrypted);

// U2FsdGVkX18T+lGbQ19d5PT205PrfCiti+f8hlKr/9E=

const decrypted = decryptAES(encrypted, secret);

console.log(decrypted);

// Hello, world!

```

## API

### `encryptAES(plainText, secret)`

- `plainText` (**string**) - The string to be encrypted.

- `secret` (**string**) - The string to be used as the secret for the encryption.

- Returns **string** - The encrypted string in `base64` format.

Encrypts the plaintext using the secret.

### `decryptAES(encrypted, secret)`

- `encrypted` (**string**) - The string to be decrypted.

- `secret` (**string**) - The string to be used as the secret for the decryption.

- Returns **string** - The decrypted string.

Decrypts the encrypted string using the secret.

> [!NOTE]

> The only difference from the AES implementation in the `crypto-js` library is that if there is a lone surrogate in a string, the `crypto-js` library crashes whereas this library replaces it with `U+FFFD`.

## License

MIT