Dev/git
< Dev
 | Building Non-Qubes-Whonix is not safe at the moment. See this forum post. |
Contents
Branches[edit]
Introduction[edit]
While the project is small adrelanos thinks it is best not to make a too difficult policy.
master[edit]
Adrelanos's progress of work.- Not calling it unstable, because the changes will most likely never make it unstable but it is just not tested if it still builds.
- Branching model, project readme, information, gpg...
stable[edit]
- last released and recommended Whonix version
- ready to include hotfixes
development[edit]
- does currently not exist, since only one adding code
- candidate for next Whonix version
must always build- currently restructuring
- we can make an always building development branch as soon as someone else commits code
untested_adre[edit]
untested_yourname[edit]
perhaps 0.5.x etc. as release branches[edit]
feature branches when it makes sense[edit]
signed git tags[edit]
Releases will be tagged and gpg signed.
temporary git tags[edit]
Will be named like: adretemp1 or 96adretemp
Can get deleted from time to time.
Link to Source Code[edit]
https://github.com/Whonix/Whonix
subscribe to code changes[edit]
git[edit]
Git clone github.
A git specific work flow could be:
git fetch
every (few) day(s) and then git diff(tool), merge, etc.
rss feed notification[edit]
https://github.com/Whonix/Whonix/commits/master.atom
manually in your browser[edit]
Check every now and then https://github.com/Whonix/Whonix/commits/master.
Github Commits Mailing List[edit]
Whonix-commits read only mailing list
(Stay hosted on sourceforge.net. Barely anyone is signed up and it is quite high traffic.)
Twitter[edit]
If you prefer Twitter, use the Secondary Twitter Account for Source Code Commit Notification.
grep Whonix source code[edit]
Get the Signing Key[edit]
This chapter is recommended for better security, but is not strictly required. (See Trust)
gpg --keyserver hkp://ipv4.pool.sks-keyservers.net:80 --recv-keys 916B8D99C38EAF5E8ADC7A2A8D66066A2EEACCDA
It isn't safe to only get the signing key from one source for the download you want to verify. For better security, learn more about the Whonix Signing Key.
Get the Source Code[edit]
Install git and curl.
sudo apt-get update && sudo apt-get install git curl
Get source code including git submodules.
git clone --jobs=4 --recursive https://github.com/Whonix/Whonix
Note: If using an older version of git (from Debian Jessie, Whonix 13, etc), remove --jobs=4.
Remember it is Whonix, not whonix! If prompted for a username for github, you have mistyped the web address.
Shift to the source folder.
cd Whonix
OpenPGP Verify the Source Code[edit]
This chapter is recommended for better security, but is not strictly required.[1]
Retrieve a list of available git tags.
cd ~/Whonix/ && git tag
Verify the chosen tag to build.
## ... Replace with tag you want to build. git verify-tag 14.0.0.9.9-stable
The output should look similar to this.
object 1844108109a5f2f8bddcf2257b9f3675be5cfb22 type commit tag 14.0.0.9.9 tagger Patrick Schleizer <adrelanos@riseup.net> 1392320095 +0000 . gpg: Signature made Thu 13 Feb 2014 07:34:55 PM UTC using RSA key ID 77BB3C48 gpg: Good signature from "Patrick Schleizer <adrelanos@riseup.net>" [ultimate]
| Check the GPG signature timestamp makes sense. For example, if you previously saw a signature from 2018 and now see a signature from 2017, then this might be a targeted rollback (downgrade) or indefinite freeze attack. [2] |
The warning.
gpg: WARNING: This key is not certified with a trusted signature! gpg: There is no indication that the signature belongs to the owner.
Is explained on the Whonix Signing Key page and can be safely ignored.
By convention, git tags should point to signed git commits. [3] (forum discussion) It is advisable to verify the signature of the git commit as well (replace 14.0.0.9.9 with the actual git tag being verified).
git verify-commit 14.0.0.9.9-stable^{commit}
The output should look similar to this.
commit 5aa1c307c943be60e7d2bfa5727fa5ada3a79c4a
gpg: Signature made Sun 07 Dec 2014 01:22:22 AM UTC using RSA key ID 77BB3C48
gpg: Good signature from "Patrick Schleizer <adrelanos@riseup.net>" [ultimate]
Author: Patrick Schleizer <adrelanos@riseup.net>
Date: Sun Dec 7 01:22:22 2014 +0000
.
Choose Version[edit]
Retrieve a list of available git tags.
git tag
Use git checkout to select the preferred version (or git branch) to build.
git checkout 14.0.0.9.9-stable
Replace 14.0.0.9.9 with the actual version chosen for the build: the stable, testers-only or developers version. Common sense is required when choosing the right version number. For example, the latest available version number is not necessarily the most stable or suitable. To learn more about current Whonix versions, follow the Whonix News Blog.
Clean Up and Sanitize[edit]
This step is also important for security.
Retrieve the list of extraneous files and folders. [4]
git clean -ndff
See if the output looks sane; it generally should, unless Whonix source code is modified by advanced users (who understand git better anyhow). If the output looks like the following, everything is fine.
Would remove packages/apparmor-profile-gwenview/ Would remove packages/kde-privacy/
Remove these folders.
git clean -dff
The output should show.
Removing packages/apparmor-profile-gwenview/ Removing packages/kde-privacy/
Be sure to check out the right commit for each git submodule.
git submodule update --init --recursive
Check there are no extraneous files. This is important for security.
git status
The output should show the following:
nothing to commit (working directory clean)
If the directory is not clean, the extra files should be removed first.
grep[edit]
mkdir ~/bin
#!/bin/bash set -x exec \ grep \ --exclude=README.md \ --exclude=GPLv2 \ --exclude=GPLv3 \ --exclude=COPYING \ --exclude=changelog.upstream-old1 \ --exclude-dir=mnt \ --exclude-dir=qubes-src/linux-template-builder/mnt \ --exclude=changelog.upstream \ --exclude-dir=".git" \ --exclude-dir=chroot-debian \ --exclude-dir=chroot-stretch \ --exclude-dir=chroot-jessie "$@"
cd Whonix
mygrep -r grub-pc
Put folder under Git Version Control[edit]
Setup[edit]
Update the package lists.
sudo apt-get update
Install git.
sudo apt-get install git
Unless you want to use git for pushing changes to remotes which you probably won't in a testing VM you can use the following git config without using any real names or pseudonyms. (These are the git suggested defaults. [5])
git config --global user.email "you@example.com"
git config --global user.name "Your Name"
Enable Git Version Control for Folder[edit]
Go to the folder you want to set under git version control.
cd ~
Initialize git version control.
git init
Add all files to git version control.
git add -A
Commit all files to git. [6]
git commit -a -m .
Do changes such as changing KDE settings.
See what changed.
git diff
Goodies[edit]
Optional. Just sharing. Like it or not.
- Bash completion can complete git commands and branch names.
- Colorful git prompt.
apt-get source[edit]
You need to enable deb-src in /etc/apt/sources.list.d/whonix.list!
sudo apt-get update
Hit:1 tor+http://deb.dds6qkxpwdeubwucdiaord2xgbbeyds25rbsgr73tbfpqpt4a6vjwsyd.onion stretch InRelease Hit:2 http://deb.qubes-os.org/r4.0/vm stretch InRelease Ign:3 tor+http://vwakviie2ienjx6t.onion/debian stretch InRelease Hit:4 tor+http://sgvtcaew4bxjd7ln.onion stretch/updates InRelease Hit:5 tor+http://vwakviie2ienjx6t.onion/debian stretch Release Ign:7 http://ftp.us.debian.org/debian stretch InRelease Hit:8 http://security.debian.org stretch/updates InRelease Hit:9 http://ftp.us.debian.org/debian stretch Release Hit:11 http://deb.whonix.org stretch InRelease Reading package lists... Done E: Failed to fetch tor+http://deb.dds6qkxpwdeubwucdiaord2xgbbeyds25rbsgr73tbfpqpt4a6vjwsyd.onion/dists/stretch/InRelease Unable to find expected entry 'contrib/source/Sources' in Release file (Wrong sources.list entry or malformed file) E: Failed to fetch http://deb.whonix.org/dists/stretch/InRelease Unable to find expected entry 'non-free/source/Sources' in Release file (Wrong sources.list entry or malformed file) E: Some index files failed to download. They have been ignored, or old ones used instead.
The following can be ignored:
- "Unable to find expected entry 'contrib/source/Sources'" and
- "Unable to find expected entry 'non-free/source/Sources'"
There is nothing in these repositories. Does not limit functionality in any way. Inconinent message but won't fix since only asked once in 5 years.
apt-get source fully functional.
apt-get source apparmor-profiles-hardened-debian
Reading package lists... Done Picking 'anon-meta-packages' as source package instead of 'apparmor-profiles-hardened-debian' NOTICE: 'anon-meta-packages' packaging is maintained in the 'Git' version control system at: https://github.com/Whonix/anon-meta-packages.git Please use: git clone https://github.com/Whonix/anon-meta-packages.git to retrieve the latest (possibly unreleased) updates to the package. Need to get 48.9 kB of source archives. Get:1 tor+http://deb.dds6qkxpwdeubwucdiaord2xgbbeyds25rbsgr73tbfpqpt4a6vjwsyd.onion stretch/main anon-meta-packages 3:7.9-1 (dsc) [5,513 B] Get:2 tor+http://deb.dds6qkxpwdeubwucdiaord2xgbbeyds25rbsgr73tbfpqpt4a6vjwsyd.onion stretch/main anon-meta-packages 3:7.9-1 (tar) [37.8 kB] Get:3 tor+http://deb.dds6qkxpwdeubwucdiaord2xgbbeyds25rbsgr73tbfpqpt4a6vjwsyd.onion stretch/main anon-meta-packages 3:7.9-1 (diff) [5,588 B] Fetched 48.9 kB in 2s (19.4 kB/s) dpkg-source: info: extracting anon-meta-packages in anon-meta-packages-7.9 dpkg-source: info: unpacking anon-meta-packages_7.9.orig.tar.xz dpkg-source: info: unpacking anon-meta-packages_7.9-1.debian.tar.xz
Comments will be deleted after some time. Specifically after comments have been addressed in form of wiki enhancements. See Wiki Comments Policy.
Have you contributed to Whonix? If so, feel free to add your name and highlight what you did on the Whonix authorship page.
This is a wiki. Want to improve this page? Help is welcome and volunteer contributions are happily considered! See Conditions for Contributions to Whonix, then Edit! IP addresses are scrubbed, but editing over Tor is recommended. Edits are held for moderation.
Whonix is a licensee of the Open Invention Network. Unless otherwise noted, the content of this page is copyrighted and licensed under the same Libre Software license as Whonix itself. (Why?)
Whonix is provided by ENCRYPTED SUPPORT LP. See Imprint.
- ↑ See Trust.
- ↑ As defined by TUF: Attacks and Weaknesses:
- ↑ Beginning from git tag 9.6 and above.
- ↑ There is currently a small issue with this process (a limitation of git).
- ↑
git commit -a -m . *** Please tell me who you are. Run git config --global user.email "you@example.com" git config --global user.name "Your Name" to set your account's default identity. Omit --global to set the identity only in this repository. fatal: empty ident name (for <(null)>) not allowed
- ↑
Without any useful commit message.
.is the commit message here.
Enable comment auto-refresher