Skip to content

Commit 8b54c0d

Browse files
authored
Update README.md
1 parent e95cd5f commit 8b54c0d

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ This repository serves as a technical demonstration of Signal Protocol implement
2020

2121
- Flutter `>=3.7.2`
2222
- Dart `>=3.7.2`
23-
- A running instance of the Signal Protocol server (for integration tests)
2423

2524
## 🛠️ Installation
2625

@@ -82,25 +81,25 @@ Immutable state management using Freezed, containing:
8281
```
8382
lib/
8483
├── client/
85-
│ ├── signal_client.dart # Signal Protocol implementation
86-
│ └── signal_client.freezed.dart # Generated immutable state
84+
│ ├── signal_client.dart # Signal Protocol implementation
85+
│ └── signal_client.freezed.dart # Generated immutable state
8786
├── common/
8887
│ └── models/
89-
│ ├── message.dart # Message structure
90-
│ └── group_message.dart # Group message support
88+
│ ├── message.dart # Message structure
89+
│ └── group_message.dart # Group message support
9190
├── server/
9291
│ ├── models/
93-
│ │ ├── user_keys.dart # PreKey bundle model
94-
│ │ ├── public_prekey.dart # Public PreKey structure
95-
│ │ └── public_signed_prekey.dart # Signed PreKey structure
96-
│ └── server.dart # Server API client
92+
│ │ ├── user_keys.dart # PreKey bundle model
93+
│ │ ├── public_prekey.dart # Public PreKey structure
94+
│ │ └── public_signed_prekey.dart # Signed PreKey structure
95+
│ └── server.dart # Server API client
9796
└── utils/
98-
└── logger.dart # Logging utility
97+
└── logger.dart # Logging utility
9998
10099
test/
101-
├── signal_protocol_test.dart # Comprehensive test scenarios
102-
├── key_reuse_test.dart # Tests for key reuse prevention
103-
└── multi_device_test.dart # Tests for multi-device support
100+
├── signal_protocol_test.dart # Comprehensive test scenarios
101+
├── key_reuse_test.dart # Tests for key reuse prevention
102+
└── multi_device_test.dart # Tests for multi-device support
104103
```
105104

106105
## 🧪 Understanding the Implementation Through Tests
@@ -168,7 +167,9 @@ flutter test --name "should establish session and exchange messages"
168167
- Validates security against key reuse attacks
169168
- Tests proper key rotation mechanisms
170169

171-
Each test includes comprehensive logging that explains what's happening at each step of the protocol.
170+
Each test includes comprehensive logging that explains what's happening at each step of the protocol. This can also be seen in the test workflow: https://github.com/stdNullPtr/Flutter-Signal-Protocol-PoC/actions
171+
![image](https://github.com/user-attachments/assets/ebf832f5-aa33-473b-b2c2-25abf8f451d3)
172+
172173

173174
## 🔍 Key Components Explained
174175

0 commit comments

Comments
 (0)