Skip to content

Commit 649fbb0

Browse files
committed
Updating readme with sequence diagram
1 parent e45321f commit 649fbb0

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,5 +133,23 @@ Xipher uses the following algorithms and libraries to achieve its functionality:
133133
- [XChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) for symmetric encryption.
134134
- [Zlib](https://en.wikipedia.org/wiki/Zlib) for compression.
135135

136+
## Workflow
137+
The following sequence diagram illustrates the workflow of Xipher in encrypting data using a password based public key.
138+
```mermaid
139+
sequenceDiagram
140+
participant RX as Xipher
141+
actor Receiver
142+
actor Sender
143+
participant SX as Xipher
144+
Receiver-->>+RX: Derive public (inputs password)
145+
RX-->>-Receiver: Returns Public Key
146+
Receiver->>Sender: Shares Public Key
147+
Sender-->>+SX: Encrypt data with public key
148+
SX-->>-Sender: Returns ciphertext encrypted with Public Key
149+
Sender->>Receiver: Sends the encrypted ciphertext to the Receiver
150+
Receiver-->>+RX: Decrypt data (inputs ciphertext and password)
151+
RX-->>-Receiver: Returns decrypted data
152+
```
153+
136154
## Disclaimer
137155
This tool/library is provided without any warranties, and there is no guarantee of its stability. Due to the experimental nature of some of its components, it is anticipated that modifications to the code, repository, and API will be made in the future. Caution is advised before incorporating this into a production application. Please [report](https://github.com/shibme/xipher/security/advisories) any identified security issues promptly. Your cooperation in notifying us of such concerns is highly appreciated.

0 commit comments

Comments
 (0)