HyperWiki

Hyperbola Packaging Guidelines

The Hyperbola Packaging Guidelines is the commitment that we, the Hyperbola Project, make to the Free Software Community in general and our users in particular. It is because of this that our packaging guidelines will always follow the philosophy of freedom, privacy, stability and security.

  1. Freedom: All packages follow the GNU Free System Distribution Guidelines. They do not include or recommend non-free software or documentation and do not provide any type of support for the installation or execution of non-free software. This includes:
  2. Privacy: Hyperbola's objective is to support privacy of its community. This includes:
    • a) Software built and patched to be secure from global data surveillance revealed in the publication of Snowden's NSA documents.
    • b) Additional hardened packages which remove lower level protocols that may cause privacy leaks, metadata/fingerprinting, and vulnerabilities.
  3. FHS: All packages follow the Filesystem Hierarchy Standard (FHS) which defines the main directories and their contents in GNU/Linux and other Unix-like computer operating systems such as GNU/Hurd. Therefore, all packages should be fixed using the required standard without exceptions.
  4. Free software projects: If there is software that contain a stable version, then the upstream version should be blacklisted. There are examples such as:
    • a) The long-term support (LTS) of Linux-libre kernel instead of the upstream one.
    • b) The extended support release (ESR) of libre version of Iceweasel instead of the upstream one.
    • c) The stable version of Nginx instead of the mainline one.
    • d) The still version of LibreOffice instead of the fresh one.
    • e) The stable version of GnuPG instead of the modern one.
  5. Anti-abandonware: Hyperbola considers orphaned projects without bugfixes and patches activity as security issue and should be blacklisted. Exceptions are considered:
    • a) If a package is needed for a functionality and there is no a current replacement for it.
    • b) If a package is an important dependency for active projects and there is no a current replacement for it.
    • c) If a package is a driver, firmware or hardware emulation and there is no a current replacement for it.
  6. Package versions: Since Hyperbola is a long-term support (LTS) system; all packages are based on the package versions Debian is using foremost in the current stable or old-stable and designed to be supported for a longer than normal period until the next stable release. Exceptions are considered:
    • a) Binutils and GCC should follow the same version used in HyperbolaBSD.
    • b) If a package version needs taking security parts from a newer version, but it is inefficient to be backported, a newer version could be considered as exception (see Backporting amendment for further details).
  7. Backporting: Hyperbola uses the term backporting to describe a package built from a newer version, adjusted and adapted for usage on the current stable release. It requires be repackaged with the appropriate package release “backports$backportsreleasenumber” (eg. pkgrel=1.backports1) until the next stable release. Backporting is accepted in Hyperbola as exception, but under the following conditions:
    • a) If the current package used on the current stable release needs many modifications spread across multiple files of the code to solve some specific issue (eg. security issue) and it is inefficient to be fixed.
    • b) All newer version packages and its required newer version library and dependency packages should be repackaged with the appropriate package release too, since it will be rebuilt in a stable environment so that it will run without new libraries. This suffix is applied until the next stable release.
    • c) All newer version packages should follow the package version rules from Hyperbola Packaging Guidelines, it means Hyperbola will not accept recurrent drastic version changes as long as fixing is possible.
  8. Package licenses: All packages contain a license field that specifies the license(s) source that apply to the package using the commonly used licenses in /usr/share/licenses/common. It means, if a source is under a license which is available in /usr/share/licenses/common (eg. GPL-2), simply it should be referenced in the package license field (eg. license=('GPL-2')). If it is not the case, then it should be included in the package itself and set license=('custom:LicenseName'). The license file should be placed in /usr/share/licenses/$pkgname when building the package. If multiple licenses are applicable, the conditions are:
    • a) If an upstream source provides the preference to choose a license, add only that license in the package license field. The chosen license must be compatible with the linked library dependencies used by the package. (eg. if the chosen license for ffmpeg is the version 3 of LGPL, then the configure parameter `–enable-version3` must be added in ffmpeg's PKGBUILD to activate this licensing option and use the LGPL-3 compatible libraries).
    • b) If an upstream source contains files with many different licenses, add only the primary ones in the package license field.
    • c) All chosen primary and compatible license files from the upstream source should be placed in /usr/share/licenses/$pkgname.
  9. Debian patches: All packages contain Debian security/stability patches to follow the Social Contract and the program quilt to automate the patching. The mdadm's PKGBUILD is used as example for all packages. Exceptions are considered:
    • a) If Debian does not maintain the required package. In this case, we should use the Devuan or Gentoo patches.
    • b) If there are no patches available for the required package.
    • c) For Linux-libre kernels.
  10. HTTPS and tarballs: All packages need to be built from the source through its official tarball not from a version control system (VCS). Therefore, all packages should be fixed using the required tarball from its HTTPS site. Exceptions are considered:
    • a) If there is not an HTTPS site. In this case, HTTP is the alternative option.
    • b) If there is not an HTTP site. In this case, FTP is the alternative option.
    • c) If there is no an official tarball. In this case, tarballs from the official Debian repositories is the alternative option.
    • d) If there is an official tarball, however tarballs from the official Debian repositories contain bugfixes. In this case, the official tarballs from Debian should be used by default. (eg. Mutt+NeoMutt bugfixes)
    • e) If there is an official tarball, however it requires download git submodules to be built from the source. In this case, tarballs from the official Debian repositories is the alternative option.
    • f) If there are no available tarballs anywhere: In this case the software is not to be used finally.
  11. SHA-512: All packages should use SHA-512 cryptographic hash functions only. Other cryptographic hash functions such as MD5 and SHA-1 should not be used because they are severely compromised. Exceptions are considered:
    • a) If the package is using a version control system (VCS) because it does not contain GNU/Linux support or/and tarballs.
  12. GPG: All packages should use signature verification. Exceptions are considered:
    • a) If tarballs do not contain signatures.
    • b) If the corresponding gpg-key is no longer valid.
  13. Anti-obfuscation: obfuscation is the deliberate act of creating obfuscated code, i.e. source or machine code that is difficult for humans to understand. All obfuscated code will be rejected without exceptions.
  14. No GNU/Linux-only software: As Hyperbola is oriented on UNIX we do not support software only for GNU/Linux. As long as there is no need for a driver or any other framework running Hyperbola GNU/Linux-libre as transition-base towards HyperbolaBSD we will not add the software.