Skip to content

Commit ca4fd11

Browse files
committed
Update readme
1 parent 750c172 commit ca4fd11

File tree

2 files changed

+31
-4
lines changed

2 files changed

+31
-4
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
VERSION=0.1.3
1+
VERSION=0.1.4
22
NAME=pspk
33
GIT_REV?=$(shell git rev-parse --short HEAD)
44
LDFLAGS=-ldflags "-X main.Version=$(VERSION) -X main.Hash=$(GIT_REV) -X main.BuildDate=$(BUILD_DATE)"

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,23 +105,50 @@ pspk --name <NAME_YOUR_KEY> publish
105105
### Encryption some text message.
106106
Will encryption message through your private key and public key name from pspk.now.sh.
107107
```bash
108-
pspk --name <NAME_YOUR_KEY> encrypt <PUBLIC_PART> <SOME_MESSAGE_WITH_SPACES>
108+
pspk --name <NAME_YOUR_KEY> encrypt <PUBLIC_PART_NAME> <SOME_MESSAGE_WITH_SPACES>
109109
```
110110
Or encryption with ephemral key
111111
```bash
112-
pspk ephemeral-encrypt <PUBLIC_PART> <SOME_MESSAGE_WITH_SPACES>
112+
pspk ephemeral-encrypt <PUBLIC_PART_NAME> <SOME_MESSAGE_WITH_SPACES>
113113
```
114114

115+
Also encrypt commands have a `--link` boolean flag for uploading encrypted data to server.
116+
And generation link 24hrs for access data.
117+
```bash
118+
pspk ephemeral-encrypt --link <PUBLIC_PART_NAME> <SOME_MESSAGE_WITH_SAPCES>
119+
```
120+
121+
Output:
122+
```bash
123+
base64ofencpryteddata==
124+
https://pspk.now.sh/?link=5d07c5264f818b00069f5dda
125+
```
126+
127+
Get data by this link return json:
128+
```json
129+
{"data":"MmeSOsti98jaancR+qsbNtpL6nwPtov2p9U5diP7ahbSAhkwsYbgYMRAHMbO/gry"}
130+
```
131+
132+
where data contains encrypted data.
133+
134+
115135
### Decription some text message.
116136
Will decription message through your private key and public key name from pspk.now.sh.
117137
```bash
118-
pspk --name <NAME_YOUR_KEY> decrypt <PUBLIC_PART> <SOME_BASE64_WITH_SPACES>
138+
pspk --name <NAME_YOUR_KEY> decrypt <PUBLIC_PART_NAME> <SOME_BASE64_WITH_SPACES>
119139
```
120140
Or decription with ephemral key
121141
```bash
122142
pspk --name <NAME_YOUR_KEY> ephemeral-decrypt <SOME_MESSAGE_WITH_SPACES>
123143
```
124144

145+
Also decrypt commands have a `--link <URL>` string flag for downloading ecnrypted data from server.
146+
147+
Example:
148+
```bash
149+
pspk --name <NAME_YOUR_KEY> ephemeral-decrypt --link https://pspk.now.sh/?link=5d07c5264f818b00069f5dda
150+
```
151+
125152
### Group encryption exchange
126153
For encryption/decryption need generate shared secret in group.
127154
Use this algorithm (CLIQUES) [IV.A](https://pdfs.semanticscholar.org/dc45/970a9c43aaff17295c3769fdd0af9bded855.pdf)

0 commit comments

Comments
 (0)