Skip to content

Commit

Permalink
📝 remove acknowledgement part from the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mostafa-kheibary committed Mar 25, 2024
1 parent b04de86 commit 8b9dd2e
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 29 deletions.
20 changes: 1 addition & 19 deletions docs/api/cipher.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,25 +58,7 @@ Resolves a DRSAP handshake packet and validates the sender's public key.
- `packet`: The DRSAP handshake packet.
- `from`: The sender's identifier.

- **Returns:** A Promise that resolves to an acknowledgment packet or `undefined` if validation fails.

#### `createDRSAPAcknowledgment(toId: string): string`

Creates a DRSAP acknowledgment packet for acknowledging receipt of a DRSAP handshake.

- **Parameters:**

- `toId`: The recipient's identifier.

- **Returns:** The DRSAP acknowledgment packet.

#### `resolveDRSAPAcknowledgment(packet: string, from: string): void`

Resolves a DRSAP acknowledgment packet and updates the acknowledgment status in local storage.

- **Parameters:**
- `packet`: The DRSAP acknowledgment packet.
- `from`: The sender's identifier.
- **Returns:** A Promise that resolves to an boolean packet or `undefined` if validation fails.

#### `static validatePublicPem(pem: string): boolean`

Expand Down
10 changes: 0 additions & 10 deletions docs/encryption/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,6 @@ The DRSAP handshake consists of the following components:
5. **To User ID:** The user ID of the recipient.
6. **Public Key PEM:** The public key of the sender in PEM format.

### DRSAP Handshake Acknowledgment Content

![ack](../public/images/Acknowledgement.png)

After receiving a handshake, a client sends an acknowledgment packet containing:

1. **Prefix:** `::ACK::` to identify the message as an acknowledgment.
2. **Separator:** `__` for separating different parts of the acknowledgment.
3. **To User ID:** The user ID of the sender.

## DRSAP Encrypted Message Content

![packet](../public/images/Packet.png)
Expand Down

0 comments on commit 8b9dd2e

Please sign in to comment.