https://github.com/parallaxsecond/parsec-tool
The Parsec Command Line Interface
https://github.com/parallaxsecond/parsec-tool
Last synced: 2 days ago
JSON representation
The Parsec Command Line Interface
- Host: GitHub
- URL: https://github.com/parallaxsecond/parsec-tool
- Owner: parallaxsecond
- License: apache-2.0
- Created: 2020-07-22T09:24:25.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-31T09:51:56.000Z (12 months ago)
- Last Synced: 2025-04-29T21:48:18.134Z (14 days ago)
- Language: Rust
- Size: 290 KB
- Stars: 13
- Watchers: 6
- Forks: 19
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# 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 encoded in PEM. By default PKCS#8 format
is used for RSA [RFC 3279](https://datatracker.ietf.org/doc/html/rfc3279#section-2.3.1)
and ECC [RFC 5480](https://datatracker.ietf.org/doc/html/rfc5480#section-2)
public keys. With `--pkcs1` parameter RSA keys exported in PKCS#1 format
[RFC 2313](https://datatracker.ietf.org/doc/html/rfc2313#section-7.1).
## SPIFFE based authenticator
To be able to authenticate with the [JWT-SVID
authenticator](https://parallaxsecond.github.io/parsec-book/parsec_service/authenticators.html#jwt-spiffe-verifiable-identity-document-authenticator),
compile this crate with the `spiffe-auth` feature.
# Demo
[](https://asciinema.org/a/RNPjvbgKDlQ0FRFUUKjjNUom6)
`tests/parsec-cli-tests.sh` can be used for end to end Parsec tests using parsec-tool.
# 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.*