Dev/Build Documentation/generic-package

From Kicksecure
< Dev‎ | Build Documentation
Revision as of 13:49, 21 June 2023 by Hans1 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The build process of building any of the packages by Kicksecure developers is always very similar. This very wiki page explain how to build package generic-package. By replacing the name of the package generic-package with the name of any other package you might be interested in building, the other package would be build. You have two options.

Get Build Dependencies[edit]

Update your package lists.

Click = Copy Copied to clipboard! sudo apt update

Install from Debian repository.

Click = Copy Copied to clipboard! sudo apt install build-essential devscripts git

Change Directory to Build Folder[edit]

This chapter is recommended for better usability, but is not strictly required. [1]

Create folder ~/generic-package-build.

Click = Copy Copied to clipboard! mkdir -p ~/generic-package-build

Change directory to folder ~/generic-package-build.

Click = Copy Copied to clipboard! cd ~/generic-package-build

Get the Source Code[edit]

Get the the package's source code.

Click = Copy Copied to clipboard! git clone https://github.com/Kicksecure/generic-package.git

Remember it is Kicksecure, not kicksecure! If you are prompted for a username for github, it means you have mistyped the web address.

Get the Signing Key[edit]

Get the Signing Key

This chapter is recommended for better security, but it is not strictly required. (See Trust)

1. Download Patrick Schleizer (adrelanos) OpenPGP key.

Download Kicksecure OpenPGP Key

Note: If Kicksecure is already being used, this process can be simplified. See the footnotes. [2]

2. Store it as derivative.asc.

3. Import the key.

Click = Copy Copied to clipboard! gpg --import derivative.asc

4. Verify the key using this fingerprint.

Click = Copy Copied to clipboard! gpg --fingerprint 916B8D99C38EAF5E8ADC7A2A8D66066A2EEACCDA

The output should show.

Click = Copy Copied to clipboard! pub rsa4096 2014-01-16 [SC] [expires: 2021-04-17] 916B 8D99 C38E AF5E 8ADC 7A2A 8D66 066A 2EEA CCDA uid [ full ] Patrick Schleizer <adrelanos@whonix.org> sub rsa4096 2014-01-16 [E] [expires: 2021-04-17] sub rsa4096 2014-01-16 [A] [expires: 2021-04-17] sub rsa4096 2014-01-16 [S] [expires: 2021-04-17]

5. This only retrieves the signing key from one source. For better security, learn more about the Kicksecure Signing Key.

Change Directory[edit]

Get into the package's source code folder because later on package build commands using make are expected to be run from the root of the source folder.

Click = Copy Copied to clipboard! cd generic-package

OpenPGP Verify the Source Code[edit]

OpenPGP Verify the Source Code

This chapter is recommended for better security, but is not strictly required.[3]

Retrieve a list of available git tags.

Click = Copy Copied to clipboard! git --no-pager tag

Verify the tag you want to build. Replace it with the tag chosen to build.

Click = Copy Copied to clipboard! git tag -v 0.1

The output should look similar to this. 

object 1844108109a5f2f8bddcf2257b9f3675be5cfb22
type commit
tag {{{version}}}
tagger Patrick Schleizer <adrelanos@whonix.org> 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@whonix.org>" [ultimate]

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 Kicksecure Signing Key page and can be safely ignored.

Choose Version[edit]

1. Retrieve a list of available git tags.

Click = Copy Copied to clipboard! git --no-pager tag

2. Use git checkout to select the preferred version to build.

Note: Replace 0.1 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. Follow the Kicksecure News Blog as it might contain information.

Click = Copy Copied to clipboard! git checkout 0.1

3. Digital signature verification.

Optional. If you choose to perform digital signature verification above, you could verify the currently chosen commit ("HEAD") yet again for extra security.

Click = Copy Copied to clipboard! git verify-commit HEAD

4. Done.

Version selection has been completed.

Build the Package[edit]

Install build dependencies.

Click = Copy Copied to clipboard! sudo mk-build-deps --remove --install

If that did not work, have a look in debian/control file and manually install all packages listed under Build-Depends and Depends.

Build the package without signing it (not required for personal use) and install it.

Click = Copy Copied to clipboard! dpkg-buildpackage -b

Build Result[edit]

When a package is build using dpkg-buildpackage the resulting packages will be created in the parent folder. I.e. in this case in the ~/generic-package-build folder.

Click = Copy Copied to clipboard! ls ../

Should show something like this.

generic-package generic-package0.1-1_amd64.buildinfo generic-package0.1-1_amd64.changes

Install the Package[edit]

The package can be found in the parent folder.

Click = Copy Copied to clipboard! sudo dpkg -i ../generic-package*.deb

Clean Up[edit]

Delete temporary files debhelper files in package source folder as well as debhelper artifacts (.deb file etc.) in parent folder.

1) Show extraneous (temporary files debhelper) files.

Click = Copy Copied to clipboard! git clean -ndff

2) NOTE: Read above output carefully if you added files of your own files to that folder.

If that looks good, actually remove.

Click = Copy Copied to clipboard! git clean -dff

3) Delete debhelper artifacts (.deb file etc.) in parent folder.

TODO: document

Footnotes[edit]

  1. ↑ When a package is build using dpkg-buildpackage the resulting packages will be created in the parent folder. It's better for usability if this is not the user's home folder since many other files may already reside there. Thereby making the build result files more difficult to find or delete. This is a missing Debian feature. See: dpkg-buildpackage: support output directory other than ..archive.org iconarchive.today icon
  2. ↑ Steps 1-3 can be completed with just one command. Click = Copy Copied to clipboard! gpg --import /usr/share/whonix/whonix-keys.d/derivative.asc
  3. ↑ See Trust.
Your support makes
all the difference!

We believe security software like Kicksecure needs to remain Open Source and independent. Would you help sustain and grow the project? Learn more about our 12 year success story and maybe DONATE!

Retrieved from "https://www.kicksecure.com/w/index.php?title=Dev/Build_Documentation/generic-package&oldid=74188"