signify-ts
Version:
Signing at the edge for KERI, ACDC, and KERIA
144 lines (99 loc) • 4.72 kB
Markdown
# TypeScript implementation of Signify
Project Name: signify-ts
[](https://github.com/ellerbrock/typescript-badges/)
[](https://github.com/WebOfTrust/signify-ts/actions/workflows/main.yml)
[](https://codecov.io/gh/WebOfTrust/signify-ts)
[](https://weboftrust.github.io/signify-ts/)
## Signify - KERI Signing at the Edge
Of the five functions in a KERI agent,
1. Key generation
2. Encrypted key storage
3. Event generation
4. Event signing
5. Event Validation
Signify-TS splits off two, key generation and event signing into a TypeScript library to provide "signing at the edge".
It accomplishes this by using [libsodium](https://doc.libsodium.org/) to generate ed25519 key pairs for signing and x25519 key pairs for encrypting the
private keys, next public keys and salts used to generate the private keys. The encrypted private key and salts are then stored on a
remote cloud agent that never has access to the decryption keys. New key pair sets (current and next) will be generated
for inception and rotation events with only the public keys and blake3 hash of the next keys made available to the agent.
The communication protocol between a Signify client and [KERI](https://github.com/WebOfTrust/keri) agent will encode all cryptographic primitives as CESR base64
encoded strings for the initial implementation. Support for binary CESR can be added in the future.
### Environment Setup
The code is built using Typescript and running code locally requires a Mac or Linux OS.
- Install [Node.js](https://nodejs.org)
- Install dependencies:
```bash
npm install
```
Typescript source files needs to be transpiled before running scripts or integration tests
- Build:
```bash
npm run build
```
- ready() must be called before library is useable. Example minimum viable client code.
```javascript
import { randomPasscode, ready, SignifyClient, Tier } from 'signify-ts';
await ready();
const bran = randomPasscode();
const url = 'http://127.0.0.1:3901';
const boot_url = 'http://127.0.0.1:3903';
const actualSignifyClient = new SignifyClient(
url,
bran,
Tier.low,
boot_url
);
console.log(actualSignifyClient);
```
### Unit testing
To run unit tests
```bash
npm test
```
### Integration testing
The integration tests depends on a local instance of KERIA, vLEI-Server and Witness Demo. These are specified in the [Docker Compose](./docker-compose.yaml) file. To start the dependencies, use docker compose:
```bash
docker compose up --wait
```
If successful, it should print someting like this:
```bash
$ docker compose up --wait
[+] Running 4/4
✔ Network signify-ts_default Created 0.0s
✔ Container signify-ts-vlei-server-1 Healthy 5.7s
✔ Container signify-ts-keria-1 Healthy 6.2s
✔ Container signify-ts-witness-demo-1 Healthy 6.2s
```
It is possible to change the keria image by using environment variables. For example, to use weboftrust/keria:0.1.3, do:
```bash
export KERIA_IMAGE_TAG=0.1.3
docker compose pull
docker compose up --wait
```
To use another repository, you can do:
```bash
export KERIA_IMAGE=gleif/keria
docker compose pull
docker compose up --wait
```
**Important!** The integration tests runs on the build output in `dist/` directory. Make sure to run build before running the integration tests.
```bash
npm run build
```
Use the npm script "test:integration" to run all integration tests in sequence:
```bash
npm run test:integration
```
Or, use execute `jest` directly to run a specific integration test, for example:
```bash
npx jest examples/integration-scripts/credentials.test.ts
```
It is also possible to run the tests using local instances of vLEI, Keria, and witness network. Set the environment variable `TEST_ENVIRONMENT` to `local`, e.g:
```
TEST_ENVIRONMENT=local npx jest examples/integration-scripts/credentials.test.ts
```
This changes the discovery urls to use `localhost` instead of the hostnames inside the docker network.
# Diagrams
Account Creation Workflow
