summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Kalnischkies <david@kalnischkies.de>2015-10-15 09:35:52 +0200
committerDavid Kalnischkies <david@kalnischkies.de>2015-11-04 18:04:01 +0100
commit002b1bc46b18e9d309d337ddb15a6ccdfb6c9dde (patch)
tree4ba630b34486aa6fcbc90ec5a117f01b24bdf0b7 /doc
parentf18f2338a17d3037ac0d6f81a7f1a37df6eaca01 (diff)
downloadapt-002b1bc46b18e9d309d337ddb15a6ccdfb6c9dde.tar.gz
refer to apt-secure(8) in unsecure repositories warning
The manpage is also slightly updated to work better as a central hub to push people from all angles into the right directions without writting a book disguised as an error message.
Diffstat (limited to 'doc')
-rw-r--r--doc/apt-key.8.xml15
-rw-r--r--doc/apt-secure.8.xml87
2 files changed, 64 insertions, 38 deletions
diff --git a/doc/apt-key.8.xml b/doc/apt-key.8.xml
index 1d91790ea..41628aff6 100644
--- a/doc/apt-key.8.xml
+++ b/doc/apt-key.8.xml
@@ -48,7 +48,11 @@
&synopsis-param-filename; or if the filename is <literal>-</literal>
from standard input.
</para>
-
+ <para>
+ It is critical that keys added manually via <command>apt-key</command> are
+ verified to belong to the owner of the repositories they claim to be for
+ otherwise the &apt-secure; infrastructure is completely undermined.
+ </para>
</listitem>
</varlistentry>
@@ -110,10 +114,11 @@
<varlistentry><term><option>adv</option></term>
<listitem>
<para>
-
- Pass advanced options to gpg. With adv --recv-key you can download the
- public key.
-
+ Pass advanced options to gpg. With <command>adv --recv-key</command> you
+ can e.g. download key from keyservers directly into the the trusted set of
+ keys. Note that there are <emphasis>no</emphasis> checks performed, so it is
+ easy to completely undermine the &apt-secure; infrastructure if used without
+ care.
</para>
</listitem>
diff --git a/doc/apt-secure.8.xml b/doc/apt-secure.8.xml
index e343b86ea..9b4b7378d 100644
--- a/doc/apt-secure.8.xml
+++ b/doc/apt-secure.8.xml
@@ -13,7 +13,7 @@
&apt-email;
&apt-product;
<!-- The last update date -->
- <date>2012-06-09T00:00:00Z</date>
+ <date>2015-10-14T00:00:00Z</date>
</refentryinfo>
<refmeta>
@@ -45,32 +45,38 @@
<refsect1><title>Description</title>
<para>
- Starting with version 0.6, <command>apt</command> contains code
- that does signature checking of the Release file for all
- archives. This ensures that packages in the archive can't be
- modified by people who have no access to the Release file signing
- key.
+ Starting with version 0.6, <command>APT</command> contains code that does
+ signature checking of the Release file for all repositories. This ensures
+ that data like packages in the archive can't be modified by people who
+ have no access to the Release file signing key.
</para>
<para>
- If a package comes from a archive without a signature, or with a
- signature that apt does not have a key for, that package is
- considered untrusted, and installing it will result in a big
- warning. <command>apt-get</command> will currently only warn
- for unsigned archives; future releases might force all sources
- to be verified before downloading packages from them.
+ If an archive doesn't have a signed Release file or no Release file at all
+ current APT versions will raise a warning in <command>update</command>
+ operations and frontends like <command>apt-get</command> will require
+ explicit confirmation if an installation request includes a package from
+ such an unauthenticated archive.
</para>
<para>
- The package frontends &apt-get;, &aptitude; and &synaptic; support this new
- authentication feature.
+ In the future APT will refuse to work with unauthenticated repositories by
+ default until support for them is removed entirely. Users have the option to
+ opt-in to this behavior already by setting the configuration option
+ <option>Acquire::AllowInsecureRepositories</option> to <literal>false</literal>.
+ </para>
+
+ <para>
+ Note: All APT-based package management frontends like &apt-get;, &aptitude;
+ and &synaptic; support this authentication feature, so this manpage uses
+ <literal>APT</literal> to refer to them all for simplicity only.
</para>
</refsect1>
- <refsect1><title>Trusted archives</title>
+ <refsect1><title>Trusted repositories</title>
- <para>
- The chain of trust from an apt archive to the end user is made up of
+ <para>
+ The chain of trust from an APT archive to the end user is made up of
several steps. <command>apt-secure</command> is the last step in
this chain; trusting an archive does not mean that you trust its
packages not to contain malicious code, but means that you
@@ -85,13 +91,14 @@
devscripts packages respectively).</para>
<para>
- The chain of trust in Debian starts when a maintainer uploads a new
+ The chain of trust in Debian e.g. starts when a maintainer uploads a new
package or a new version of a package to the Debian archive. In
order to become effective, this upload needs to be signed by a key
- contained in the Debian Maintainers keyring (available in
+ contained in one of the Debian package maintainers keyrings (available in
the debian-keyring package). Maintainers' keys are signed by
other maintainers following pre-established procedures to
- ensure the identity of the key holder.
+ ensure the identity of the key holder. Similar procedures exist in all
+ Debian-based distributions.
</para>
<para>
@@ -132,20 +139,23 @@
</itemizedlist>
<para>However, it does not defend against a compromise of the
- Debian master server itself (which signs the packages) or against a
+ master server itself (which signs the packages) or against a
compromise of the key used to sign the Release files. In any case,
this mechanism can complement a per-package signature.</para>
</refsect1>
<refsect1><title>User configuration</title>
<para>
- <command>apt-key</command> is the program that manages the list
- of keys used by apt. It can be used to add or remove keys, although
- an installation of this release will automatically contain the
- default Debian archive signing keys used in the Debian package
- repositories.
- </para>
- <para>
+ <command>apt-key</command> is the program that manages the list of keys used
+ by APT to trust repositories. It can be used to add or remove keys as well
+ as list the trusted keys. Limiting which key(s) are able to sign which archive
+ is possible via the <option>Signed-By</option> in &sources-list;.
+ </para><para>
+ Note that a default installation already contains all keys to securily
+ acquire packages from the default repositories, so fiddling with
+ <command>apt-key</command> is only needed if third-party repositories are
+ added.
+ </para><para>
In order to add a new key you need to first download it
(you should make sure you are using a trusted communication channel
when retrieving it), add it with <command>apt-key</command> and
@@ -171,10 +181,21 @@
<command>gpg --clearsign -o InRelease Release</command> and
<command>gpg -abs -o Release.gpg Release</command>.</para></listitem>
- <listitem><para><emphasis>Publish the key fingerprint</emphasis>,
- that way your users will know what key they need to import in
- order to authenticate the files in the
- archive.</para></listitem>
+ <listitem><para>
+ <emphasis>Publish the key fingerprint</emphasis>, that way your users
+ will know what key they need to import in order to authenticate the files
+ in the archive. It is best to ship your key in its own keyring package
+ like &keyring-distro; does with &keyring-package; to be able to
+ distribute updates and key transitions automatically later.
+ </para></listitem>
+
+ <listitem><para>
+ <emphasis>Provide instructions on how to add your archive and key</emphasis>.
+ If your users can't acquire your key securily the chain of trust described above is broken.
+ How you can help users add your key depends on your archive and target audience ranging
+ from having your keyring package included in another archive users already have configured
+ (like the default repositories of their distribution) to leverage the web of trust.
+ </para></listitem>
</itemizedlist>
@@ -192,7 +213,7 @@
<para>For more background information you might want to review the
<ulink
-url="http://www.debian.org/doc/manuals/securing-debian-howto/ch7">Debian
+url="https://www.debian.org/doc/manuals/securing-debian-howto/ch7">Debian
Security Infrastructure</ulink> chapter of the Securing Debian Manual
(available also in the harden-doc package) and the
<ulink url="http://www.cryptnet.net/fdp/crypto/strong_distro.html"