parsec-tool 0.3.0

Parsec Command Line Interface
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# Parsec Tool

This repository contains a tool to communicate with the [Parsec
service](https://github.com/parallaxsecond/parsec) on the command-line.

## Getting started

To compile and list the available commands:

```
$ cargo build
$ cargo run
```

Ping the service:

```
$ cargo run -- ping
```

## Modifying Parsec service endpoint

For demos and to test the Parsec service, you might want to change the Parsec endpoint location. For
that, set the `PARSEC_SERVICE_ENDPOINT` environment variable to correction endpoint.

To set a Unix Domain Socket Listener endpoint at `/tmp/parsec.sock`:

```
$ export PARSEC_SERVICE_ENDPOINT=unix:/tmp/parsec.sock
```

## Modifying logging output

You can set the `RUST_LOG` environment variable to modify the logging outpout. See [the
documentation](https://docs.rs/env_logger/0.8.3/env_logger/index.html) for more information.

## Data format

Unless specified otherwise below, the data format expected by the commands is the same as describe
in the [Parsec
Book](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/index.html). The
`--help` option of commands might give more information about the expected format.

- ECDSA signatures are formatted using the ASN.1 representation `Ecdsa-Sig-Value` described in [RFC
   3279](https://tools.ietf.org/html/rfc3279#section-2.2.3).
- Plaintext data is expected/shown as a UTF-8 string (input data of `sign`, output data of
   `decrypt`).
- Ciphertext data is expected/shown as base 64 (output data of `sign`, input data of `decrypt`).
- Exported public keys are formatted in PEM. RSA keys are encoded in [`RSAPublicKey`](https://tools.ietf.org/html/rfc3279.html#section-2.3.1)
   ASN.1 format. EC keys are encoded in the uncompressed format described in 
   [_SEC 1: Elliptic Curve Cryptography_ ยง2.3.3](https://www.secg.org/sec1-v2.pdf).

# Demo

[![asciicast](https://asciinema.org/a/bGRK4lFZnCq3UZQSWa7vQfuT5.svg)](https://asciinema.org/a/bGRK4lFZnCq3UZQSWa7vQfuT5)

# License

The software is provided under Apache-2.0. Contributions to this project are accepted under the same
license.

# Contributing

Please check the [**Contribution
Guidelines**](https://parallaxsecond.github.io/parsec-book/contributing/index.html) to know more
about the contribution process.

*Copyright 2020 Contributors to the Parsec project.*