Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #70

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
32 changes: 32 additions & 0 deletions COPYING
@@ -0,0 +1,32 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Files: *
Copyright: Copyright (c) 2016, Vinnie Monaco
License: BSD-3-clause
Copyright (c) 2016, Vinnie Monaco
All rights reserved.
.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
.
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15 changes: 7 additions & 8 deletions README.md
Expand Up @@ -60,24 +60,24 @@ Notice that the lower bound on the random delay has to be raised when keys are p

How to install `kloak` using apt-get

1\. Download [Whonix's Signing Key]().
1\. Download the APT Signing Key.

```
wget https://www.whonix.org/patrick.asc
wget https://www.whonix.org/keys/derivative.asc
```

Users can [check Whonix Signing Key](https://www.whonix.org/wiki/Whonix_Signing_Key) for better security.
Users can [check the Signing Key](https://www.whonix.org/wiki/Signing_Key) for better security.

2\. Add Whonix's signing key.
2\. Add the APT Signing Key.

```
sudo apt-key --keyring /etc/apt/trusted.gpg.d/whonix.gpg add ~/patrick.asc
sudo cp ~/derivative.asc /usr/share/keyrings/derivative.asc
```

3\. Add Whonix's APT repository.
3\. Add the derivative repository.

```
echo "deb https://deb.whonix.org bullseye main contrib non-free" | sudo tee /etc/apt/sources.list.d/whonix.list
echo "deb [signed-by=/usr/share/keyrings/derivative.asc] https://deb.whonix.org bookworm main contrib non-free" | sudo tee /etc/apt/sources.list.d/derivative.list
```

4\. Update your package lists.
Expand Down Expand Up @@ -105,7 +105,6 @@ Replace `apparmor-profile-torbrowser` with the actual name of this package with

`kloak` requires [donations](https://www.whonix.org/wiki/Donate) to stay alive!


### Troubleshooting

#### Can't open input/output device
Expand Down
11 changes: 11 additions & 0 deletions build.sh
@@ -0,0 +1,11 @@
#!/bin/bash

## For CodeQL autobuild

set -x
set -e

sudo --non-interactive apt-get update --error-on=any
sudo --non-interactive apt-get install --yes libevdev2 libevdev-dev libsodium23 libsodium-dev pkg-config

make
171 changes: 171 additions & 0 deletions changelog.upstream
@@ -1,3 +1,174 @@
commit 1526784d9fdc79f7df0802c7519ce4f29fd0b37c
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Sat Nov 11 14:43:10 2023 -0500

copyright

commit cfd170899bea518f044359f01c4ce9d7f85ca11a
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Fri Nov 10 12:35:12 2023 -0500

CodeQL

commit daafc674bb10a03b7adcbae35015e9297cce6dd5
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Fri Nov 10 12:31:00 2023 -0500

CodeQL

commit f10707f108872ba37673aec8303917d71deec8cd
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Mon Sep 25 11:58:40 2023 -0400

bumped changelog version

commit 196343c1c614c9d35264c43e502c83477d7107e0
Merge: 61c0b09 9cbdf44
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Mon Sep 25 11:56:55 2023 -0400

Merge remote-tracking branch 'vmonaco/master'

commit 9cbdf4484da19eb09653356e59ce42c37cecb523
Merge: 130d81b 2ed1b1f
Author: Vinnie Monaco <vinmonaco@gmail.com>
Date: Sun Sep 24 21:49:52 2023 -0700

Merge pull request #62 from skyzzuu/check_rescue_key_str_not_null

ensure _rescue_keys_str is not null before passing to strncpy to avoid potential null pointer dereference

commit 130d81b6e5f2c892fbd7596eaf1ad1f10911426e
Merge: af79b08 efa47d1
Author: Vinnie Monaco <vinmonaco@gmail.com>
Date: Sun Sep 24 21:47:27 2023 -0700

Merge pull request #63 from vmonaco/dev

update readme

commit 61c0b09452ded9bcbd8476ee3aa103f116bc5330
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Sun Sep 24 11:22:09 2023 -0400

bumped changelog version

commit 2ed1b1f4e1613d5add68e051fcd1d58fd1ef97e4
Author: Everett Gally <egally@protonmail.com>
Date: Sat Sep 23 11:25:33 2023 -0400

ensure _rescue_keys_str is not null before passing to strncpy to avoid potential null pointer dereference

commit c107815a062251cef694a84cf0710a73168e2bcf
Merge: ca5cf50 af79b08
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Tue Sep 19 08:23:59 2023 -0400

Merge remote-tracking branch 'vmonaco/master'

commit efa47d1e0fa7b3cea17491a9520276e408d07569
Merge: f171889 c928a7c
Author: Vinnie Monaco <vinmonaco@gmail.com>
Date: Mon Sep 18 08:43:59 2023 -0700

Merge pull request #55 from skyzzuu/readme_changes

add dependency installation information into readme

commit af79b08ea3dd83b70c5099391ef3e1233b102511
Merge: 8fb85a0 68c3c70
Author: Vinnie Monaco <vinmonaco@gmail.com>
Date: Mon Sep 18 08:43:25 2023 -0700

Merge pull request #53 from adrelanos/indentation-style

improve indentation style

commit 68c3c7063d51afee6bee63c15ab2465d83591442
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Mon Sep 18 08:04:34 2023 -0400

improve indentation style

fixes https://github.com/vmonaco/kloak/issues/52

commit ca5cf502265f24bfd871547739d8b86449d00bc1
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Mon Sep 18 07:23:20 2023 -0400

bumped changelog version

commit f49d6b8d4575f1694fe5038a6639e04dca9d4bfb
Merge: 537dec7 8fb85a0
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Mon Sep 18 07:22:36 2023 -0400

Merge remote-tracking branch 'vmonaco/master'

commit c928a7c52e2fa0b4f2b7e7cf49c94197555fb288
Author: Everett Gally <egally@protonmail.com>
Date: Mon Sep 18 07:16:55 2023 -0400

update debian dependency installation information to install devscripts and then use sudo mk-build-deps --remove --install instead of hardcoding dependencies

commit 8fb85a065a809be2b504075c500cbd1d12c4ecd9
Merge: d343f5e f55cecc
Author: Vinnie Monaco <vinmonaco@gmail.com>
Date: Sun Sep 17 21:16:31 2023 -0700

Merge pull request #57 from skyzzuu/avoid_mem_leak_after_exit

free pfds after exit to avoid memory leak

commit f55ceccf164a7a2705fd6151bad77e6c421cf9e0
Author: Everett Gally <egally@protonmail.com>
Date: Sun Sep 17 19:42:08 2023 -0400

free pfds after while loop in main_loop exits to avoid memory leak after kloak ends

commit b2f3a2aae1b85e22f40868266927773307131d0d
Author: Everett Gally <egally@protonmail.com>
Date: Sun Sep 10 17:13:52 2023 -0400

add dependency installation information into readme

commit 537dec7423af4635f3fa15a730844a57538a8947
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Wed Aug 16 06:51:59 2023 -0400

bumped changelog version

commit cc2e0c39482eafe88c9607c609c790a0266b1837
Merge: 0a1abe0 d343f5e
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Wed Aug 16 06:32:04 2023 -0400

Merge remote-tracking branch 'vmonaco/master'

commit d343f5e41124ff32ee78badeee540dfdea59b8ac
Merge: 2a3a45b f171889
Author: Vinnie Monaco <vinmonaco@gmail.com>
Date: Tue Aug 15 21:57:43 2023 -0700

Merge pull request #38 from vmonaco/dev

Multi-device support and multiple bug fixes

commit f1718890b1620ac6ba42f2e2d1a1c2c84730c8d4
Merge: cda8d74 0a1abe0
Author: Vinnie Monaco <vinmonaco@gmail.com>
Date: Tue Aug 15 21:57:15 2023 -0700

Merge pull request #49 from adrelanos/chatgpt

chatgpt

commit 0a1abe03dd873058cb3f2e83ce97a4ba1ad89ea1
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Tue Aug 15 09:21:16 2023 -0400

bumped changelog version

commit 59056a25d1e14d6d81ee8a9666eda0bc62fe342a
Author: Patrick Schleizer <adrelanos@whonix.org>
Date: Tue Aug 15 09:19:43 2023 -0400
Expand Down
30 changes: 30 additions & 0 deletions debian/changelog
@@ -1,3 +1,33 @@
kloak (0:0.2.49-1) unstable; urgency=medium

* New upstream version (local package).

-- Patrick Schleizer <adrelanos@whonix.org> Sat, 11 Nov 2023 20:30:12 +0000

kloak (0:0.2.48-1) unstable; urgency=medium

* New upstream version (local package).

-- Patrick Schleizer <adrelanos@whonix.org> Mon, 25 Sep 2023 15:58:40 +0000

kloak (0:0.2.47-1) unstable; urgency=medium

* New upstream version (local package).

-- Patrick Schleizer <adrelanos@whonix.org> Sun, 24 Sep 2023 15:22:09 +0000

kloak (0:0.2.46-1) unstable; urgency=medium

* New upstream version (local package).

-- Patrick Schleizer <adrelanos@whonix.org> Mon, 18 Sep 2023 11:23:20 +0000

kloak (0:0.2.45-1) unstable; urgency=medium

* New upstream version (local package).

-- Patrick Schleizer <adrelanos@whonix.org> Wed, 16 Aug 2023 10:51:58 +0000

kloak (0:0.2.44-1) unstable; urgency=medium

* New upstream version (local package).
Expand Down