🔐 The Crypto Service Suite

Website • Documentation • Report Bug • Request Feature • Contributing Guidelines

👋 Welcome to the Crypto Service Suite

The Crypto Service Suite is a set of products that delivers common crypto functions.

It is a powerful and centralized cryptographic suite of security tools that solves common application crypto problems, including integration, data encryption, tokenization, transaction authorization, code-signing and key life-cycle management and other security services.

The Crypto Service Suite Suite encompasses four products, Crypto API, Crypto CLI, Crypto Lib and Crypto Server part of the Crypto Service Suite Applications.

Crypto Service Suite code is safe by design, and runs lightning-fast. It is based on OpenPGP.js - a JavaScript implementation of the OpenPGP protocol. It implements RFC4880 and parts of RFC4880bis.

Crypto Service Suite can help you ensure the following:

Authentication of communicating parties,
Integrity of data,
Message Level Encryption for encryption and non-repudiation.,
Privacy of data.

🚀 Crypto API

The Crypto Service Suite APIs are typical REST APIs that use HTTPS requests and responses for common cryptographic operations. Learn more >

❯ Crypto CLI

Crypto CLI is a simple, yet powerful, command line interface that can be used to perform common cryptographic operations from the command prompt or terminal. Learn more >

⚙️ Crypto Lib

Crypto Lib is a powerful intuitive cryptographic JavaScript library that encapsulates common algorithms, functions and provides an interface for low-level cryptographic operations. Learn more >

🖥️ Crypto Server

Crypto Server is a Fastify web server that exposes easy consumable REST APIs to perform low-level cryptographic operations. It is implemented using Node.js and relies on Crypto Lib. Learn more >

Getting Started

👉 Note: » Crypto Service Suite is a Node.js module available through the npm registry. Before installing, download and install Node.js. Node.js 12.20.0 or higher is required.

This allows you to always be on the latest version when we release new builds with automatic upgrades.

Crypto Service Suite helps put you in control of your sensitive information. You’ll find below details on how to get started and how to configure Crypto Service Suite and its products.

🔧 Installation

The first step to using Crypto Service Suite is to download and install the application and other required components.

1️⃣ Install Crypto Service Suite via npm, yarn or pnpm package managers to use Crypto Service Suite with Node.js or the Command Line Interface:

npm i @sebastienrousseau/crypto-service
yarn add @sebastienrousseau/crypto-service
pnpm add @sebastienrousseau/crypto-service

For users who are unable to install the Crypto Service Suite, released builds can be manually downloaded from this repository's Releases page.

You can also clone the main repository to get all source files including build scripts: git clone https://github.com/sebastienrousseau/crypto-service.git

2️⃣ What's included?

Within the download you'll find all the crypto lib source files grouped into the dist folder.

You'll see something like this:

.
├── COPYRIGHT
├── LICENSE
├── Makefile
├── README.md
├── Report.txt
├── index.js
├── package.json
└── src
    ├── bin
    │   └── crypto-service.js
    ├── data
    │   ├── decrypted.txt
    │   └── encrypted.txt
    ├── key
    │   ├── ecc.priv.pgp
    │   ├── ecc.pub.pgp
    │   ├── rsa.priv.pgp
    │   └── rsa.pub.pgp
    ├── lib
    │   ├── README.md
    │   ├── decrypt.js
    │   ├── encrypt.js
    │   ├── generate.js
    │   └── revoke-key.js
    └── server.js

5 directories, 20 files

3️⃣ Set up your app

You can get started with a simple app by running the following in your terminal:


> mkdir my-app
> cd my-app
> yarn add @sebastienrousseau/crypto-service -D
> yarn start

4️⃣ Try it out and let us know what you think!

🔗 Releases

Update your apps to use new features, and test your apps against API changes.

Date	Download	Release Note
May 17, 2022	⬇️ 0.0.1	📝 Crypto Service Suite 0.0.1 Release Note
May 30, 2022	⬇️ 0.0.3	📝 Crypto Service Suite 0.0.3 Release Note

🚥 Semantic Versioning Policy

For transparency into our release cycle and in striving to maintain backward compatibility, crypto-service follows semantic versioning and ESLint's Semantic Versioning Policy.

✅ Changelog

GitHub Releases

📖 Code of Conduct

We are committed to preserving and fostering a diverse, welcoming community. Please read our Code of Conduct.

⭐️ Our Values

We believe perfection must consider everything.
We take our passion beyond code into our daily practices.
We are just obsessed about creating and delivering exceptional solutions.

❤️ Contributing

Thank you for using Crypto Service Suite! If you like the library, it would be great if you can give it a star ⭐ on GitHub.

There are also many ways in which you can participate in this project, for example:

Submit bugs and feature requests, and help us verify as they are checked in,
Review source code changes, and help us improve our code quality,
Review the documentation and make pull requests for anything from typos to additional and new content.

Please read carefully through our Contributing Guidelines for further details on the process for submitting pull requests to us.