@isitayush/cryption NPM

Cryption

yarn add @isitayush/cryption

"Cryption" is a "frontend-only" lightweight, higher level wrapper around the crypto.subtle API. It provides some convenient function's by wrapping low-level Subtle API for an average regular developer like me to understand & use cryptography in daily life project's. It just works. <3

Make sure you're on a HTTPS. In the local-dev environment, you can use local-ssl-proxy to workaround this issue.
This is a browser-only library as it relies on the crypto.subtle API. It won't work in Node.js.

Note: DO NOT USE THIS IN PRODUCTION. This library is still in development and is an alpha stage. If you intend to use it, please do so at your own risk.. I'm not a security expert and I'm not responsible for bringing your prod down. : )

I built this as it's too hard to scroll the docs for my fellow grug developer's. : )

How to use

You can checkout the examples folder for examples. I will add more examples in the future.

Development

yarn install to install all dependencies.
yarn test to run the tests.

Contribution

Please read the CONTRIBUTING.md file for submitting pull requests to the project. If you want to become a maintainer, drop me a message on twitter @is_it_ayush. I will add you as a maintainer. Thank You! I appreciate your help in improving the quality of the documentation and code and the repository. 💙

Roadmap

Status	Description	Currently Supported	Planned
:white_check_mark:	`AES` support.	CBC, CTR, GCM	KW, CMAC
:white_check_mark:	`RSA` support.	OAEP	-
:white_check_mark:	Signature generation and verification.	HMAC, RSASSA-PKCS1-v1_5, ECDSA, RSA-PSS	-
:white_check_mark:	Key derivation	PBKDF2, HKDF, SCRYPT	-
:white_check_mark:	Key generation.	AES, HMAC, RSA	ECDSA, RSA-PSS
🛋️	Got More Ideas? Write an issue.	AES	-

I've plans to make it a lot easier with syntax such as cryption.keys.generate and cryption.encrypt.aes. I'll also add support for more algorithms. Contributions, Suggestions, Tips, Ideas are always heartily welcome. : )