@akanass/rx-crypto

Rx-Crypto

Crypto library provides some functions for security features like AES key, Key pair, PKCS12, RSA key, Certificate, JWT and more.

We use existing node modules to provide these functions: NodeRSA, PEM, JWT and RandomString but we add Observable feature for asynchronous and stream processes.

All most important crypto features in only one library.

Table of contents

• Using rx-crypto library
  • Yarn or NPM it in your package.json
  • Use it anywhere
• API in Detail
• Contributing
• Change History
• License

Using rx-crypto library

yarn or npm it in your package.json

$ npm install --save @akanass/rx-crypto rxjs

or

$ yarn add @akanass/rx-crypto rxjs

"dependencies": {
    "@akanass/rx-crypto": "^2.2.0",
    "rxjs": "^7.4.0",
    //...
}
//...

use it anywhere

You can use AES, Hash, PEM, RandomString, JWT and RSA anywhere in your own library or script.

import { RSA, NodeRSA } from '@akanass/rx-crypto';

const rsa: RSA = new RSA();
rsa.createKey().subscribe(
    (k: NodeRSA) => console.log(k), // Show NodeRSA instance in console
    e => console.error(e) // Show error in console
);

Back to top

API in Detail

We implemented some services and to see their details go to documentation folder:

• ./documentation/AES.md
• ./documentation/Hash.md
• ./documentation/JWT.md
• ./documentation/PEM.md
• ./documentation/RandomString.md
• ./documentation/RSA.md

Back to top

Contributing

To set up your development environment:

• clone the repo to your workspace,
• in the shell cd to the main folder,
• hit npm or yarn install,
• run npm or yarn run test.
  • It will lint the code and execute all tests.
  • The test coverage report can be viewed from ./coverage/lcov-report/index.html.

Back to top

Change History

• v2.2.0 (2021-10-08)
  • Update packages' versions
  • Latest rxjs version 7.4.0
• v2.1.0 (2021-10-05)
  • Update packages' versions
  • Latest rxjs version 7.3.1
  • Update operators to match with latest rxjs version
  • Update tests
• v2.0.0 (2021-06-07)
  • Update packages' versions
  • Latest rxjs version 7.1.0
• v1.1.0 (2021-01-31)
  • Update packages' versions
  • Fix tests
  • Fix tslint
• v1.0.0 (2019-08-27)
  • Implementation of library with AES, Hash, JWT, PEM, RandomString and RSA
  • Implementation of Observable's operators for AES and RSA features.
  • Related tests.
  • Documentation.

License

Copyright (c) 2021 Nicolas Jessel Licensed under the MIT license.

Back to top