Skip to content

Commit

Permalink
Updated readme a bit to include cloning instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
nuvious committed Jul 10, 2024
1 parent 0885200 commit 9c21abe
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 9 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ as it is available on this date and time.

## Quickstart

### Clone the repository and initialize submodules

```bash
git clone --recurse-submodules https://github.com/nuvious/QuiCC.git
cd QuiCC
```

### Generate RSA keys for the covert channel

```bash
Expand All @@ -20,8 +27,12 @@ openssl rsa -in server_key.pem -pubout -out server_public_key.pem

### Install Requirements

For the HTTP server and client examples provided by the aioquic library, the
requirements are not included in the package dependencies so we have to install
them manually.

```bash
pip3 install aioquic/ pycryptodome dnslib jinja2 starlette wsproto
pip3 install aioquic/ dnslib jinja2 starlette wsproto
```

### Start the server
Expand All @@ -33,26 +44,26 @@ python http3_cc_server.py \
--cc-private-key server_key.pem
```

### Send a file
## Send a message

```bash
python http3_cc_client.py \
--ca-certs aioquic/tests/pycacert.pem \
--file README.md \
--message "QuiCC can never be detected!" \
--cid-size 8 \
--cc-private-key client_key.pem \
--cc-server-public-key server_public_key.pem \
wss://localhost:4433/ws
wss://localhost:4433/ws
```

## Send a message
### Send a file

```bash
python http3_cc_client.py \
--ca-certs aioquic/tests/pycacert.pem \
--message "QuiCC can never be detected!" \
--file README.md \
--cid-size 8 \
--cc-private-key client_key.pem \
--cc-server-public-key server_public_key.pem \
wss://localhost:4433/ws
```
wss://localhost:4433/ws
```
2 changes: 1 addition & 1 deletion aioquic
Submodule aioquic updated 1 files
+1 −0 pyproject.toml

0 comments on commit 9c21abe

Please sign in to comment.