Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cyrildever/crumbl-signer

Easy signer server for the Crumbl platform
https://github.com/cyrildever/crumbl-signer

cryptography data-masking javascript-library signing-trusted storage-api typescript-library

Last synced: 19 days ago
JSON representation

Easy signer server for the Crumbl platform

Host: GitHub
URL: https://github.com/cyrildever/crumbl-signer
Owner: cyrildever
License: other
Created: 2020-09-16T08:09:34.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-10-01T07:24:15.000Z (about 2 months ago)
Last Synced: 2024-10-14T04:08:28.918Z (about 1 month ago)
Topics: cryptography, data-masking, javascript-library, signing-trusted, storage-api, typescript-library
Language: TypeScript
Homepage:
Size: 742 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # crumbl-signer

_Easy signer server for the Crumbl™ platform_

![Github tag (latest by date)](https://img.shields.io/github/v/tag/cyrildever/crumbl-signer)

![npm](https://img.shields.io/npm/dw/crumbl-signer)

![Github last commit](https://img.shields.io/github/last-commit/cyrildever/crumbl-signer)

![Github issues](https://img.shields.io/github/issues/cyrildever/crumbl-signer)

![NPM](https://img.shields.io/npm/l/crumbl-signer)

This application is an easy signer server for the Crumbl™ platform patented by Cyril Dever.

### Usage

1. Either you have set your own MongoDB environment compatible with the `crumbl-signer`'s requirements:

    ```console

    npm i crumbl-signer && npm run compile && npm start

    ```

2. Or you start the Docker container:

    ```console

    git clone https://github.com/cyrildever/crumbl-signer.git && cd crumbl-signer && docker-compose up --build -d

    ```

    You might want to use the `./cleanup` script (or `./cleanup.bat` on Windows) before launching any new Docker session (especially when you've built the NPM project).

Running the application will write a 'crumbl-signer.log' file in the main folder.

#### Production

Change or adapt the following environment variables every time you launch a new session if need be:

* `HTTP_PORT`: the listening HTTP port number (default: 4000);

* `MONGO_DOMAIN`: the MongoDB domain (default: localhost);

* `MONGO_PORT`: the MongoDB port number (default: 27017);

* `MONGO_DB`: the name of the MongoDB database (default: crumbl);

* `MONGO_USERNAME`: the username to access the MongoDB database;

* `MONGO_PASSWORD`: the user password for the MongoDB database;

* `MONGO_COLLECTION`: the name of the collection to use (default: signer);

* `SESSION_SEED`: the hexadecimal string representation of the initial seed.

To generate a new seed for a session, you might want to use the following snippet:

```typescript

import { generateNewSessionSeedPath } from 'crumbl-signer'

const seedPath = generateNewSessionSeedPath()

const sessionSeed = seedPath.seed

console.log(sessionSeed)

```

_NB: Beware that modifying the seed will reset the path leant to it._

### API

The following endpoints are available:

* `GET /lastPubKey`

This endpoint generates the request ID and the signer's last public key to use for the Crumbl™ encryption, eg. `http://localhost:4000/lastPubKey`.

It expects three mandatory HTTP headers (as only registered users should ever call for a new pub key):

 - `X-User-ID`: the ID of the requesting user;

 - `X-User-PubKey`: the public key of the user;

 - `X-User-Secret`: the API secret of the user.

 eg.

 ```http

    GET /lastPubKey HTTP/1.1

    X-User-ID: 123456abcdef123456abcdef123456abcdef123456abcdef

    X-User-PubKey: yourPublicKey

    X-User-Secret: yourAPISecret

    User-Agent: Mozilla/4.0 (compatible; MSIE5.01; Windows NT)

    Host: crumbl.io

    Accept-Language: fr-FR

    Accept-Encoding: gzip, deflate

    Connection: Keep-Alive

  ```

It returns a `412` status code in case these HTTP headers are either missing or wrong.

Otherwise, it returns a `200` status code along with a JSON object in the body respecting the following format:

```json

{

  "encryptionAlgorithm": "ecies",

  "publicKey": "",

  "requestId": ""

}

```

_// TODO Add RSA support._

* `GET /uncrumbs`

This endpoint deciphers the passed crumbled string if the signer had signed one or more of its crumbs.

It expects the 4 following mandatory URI-encoded arguments in the query string: (eg. `http://localhost:4000/uncrumbs?dataId=123456789abcdef&crumbl=9876543210fedcba[...]&verificationHash=9876543210fedcba[...]&token=12345678-90ab-cdef-1234-567890abcdef1`)

  * `dataId`: the data ID related to the crumbled string (in hash format);

  * `crumbl`: the full crumbled string;

  * `verificationHash`: the hash of the original source (not to be confused with the initial hashered source of the crumbled string);

  * `token`: a valid token (in UUID format).

It returns a `200` status code along with the partial uncrumb as a plain text body if deciphered any, `400` if any query argument is missing, or a `404` status code if it's not a signer.

* `POST /crumbl`

This endpoint records the data ID in the local database to keep track of its relation with the public key used when crumbling the data.

Calling it is necessary to make the crumbl decipherable in time.

It expects the request body to be a JSON object respecting the following format:

```json

{

  "dataId": "",

  "requestId": ""

}

```


It returns a `201` status code if everything went well.

As usual, all endpoints return a `500` status code if an error occurred on the server side.

### License

The use of the crumbl-signer server is subject to fees for commercial purpose and to the respect of the [BSD2-Clause-Patent license](LICENSE). \

Please [contact me](mailto:[email protected]) to get further information.



© 2020-2024 Cyril Dever. All rights reserved.