# oip-keystore

> Keystore for encrypted data blobs, used by OIP-Account

Latest version **2.0.1** (published 2018-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install oip-keystore
pnpm add oip-keystore
yarn add oip-keystore
bun add oip-keystore
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2018-07-03 |
| First published | 2018-07-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 25.2 KB |
| Known vulnerabilities | 0 (+11 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Skylar Young |
| Maintainers | ostlerdev |
| Keywords | oip, oipwg, oip-keystore, keystore, oipmw, oip-wallet, wallet |

## Links

- npm: https://www.npmjs.com/package/oip-keystore
- Repository: https://github.com/oipwg/oip-keystore
- Homepage: https://github.com/oipwg/oip-keystore#readme
- Issues: https://github.com/oipwg/oip-keystore/issues
- npm.io page: https://npm.io/package/oip-keystore

## Dependencies (4)

- [lowdb](https://npm.io/package/lowdb.md) ^1.0.0
- [multer](https://npm.io/package/multer.md) ^1.3.0
- [express](https://npm.io/package/express.md) ^4.16.2
- [body-parser](https://npm.io/package/body-parser.md) ^1.18.2

## Recent versions

- 2.0.1 (latest) — 2018-07-03
- 2.0.0 — 2018-07-03

## README

[![](https://travis-ci.org/oipwg/oip-keystore.svg?branch=master)](https://travis-ci.org/oipwg/oip-keystore)
# OIP Keystore

OIP Keystore is a simple encrypted keystore server. By sharing a "shared_key" it will update the stored encrypted data.

## Table of Contents

- [Installation Instructions](https://github.com/oipwg/oip-keystore#installation-instructions)
- [Getting Started](https://github.com/oipwg/oip-keystore#getting-started)
  - [Running an OIP-Keystore server](https://github.com/oipwg/oip-keystore#running-an-oip-keystore-server)
  - [Running on a different port](https://github.com/oipwg/oip-keystore#running-on-a-different-port)
- [API Methods](https://github.com/oipwg/oip-keystore#api-methods)
  - [Status](https://github.com/oipwg/oip-keystore#status)
  - [Create](https://github.com/oipwg/oip-keystore#create)
  - [Checkload](https://github.com/oipwg/oip-keystore#check-load)
  - [Load](https://github.com/oipwg/oip-keystore#load)
  - [Update](https://github.com/oipwg/oip-keystore#update)
- [License](https://github.com/oipwg/oip-keystore#license)

## Installation Instructions

To install on your server, clone this repo into a local folder.

```bash
$ git clone https://github.com/oipwg/oip-keystore.git
```

After you have cloned it, `cd` into the directory you installed it into and run

```bash
$ npm install
```

After the `npm install` finishes, you can continue onto the [Getting Started]() section.

## Getting Started

### Running an OIP-Keystore server

To run your keystore server, `cd` into the directory you cloned it, and then start it using the following command.

```bash
$ node src/server.js
```

After you run that command you should see it print out that it is running the server

```
Listening on http://127.0.0.1:9196
```

### Running on a different port

To run the OIP-Keystore server on a different port, edit the `config.js` file inside of your cloned `oip-keystore` folder.

## API Methods

### Status

**Description**: Get the current status of the OIP-Keystore server

**URL :** `/`

**Method :** `GET`

**Response:**

 - Success (200):  `{status: "online"}`

### Create

**Description**: Check if a specific Identifier or Email exists on the server

**URL :** `/create`

**Method :** `POST`

**Data Params:** 

- `email` (Optional): The users email that they wish to attach 

```json
{ 
    "email": "email@example.com"
}
```

**Response:**

- Success (200):  

```json
{
    "error": false,
    "identifier": "47cfbad-5f331638-6575c0a-d1d14e3",
    "shared_key": "e712c556495c3918d9ddd0b80ac376ef30b0a55230fb26e3d24d8ef73d2604f712baeb8b4bb2f6e3dd14821c47cd3076",
    "email": "email@example.com"
}
```

- Error (400):

```json
{
    "error": true,
    "type": "ERROR_TYPE",
    "message": "More information about the error"
}
```

### Check Load

**Description**: Check if a specific Identifier or Email exists on the server

**URL :** `/checkload`

**Method :** `POST`

**Data Params:** 

- `identifier`: Should be either the users email, or the identifier generated in `/create`

```javascript
{ 
    "identifier": "email@example.com" || "47cfbad-5f331638-6575c0a-d1d14e3"
}
```

**Response:**

- Success (200):  

```json
{
    "error": false,
    "identifier": "47cfbad-5f331638-6575c0a-d1d14e3",
    "gauth_enabled": false,
    "encryption_settings": {
        "algo": "aes",
        "iterations": 5
    }
}
```

- Error (400):

```json
{
    "error": true,
    "type": "ERROR_TYPE",
    "message": "More information about the error"
}
```

### Load

**Description**: Check if a specific Identifier or Email exists on the server

**URL :** `/load`

**Method :** `POST`

**Data Params:** 

- `identifier`: Should be either the users email, or the identifier generated in `/create`

```javascript
{ 
    "identifier": "email@example.com" || "47cfbad-5f331638-6575c0a-d1d14e3"
}
```

**Response:**

- Success (200):  

```json
{
    "error": false,
    "identifier": "47cfbad-5f331638-6575c0a-d1d14e3",
    "encrypted_data": "encrypted-data-string"
}
  ```

- Error (400):

```json
{
    "error": true,
    "type": "ERROR_TYPE",
    "message": "More information about the error"
}
```

### Update

**Description**: Check if a specific Identifier or Email exists on the server

**URL :** `/update`

**Method :** `POST`

**Data Params:** 

- `identifier`: Should be either the users email, or the identifier generated in `/create`
- `shared_key`: The key generated in `/create` that should be inside the decrypted version of the encrypted_data.
- `encrypted_data`: The Encrypted data you wish to save to the keystore server

```javascript
{ 
    "identifier": "email@example.com" || "47cfbad-5f331638-6575c0a-d1d14e3",
    "shared_key": "e712c556495c3918d9ddd0b80ac376ef30b0a55230fb26e3d24d8ef73d2604f712baeb8b4bb2f6e3dd14821c47cd3076",
    "encrypted_data": "new-encrypted-data-string"
}
```

**Response:**

- Success (200):  

```json
{
    "error": false,
    "identifier": "47cfbad-5f331638-6575c0a-d1d14e3"
}
```

- Error (400):

```json
{
    "error": true,
    "type": "ERROR_TYPE",
    "message": "More information about the error"
}
```

## License
MIT License

Copyright (c) 2018 Open Index Protocol Working Group

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---
_Source: https://npm.io/package/oip-keystore · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._