Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sah4ez/pspk
Public storage public keys
https://github.com/sah4ez/pspk
android decryption ecdh encryption go help-wanted ios javascript opensource
Last synced: 8 days ago
JSON representation
Public storage public keys
- Host: GitHub
- URL: https://github.com/sah4ez/pspk
- Owner: sah4ez
- License: mit
- Created: 2019-03-16T09:03:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T23:01:25.000Z (11 months ago)
- Last Synced: 2024-06-20T09:15:14.457Z (5 months ago)
- Topics: android, decryption, ecdh, encryption, go, help-wanted, ios, javascript, opensource
- Language: JavaScript
- Homepage: https://sah4ez.github.io/pspk/
- Size: 17.5 MB
- Stars: 5
- Watchers: 4
- Forks: 5
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Public storage public key
Specific storage for sharing public keys of pair ECDH by curve25519.
Service provide HTTP API for save and read a 32-bytes key with human-readable name (aka. alias).
This service solve problem for persistent saving public key and send to recipient through open communication channel.
### Features
- [x] save public key with name
- [x] load public key by name
- [x] share some encrypted data via one-time link
- [ ] support other elliptic curve cryptography algorithms
- [ ] ephemeral encryption via API method (generate ephemeral private key on server, ecnrypt by public key and return link to data)
- [x] signature and verification
- [ ] verification of signature by link
- [x] QR codes
- [ ] simple cli tool (WIP)
- [x] simple web-application. See: https://freecontent.space
- [ ] simple iOS client (thanks: [l-vitaly](https://github.com/l-vitaly) for [library for ios](https://github.com/l-vitaly/pspk-ios))
- [ ] simple android client
- [x] local http server to pspk API
- [ ] sdk for mobile clients
## Model
You should use this model:
```json
{
"name":"Some Name",
"key":"base64=="
}
```
where:
- `name` - string with length more that 1000 signs
- `key` - encodeted to base64 32-bytes public key
## Request
Save public key:
```bash
curl -X POST "https://pspk.now.sh" -d '{"name":"Some.Name","key":"E7+TL112lj1GmJRHf9jT5MZJDgYIhUbtBLc4/ZFMZ5c="}'
{"access":true,"msg":"added"}
```
Read public key:
```bash
curl -X POST "https://pspk.now.sh" -d '{"name":"Some.Name"}'
{"access":true,"key":"wTaZA5+QeZpby33W2T5uV8TweWaPEZn3clTe5xkmb2M="}
```
### API
GET:
- get all keys in json array `GET /?output=json-array&limit=500&last_key=&last_key=5c93d5b8149588f7c7638546`
response:
```json
[
{"id":"5c952b5e149588f7c777c7b6","name":"x1","key":"wTaZA5+QeZpby33W2T5uV8TweWaPEZn3clTe5xkmb2M="},
{"id":"5c952b62149588f7c777ca52","name":"x2","key":"ApYM2UsdUxFas5AF16W605950ke2iXPd5sDhg287xnM="}
]
```
- get data by link `GET /?link=5d06a65da5cdb90006989577` response:
```json
{"data":"123"}
```
- get by full name `GET /?name_key=alice` response
```
[{"id":"5c9bd58b149588f7c71bce91","name":"alice","key":"E7+TL112lj1GmJRHf9jT5MZJDgYIhUbtBLc4/ZFMZ5c="}]
```
- get public key in QR code by name `GET /?qr_code=alice`. Response will contains byes for `image/png`.
- get by regexp `name.*` `GET /?name_regex=Some` response
```
[{"id":"5c9bd58b149588f7c71bce91","name":"Some.Name","key":"E7+TL112lj1GmJRHf9jT5MZJDgYIhUbtBLc4/ZFMZ5c="},...]
```
POST:
- post data `POST /` with body `{"method":"link","data":"base64=="}`, response
```json
{"link":"5d06a65da5cdb90006989577"}
```
- publish key `POST /` with body `{"name":"alice","key":"base64=="}`, response
```json
{"msg":"added"}
```
- get key nmae `POST /` with body `{"name":"alice"}`, response
```json
{"msg":"base64=="}
```
## pspk cli usage
`pspk` - console tool which use API to pspk and implement encryption/decryption for one or several recipients.
```
$ pspk --help
NAME:
pspk - pspk - encrypt you message and send through open communication channel
USAGE:
pspk [global options] command [command options] [arguments...]
VERSION:
0.1.2
DESCRIPTION:
Console tool for encyption/decription data through pspk.now.sh
COMMANDS:
publish, p --name publish
secret, s secret public_name
encrypt, e ecnrypt pub_name some message will encrypt
ephemeral-encrypt, ee ee pub_name some message will encrypt
decrypt, d decrypt pub_name base64==
ephemeral-decrypt, ed ephemeral-decryp pub_name base64==
use-current, uc --name name_pub_key use-current
group, g --name base_name group
start-group, sg start-group groupName [pubName1 pubName2 ...]
finish-group, fg finish-group groupName pubName1 [pubName2 ...]
secret-group, seg secret-group groupName pubName1 [pubName2 ...]
encrypt-group, eg eg message
ephemeral-encrypt-group, eeg Encrypt input message with ephemeral key
decrypt-group, dg dg base64
ephemeral-decrypt-group, edg Decrypt input message with ephemral shared key
sign, s --name sign
verify, v verify
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--name value key name
--help, -h show help
--version, -v print the version
```
### Generation key pair.
Will generation private and public keys and publish public pice to pspk.now.sh.
```bash
pspk --name publish
```
### Encryption some text message.
Will encryption message through your private key and public key name from pspk.now.sh.
```bash
pspk --name encrypt
```
Or encryption with ephemral key
```bash
pspk ephemeral-encrypt
```
Also encrypt commands have a `--link` boolean flag for uploading encrypted data to server.
And generation link 24hrs for access data.
```bash
pspk ephemeral-encrypt --link
```
Output:
```bash
base64ofencpryteddata==
https://pspk.now.sh/?link=5d07c5264f818b00069f5dda
```
Get data by this link return json:
```json
{"data":"MmeSOsti98jaancR+qsbNtpL6nwPtov2p9U5diP7ahbSAhkwsYbgYMRAHMbO/gry"}
```
where data contains encrypted data.
### Decription some text message.
Will decription message through your private key and public key name from pspk.now.sh.
```bash
pspk --name decrypt
```
Or decription with ephemral key
```bash
pspk --name ephemeral-decrypt
```
Also decrypt commands have a `--link ` string flag for downloading ecnrypted data from server.
Example:
```bash
pspk --name ephemeral-decrypt --link https://pspk.now.sh/?link=5d07c5264f818b00069f5dda
```
### Group encryption exchange
For encryption/decryption need generate shared secret in group.
Use this algorithm (CLIQUES) [IV.A](https://pdfs.semanticscholar.org/dc45/970a9c43aaff17295c3769fdd0af9bded855.pdf)
1. *Creat group*.
Create prime base point for group `base` and publish to pspk.now.sh
```
pspk --name base group
```
2. Decide number of members in group and select order for generation secret.
As example Alice, Bob, Carol and Daron want creage shared secret in group `base`.
```bash
pspk --name alice start-group base
pspk --name bob start-group base alice
pspk --name carol start-group base bob alice
```
The last members finish generate intermediate secrets.
```bash
pspk --name daron finish-group base carol bob alice
```
Members can start generate shared secret keys via intermediate keys.
```bash
pspk --name daron secret-group base carol bob alice
pspk --name carol secret-group base daron bob alice
pspk --name bob secret-group base daron carol alice
pspk --name alice secret-group base daron carol bob
```
3. *Encryption* Encrypt some messages for `base` group members
```bash
pspk --name alice ephemeral-encrypt-group base Super secret message
```
4. *Decription* Decrypt the message from member's `base` group
```bash
pspk --name bob ephemeral-decryp-group base base64
```
**NOTE** All intermediate secrets would saved in pspk storage!
## pspk signature and verification
You can sign text message or output with pspk and you private key:
```bash
pspk --name bob sign Hello Alice!
osnfKYmhRNQx7/f3rcpA9jV0T6i/z/+XwyNFcSTGW7QKtJaBzRlbnf7Prg7Q5Hj90rfN2++CKY21IfPcIcAsAQ==
# now Alice can check signature of bob
pspk sign bob osnfKYmhRNQx7/f3rcpA9jV0T6i/z/+XwyNFcSTGW7QKtJaBzRlbnf7Prg7Q5Hj90rfN2++CKY21IfPcIcAsAQ== Hello Alice!
Signature osnfKYmhRNQx7/f3rcpA9jV0T6i/z/+XwyNFcSTGW7QKtJaBzRlbnf7Prg7Q5Hj90rfN2++CKY21IfPcIcAsAQ== is valid.
```
or file:
```bash
pspk --name bob sign --file ./bin/pspk
osnfKYmhRNQx7/f3rcpA9jV0T6i/z/+XwyNFcSTGW7QKtJaBzRlbnf7Prg7Q5Hj90rfN2++CKY21IfPcIcAsAQ==
# now Alice can check signature of bob
pspk sign bob osnfKYmhRNQx7/f3rcpA9jV0T6i/z/+XwyNFcSTGW7QKtJaBzRlbnf7Prg7Q5Hj90rfN2++CKY21IfPcIcAsAQ== --file ./bin/pspk
Signature osnfKYmhRNQx7/f3rcpA9jV0T6i/z/+XwyNFcSTGW7QKtJaBzRlbnf7Prg7Q5Hj90rfN2++CKY21IfPcIcAsAQ== is valid.
```
## pspk config
pspk use `$XDG_CONFIG_HOME` for saving configuration or default value `$HOME/.config/pspk`
Use `config.json` file for saving configuration:
```
{"current_name":"name"}
```
Also pspk use `$XDG_DATA_HOME` for saving appication data ro default value `$HOME/.local/share/pspk`