<!-- CVS revision of this document "$Revision: 1.28 $"  -->

<chapt>Debian Security Infrastructure

<sect id="debian-sec-team">The Debian Security Team

<p>Debian has a Security Team, that handles security in the <em>stable</em>
distribution. Handling security means they keep track of
vulnerabilities that arise in software (watching forums such as
Bugtraq, or vuln-dev) and determine if the <em>stable</em>
distribution is affected by it.

<p>Also, the Debian Security Team is the contact point for problems
that are coordinated by upstream developers or organizations such as
<url id="http://www.cert.org" name="CERT"> which might affect multiple
vendors. That is, when problems are not Debian-specific. The contact
point of the Security Team is <url id="mailto:team@security.debian.org"
name="team@security.debian.org"> which only the members of the
security team read. 

<p>Sensitive information should be sent to the first address and, in
some cases, should be encrypted with the Debian Security Contact key
(as found in the Debian keyring).

<p>Once a probable problem is received by the Security Team it will
investigate if the <em>stable</em> distribution is affected and if it
is, a fix is made for the source code base. This fix will sometimes
include backporting the patch made upstream (which usually is some
versions ahead of the one distributed by Debian). After testing of the
fix is done, new packages are prepared and published in the <url
id="http://security.debian.org"> site so they can be retrieved through
<prgn>apt</prgn> (see <ref id="security-update">). At the same time a
<em>Debian Security Advisory</em> (DSA) is published on the web site
and sent to public mailing lists including <url
id="http://lists.debian.org/debian-security-announce"
name="debian-security-announce"> and Bugtraq.

<p>Some other frequently asked questions on the Debian Security Team can be
found at <ref id="debian-sec-team-faq">.


<sect id="dsa">Debian Security Advisories

<p>Debian Security Advisories (DSAs) are made whenever a security
vulnerability is discovered that affects a Debian package. These
advisories, signed by one of the Security Team members, include
information of the versions affected as well as the location of the
updates. This information is:

<list>
<item>version number for the fix.
<item>problem type.
<item>whether it is remote or locally exploitable.
<item>short description of the package.
<item>description of the problem.
<item>description of the exploit.
<item>description of the fix.
</list>


<p>DSAs are published both on <url id="http://www.debian.org/"
name="Debian's frontpage"> and in the <url
id="http://www.debian.org/security/" name="Debian security
pages">. Usually this does not happen until the website is rebuilt
(every four hours) so they might not be present immediately. The preferred
channel is the debian-security-announce mailing list.

<p>Interested users can, however (and this is done in some
Debian-related portals) use the RDF channel to download automatically
the DSAs to their desktop. Some applications, such as
<prgn>Evolution</prgn> (an email client and personal information
assistant) and <prgn>Multiticker</prgn> (a GNOME applet), can be used
to retrieve the advisories automatically. The RDF channel is available
at <url id="http://www.debian.org/security/dsa.rdf">.

<p>DSAs published on the website might be updated after being sent to
the public-mailing lists. A common update is adding cross references
to security vulnerability databases. Also,
translations<footnote>Translations are available in up to ten different
languages.</footnote> of DSAs are not sent to the security mailing
lists but are directly included in the website.

<sect1 id="crossreference">Vulnerability cross references

<p>Debian provides a fully <url
id="http://www.debian.org/security/crossreferences"
name="crossreferenced table"> including all the references available
for all the advisories published since 1998. This table is provided to
complement the <url
id="http://cve.mitre.org/cve/refs/refmap/source-DEBIAN.html"
name="reference map available at CVE">. 

<P>You will notice that this table provides references to
security databases such as <url id="http://www.securityfocus.com/bid"
name="Bugtraq">,
<url id="http://www.cert.org/advisories/" name="CERT/CC Advisories">
and <url id="http://www.kb.cert.org/vuls" name="US-CERT Vulnerability
Notes Database"> as well as CVE names (see below). These references
are provided for convenience use, but only CVE references are
periodically reviewed and included.

<p>Advantages of adding cross references to these
vulnerability databases are:

<list>
<item>it makes it easier for Debian users to see and track which
general (published) advisories have already been covered by Debian. 

<item>system administrators can learn more about the vulnerability and
its impact by following the cross references.

<item>this information can be used to cross-check output from
vulnerability scanners that include references to CVE to remove false
positives (see <ref id="vulnasses-false-positive">).

</list>
</sect1>

<sect1 id="cve-compatible">CVE compatibility

<P>Debian Security Advisories were <url
id="http://www.debian.org/security/CVE-certificate.jpg" name="declared
CVE-Compatible"><footnote>The full <url
id="http://cve.mitre.org/compatible/phase2/SPI_Debian.html"
name="capability questionnaire"> is available at CVE</footnote> in
February 24, 2004.

<p>Debian developers understand the need to provide accurate and up to
date information of the security status of the Debian distribution,
allowing users to manage the risk associated with new security
vulnerabilities. CVE enables us to provide standardized references that
allow users to develop a <url
id="http://www.cve.mitre.org/compatible/enterprise.html"
name="CVE-enabled security management process">.

<p>The <url id="http://cve.mitre.org" name="Common Vulnerabilities and
Exposures (CVE)"> project is maintained by the MITRE Corporation and
provides a list of standardized names for vulnerabilities and security
exposures.

<P>Debian believes that providing users with additional information
related to security issues that affect the Debian distribution is
extremely important. The inclusion of CVE names in advisories help
users associate generic vulnerabilities with specific Debian updates,
which reduces the time spent handling vulnerabilities that affect our
users. Also, it eases the management of security in an environment
where CVE-enabled security tools -such as network or host intrusion
detection systems, or vulnerability assessment tools- are already
deployed regardless of whether or not they are based on the Debian
distribution.

<p>Debian
provides CVE names for all DSAs released since September 1998.
All of the advisories can be
retrieved on the Debian web site, and announcements related to new
vulnerabilities include CVE names if available at the time of their
release. Advisories associated with a given CVE name can be searched
directly through the Debian Security Tracker (see below).

<p>In some cases you might not find a given CVE name in published
advisories, for example because:

<list>
   <item> No Debian products are affected by that vulnerability.
   <item> There is not yet an advisory covering that vulnerability
   (the security issue might have been reported as a <url
   id="http://bugs.debian.org/cgi-bin/pkgreport.cgi?tag=security"
   name="security bug"> but a fix has not been tested and uploaded).
   <item> An advisory was published before a CVE name was assigned to a
   given vulnerability (look for an update at the web site).
</list>
</sect1>

</sect>

<sect>Security Tracker

<p>The central database of what the Debian security teams know about
vulnerabilities is the <url
id="http://security-tracker.debian.net"
name="Debian Security Tracker">. It cross references packages,
vulnerable and fixed versions for different suites, CVE names,
Debian bug numbers, DSA's and miscellaneous notes. It can be
searched, e.g. by CVE name to see which Debian packages are affected
or fixed, or by package to show unresolved security issues. 
The only information missing from the tracker is confidential 
information that the security team received under embargo.

<p>The package <prgn>debsecan</prgn> uses the information in the
tracker to report to the administrator of a system which of the
installed packages are vulnerable, and for which updates are
available to fix security issues.

<sect>Debian Security Build Infrastructure

<p>Since Debian is currently supported in a large number of
architectures, administrators sometimes wonder if a given architecture
might take more time to receive security updates than another. As a
matter of fact, except for rare circumstances, updates are available
to all architectures at the same time.

<p>Packages in the security archive are autobuilt, just like the
regular archive. 
However, security updates are a little more different than normal
uploads sent by package maintainers since, in some cases, before being
published they need to wait until they can be tested further, an
advisory written, or need to wait for a week or more to avoid
publicizing the flaw until all vendors have had a reasonable chance to
fix it. 

<p>Thus, the security upload archive works with the following
procedure:

<list>

<item>Someone finds a security problem.
     
<item>Someone fixes the problem, and makes an upload to
      security-master.debian.org's incoming (this <em>someone</em> is usually
      a Security Team member but can be also a package maintainer with
      an appropriate fix that has contacted the Security Team
      previously). The Changelog includes a <em>testing-security</em>
      or <em>stable-security</em> as target distribution.

<item>The upload gets checked and processed by a Debian system and moved
      into queue/accepted, and the buildds are notified. Files in here
      can be accessed by the security team and (somewhat indirectly) by 
      the buildds.

<item>Security-enabled buildds pick up the source package
      (prioritized over normal builds), build it, and send the logs to
      the security team.

<item>The security team reply to the logs, and the newly built
      packages are uploaded to queue/unchecked, where they're processed
      by a Debian system, and moved into queue/accepted.

<item>When the security team find the source package acceptable (i.e.,
      that it's been correctly built for all applicable architectures
      and that it fixes the security hole and doesn't introduce new
      problems of its own) they run a script which:

<list>
<item>installs the package into the security archive.

<item>updates the <file>Packages</file>, <file>Sources</file> and <file>Release</file> files of
security.debian.org in the usual way (<prgn>dpkg-scanpackages</prgn>,
<prgn>dpkg-scansources</prgn>, ...).

<item>sets up a template advisory that the security team can finish
off.

<item>forwards the packages to the appropriate
proposed-updates so that it can be included in the real archive as
soon as possible.

</list>

</list>

<p>This procedure, previously done by hand, was tested and put through
during the freezing stage of Debian 3.0 woody (July 2002). Thanks to this
infrastructure the Security Team was able to have updated packages
ready for the apache and OpenSSH issues for all the supported (almost
twenty) architectures in less than a day.


<sect1>Developer's guide to security updates

<p>Debian developers that need to coordinate with the security team on
fixing in issue in their packages, can refer to the Developer's
Reference section
<url name="Handling security-related bugs"
id="http://www.debian.org/doc/manuals/developers-reference/pkgs.html#bug-security">.


<sect id="deb-pack-sign">Package signing in Debian

<p>This section could also be titled "how to upgrade/update safely
your Debian GNU/Linux system" and it deserves its own section
basically because it is an important part of the Security
Infrastructure. Package signing is an important issue since it avoids
tampering of packages distributed in mirrors and of downloads with
man-in-the-middle attacks. Automatic software update is an important
feature but it's also important to remove security threats that could
help the distribution of trojans and the compromise of systems during
updates<footnote>
<p>Some operating systems have already been plagued with
automatic-updates problems such as the
<url name="Mac OS X Software Update vulnerabity"
id="http://www.cunap.com/~hardingr/projects/osx/exploit.html">.
<p>FIXME: probably the Internet Explorer vulnerability handling
certificate chains has an impact on security updates on Microsoft Windows.
</footnote>.

<p>Debian does not provide signed packages but provides a mechanism
available since Debian 4.0 (codename <em>etch</em>) to check for
downloaded package's integrity<footnote><p>Older releases, such
as Debian 3.1 <em>sarge</em> can use this feature by using backported
versions of this package management tool</p></footnote>. For more information,
see <ref id="apt-0.6">.

<p>This issue is better described in the
<url id="http://www.cryptnet.net/fdp/crypto/strong_distro.html" name="Strong
Distribution HOWTO"> by V. Alex Brennen.

<sect1>The current scheme for package signature checks

<p>The current scheme for package signature checking
using <prgn>apt</prgn> is:

<list>
<item>the <file>Release</file> file includes the MD5 sum of <file>Packages.gz</file>
(which contains the MD5 sums of packages) and will be signed.
The signature is one of a trusted source.

<item>This signed <file>Release</file> file is downloaded by 'apt-get update'
and stored along with <file>Packages.gz</file>.

<item>When a package is going to be installed, it is first downloaded,
then the MD5 sum is generated.

<item>The signed <file>Release</file> file is checked (signature ok) and it extracts from
it the MD5 sum for the <file>Packages.gz</file> file, the <file>Packages.gz</file> checksum is generated
and (if ok) the MD5 sum of the downloaded package is extracted from it.

<item>If the MD5 sum from the downloaded package is the same as the one in the
<file>Packages.gz</file> file the package will be 
installed, otherwise the administrator will be alerted and the package will
be left in the cache (so the administrator can decide whether to install it or not).
If the package is not in the <file>Packages.gz</file> and the administrator has 
configured the system to only install checked packages it will not be 
installed either.
</list>

<p>By following the chain of MD5 sums <prgn>apt</prgn> is capable of verifying
that a package originates from a a specific release. This is less
flexible than signing each package one by one, but can be combined with
that scheme too (see below).

<p>This scheme is <url
id="http://lists.debian.org/debian-devel/2003/debian-devel-200312/msg01986.html
" name="fully implemented"> in apt 0.6 and is available since
the Debian 4.0 release. For more information see <ref
id="apt-0.6">. Packages that provide a front-end to apt need to be
modified to adapt to this new feature; this is the case of
<prgn>aptitude</prgn> which was <url
id="http://lists.debian.org/debian-devel/2005/03/msg02641.html"
name="modified"> to adapt to this scheme. Front-ends currently known
to work properly with this feature include <prgn>aptitude</prgn> and
<prgn>synaptic</prgn>.

<p>Package signing has been discussed in Debian for quite some time, for
more information you can read:
<url id="http://www.debian.org/News/weekly/2001/8/"> and
<url id="http://www.debian.org/News/weekly/2000/11/">.

<sect1 id="apt-0.6">Secure apt

<p>The apt 0.6 release, available since Debian 4.0 <em>etch</em>
and later releases, includes <em>apt-secure</em>
(also known as <em>secure apt</em>) which is a tool
that will allow a system administrator to test the integrity 
of the packages downloaded through the above scheme. 
This release includes the tool <prgn>apt-key</prgn> for adding 
new keys to apt's keyring, which by default includes only the current 
Debian archive signing key.

<p>These changes are based on the
patch for <prgn>apt</prgn> (available in <url
id="http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=203741" name="Bug
#203741">) which provides this implementation.  

<p>Secure apt works by checking the distribution through the <file>Release</file> file,
as discussed in <ref id="check-releases">. Typically, this process will
be transparent to the administrator although you will need to intervene
every year<footnote>Until an automatic mechanism is developed.</footnote>
to add the new archive key when it is rotated, for more information on the
steps an administrator needs to take a look at <ref id="secure-apt-add-key">.

<p>This feature is still under development, if you believe you find
bugs in it, please, make first sure you are using the latest version (as this
package might change quite a bit before it is finally released) and, if running
the latest version, submit a bug against the <package>apt</package> package.

<p>You can find more information at
<url id="http://wiki.debian.org/SecureApt" name="the wiki pages"> and the
official documentation: <url id="http://www.enyo.de/fw/software/apt-secure/"
name="Migration to APT 0.6"> and <url
id="http://www.syntaxpolice.org/apt-secure/" name="APT Signature Checking">.

<sect1 id="check-releases">Per distribution release check

<p>This section describes how the distribution release check mechanism
works, it was written by Joey Hess and is also available at the
<url id="http://wiki.debian.org/SecureApt" name="Debian Wiki">.

<sect2>Basic concepts

<p>Here are a few basic concepts that you'll need to understand for the rest of
this section.

<p>A checksum is a method of taking a file and boiling it down to a reasonably
short number that uniquely identifies the content of the file. This is a lot
harder to do well than it might seem, and the most commonly used type of
checksum, the MD5 sum, is in the process of being broken.

<p>Public key cryptography is based on pairs of keys, a public key and a private
key. The public key is given out to the world; the private key must be kept a
secret. Anyone possessing the public key can encrypt a message so that it can
only be read by someone possessing the private key. It's also possible to use a
private key to sign a file, not encrypt it. If a private key is used to sign a
file, then anyone who has the public key can check that the file was signed by
that key. No one who doesn't have the private key can forge such a signature.

<p>These keys are quite long numbers (1024 to 2048 digits or longer), and to
make them easier to work with they have a key id, which is a shorter, 8 or 16
digit number that can be used to refer to them.

<p><prgn>gpg</prgn> is the tool used in secure apt to sign files and check their
signatures.

<p><prgn>apt-key</prgn> is a program that is used to manage a keyring of gpg keys
for secure apt. The keyring is kept in the file
<file>/etc/apt/trusted.gpg</file> (not to be confused with the related but not
very interesting <file>/etc/apt/trustdb.gpg</file>). <prgn>apt-key</prgn> can
be used to show the keys in the keyring, and to add or remove a key. 

<sect2><file>Release</file> checksums

<p>A Debian archive contains a <file>Release</file> file, which is updated each
time any of the packages in the archive change. Among other things, the <file>Release</file>
file contains some MD5 sums of other files in the archive. An excerpt of an
example <file>Release</file> file:

<example>
MD5Sum:
 6b05b392f792ba5a436d590c129de21f            3453 Packages
 1356479a23edda7a69f24eb8d6f4a14b            1131 Packages.gz
 2a5167881adc9ad1a8864f281b1eb959            1715 Sources
 88de3533bf6e054d1799f8e49b6aed8b             658 Sources.gz
</example>

<p>The <file>Release</file> files also include SHA-1 checksums, which will be useful once
MD5 sums become fully broken, however apt doesn't use them yet.

<p>Now if we look inside a <file>Packages</file> file, we'll find more MD5 sums, one for
each package listed in it. For example:

<example>
    Package: uqm
    Priority: optional
    ...
    Filename: unstable/uqm_0.4.0-1_i386.deb
    Size: 580558
    MD5sum: 864ec6157c1eea88acfef44d0f34d219
</example>

<p>These two checksums can be used to verify that you have downloaded a correct
copy of the <file>Packages</file> file, with a md5sum that matches the one in the <file>Release</file>
file. And when it downloads an individual package, it can also check its
md5sum against the content of the <file>Packages</file> file. If apt fails at either of
these steps, it will abort.

<p>None of this is new in secure apt, but it does provide the foundation.
Notice that so far there is one file that apt doesn't have a way to check: The
Release file. Secure apt is all about making apt verify the <file>Release</file> file before
it does anything else with it, and plugging this hole, so that there is a chain
of verification from the package that you are going to install all the way back
to the provider of the package. 

<sect2>Verification of the <file>Release</file> file

<p>To verify the <file>Release</file> file, a gpg signature is added for
the <file>Release</file> file. This is put in a file named <file>Release.gpg</file> that is
shipped alongside the <file>Release</file> file. It looks something like this
<footnote>Technically speaking, this is an ASCII-armored detached gpg signature.</footnote>
, although only gpg actually looks at its contents normally:

<example>
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)

iD8DBQBCqKO1nukh8wJbxY8RAsfHAJ9hu8oGNRAl2MSmP5+z2RZb6FJ8kACfWvEx
UBGPVc7jbHHsg78EhMBlV/U=
=x6og
-----END PGP SIGNATURE-----
</example>

<sect2>Check of <file>Release.gpg</file> by <prgn>apt</prgn>

<p>Secure apt always downloads <file>Release.gpg</file> files when it's
downloading <file>Release</file> files, and if it cannot download the <file>Release.gpg</file>, or if the
signature is bad, it will complain, and will make note that the <file>Packages</file> files
that the <file>Release</file> file points to, and all the packages listed therein, are from
an untrusted source. Here's how it looks during an <prgn>apt-get update</prgn>:

<example>
W: GPG error: http://ftp.us.debian.org testing Release: The following signatures
 couldn't be verified because the public key is not available: NO_PUBKEY 010908312D230C5F
</example>

<p>Note that the second half of the long number is the key id of the key that apt
doesn't know about, in this case that's 2D230C5F.

<p>If you ignore that warning and try to install a package later, apt will warn again:

<example>
WARNING: The following packages cannot be authenticated!
  libglib-perl libgtk2-perl
Install these packages without verification [y/N]?
</example>

<p>If you say Y here you have no way to know if the file you're getting is the
package you're supposed to install, or if it's something else entirely that somebody
that can intercept the communication against the server<footnote>Or has
poisoned your DNS, or is spoofing the server, or has replaced the file in the
mirror you are using, etc.</footnote> has arranged for you, containing a nasty
suprise.

<p>Note that you can disable these checks by running apt with --allow-unauthenticated.

<p>It's also worth noting that newer versions of the Debian installer use the same
signed <file>Release</file> file mechanism during their debootstrap of the Debian base
system, before apt is available, and that the installer even uses this system
to verify pieces of itself that it downloads from the net. Also, Debian does
not currently sign the <file>Release</file> files on its CDs; apt can be configured to
always trust packages from CDs so this is not a large problem. 

<sect2>How to tell apt what to trust

<p>So the security of the whole system depends on there being a <file>Release.gpg</file>
file, which signs a <file>Release</file> file, and of <prgn>apt</prgn> checking
that signature using gpg. To check the signature, it has to know the public
key of the person who signed the file. These keys are kept in apt's own keyring
(<file>/etc/apt/trusted.gpg</file>), and managing the keys is where secure apt
comes in.

<p>By default, Debian systems come preconfigured with the Debian archive key in the keyring.

<example>
# apt-key list
/etc/apt/trusted.gpg
--------------------
pub   1024D/4F368D5D 2005-01-31 [expires: 2006-01-31]
uid                  Debian Archive Automatic Signing Key (2005) &lt;ftpmaster@debian.org&gt;
</example>

<p>Here 4F368D5D is the key id, and notice that this key was only valid for a one
year period. Debian rotates these keys as a last line of defense against some
sort of security breach breaking a key.

<p>That will make <prgn>apt</prgn> trust the official Debian archive, but if you add some
other apt repository to <file>/etc/apt/sources.list</file>, you'll also have to
give <prgn>apt</prgn> its key if you want apt to trust it. Once you have the key and have
verified it, it's a simple matter of running <prgn>apt-key add file</prgn> to
add it. Getting the key and verifying it are the trickier parts. 

<sect2>Finding the key for a repository

<p>The debian-archive-keyring package is used to distribute keys to
<prgn>apt</prgn>.  Upgrades to this package can add (or remove) gpg keys for
the main Debian archive.

<p>For other archives, there is not yet a standard location where you can find the key for a given apt
repository. There's a rough standard of putting the key up on the web page for
the repository or as a file in the repository itself, but no real standard, so
you might have to hunt for it.

<p>The Debian archive signing key is available at <url
id="http://ftp-master.debian.org/ziyi_key_2006.asc"> (replace 2006 with current
year).<footnote>"ziyi" is the name of the tool used for signing on the Debian servers,
the name is based on the name of a <url
id="http://en.wikipedia.org/wiki/Zhang_Ziyi" name="Chinese actress">.
</footnote>

<p><prgn>gpg</prgn> itself has a standard way to distribute keys, using a
keyserver that gpg can download a key from and add it to its keyring. For
example:

<example>
$ gpg --keyserver pgpkeys.mit.edu --recv-key 2D230C5F
gpg: requesting key 2D230C5F from hkp server pgpkeys.mit.edu
gpg: key 2D230C5F: public key "Debian Archive Automatic Signing Key (2006) &lt;ftpm
aster@debian.org&gt;" imported
gpg: Total number processed: 1
gpg:               imported: 1
</example>

<p>You can then export that key from your own keyring and feed it to <prgn>apt-key</prgn>:

<example>
$ gpg -a --export 2D230C5F | sudo apt-key add -
gpg: no ultimately trusted keys found
OK
</example>

<p>The "gpg: no ultimately trusted keys found" warning means that gpg was not
configured to ultimately trust a specific key. Trust settings are part of
OpenPGPs Web-of-Trust which does not apply here. So there is no problem with
this warning. In typical setups the user's own key is ultimately trusted.

<sect2 id="secure-apt-add-key">Safely adding a key

<p>By adding a key to apt's keyring, you're telling apt to trust everything signed
by the key, and this lets you know for sure that apt won't install anything not
signed by the person who possesses the private key. But if you're sufficiently
paranoid, you can see that this just pushes things up a level, now instead of
having to worry if a package, or a <file>Release</file> file is valid, you can worry about
whether you've actually gotten the right key. Is the 
<url id="http://ftp-master.debian.org/ziyi_key_2006.asc"> file mentioned above
really Debian's archive signing key, or has it been modified (or this document lies).

<p>It's good to be paranoid in security, but verifying things from here is
harder. <prgn>gpg</prgn> has the concept of a chain of trust, which can start
at someone you're sure of, who signs someone's key, who signs some other key,
etc., until you get to the archive key. If you're sufficiently paranoid you'll
want to check that your archive key is signed by a key that you can trust, with
a trust chain that goes back to someone you know personally. If you want to do
this, visit a Debian conference or perhaps a local LUG for a key signing
<footnote>Not all apt repository keys are signed at all by another key. Maybe
the person setting up the repository doesn't have another key, or maybe they
don't feel comfortable signing such a role key with their main key. For information
on setting up a key for a repository see <ref id="check-non-debian-releases">.
</footnote>.

<p>If you can't afford this level of paranoia, do whatever feels appropriate to
you when adding a new apt source and a new key. Maybe you'll want to mail the
person providing the key and verify it, or maybe you're willing to take your
chances with downloading it and assuming you got the real thing. The important
thing is that by reducing the problem to what archive keys to trust, secure apt
lets you be as careful and secure as it suits you to be.

<sect2>Verifying key integrity

<p>You can verify the fingerprint as well as the signatures on the key. Retrieving
the fingerprint can be done for multiple sources, you can check <url
id="http://debiansystem.info/readers/changes/547-ziyi-key-2006" name="The
Debian System Book">, talk to Debian Developers on IRC, read the mailing list where
the key change will be announced or any other additional means to verify the fingerprint.
For example you can do this:

<example>
$ GET http://ftp-master.debian.org/ziyi_key_2006.asc | gpg --import
gpg: key 2D230C5F: public key "Debian Archive Automatic Signing Key (2006)
  &lt;ftpmaster&amp;debian.org&gt;" imported
gpg: Total number processed: 1
gpg:               imported: 1
$ gpg --check-sigs --fingerprint 2D230C5F
pub   1024D/2D230C5F 2006-01-03 [expires: 2007-02-07]
      Key fingerprint = 0847 50FC 01A6 D388 A643  D869 0109 0831 2D23 0C5F
uid   Debian Archive Automatic Signing Key (2006) &lt;ftpmaster@debian.org&gt;
sig!3        2D230C5F 2006-01-03  Debian Archive Automatic Signing Key
                                  (2006) &lt;ftpmaster@debian.org&gt;
sig!         2A4E3EAA 2006-01-03  Anthony Towns &lt;aj@azure.humbug.org.au&gt;
sig!         4F368D5D 2006-01-03  Debian Archive Automatic Signing Key
                                  (2005) &lt;ftpmaster@debian.org&gt;
sig!         29982E5A 2006-01-04  Steve Langasek &lt;vorlon@dodds.net&gt;
sig!         FD6645AB 2006-01-04  Ryan Murray &lt;rmurray@cyberhqz.com&gt;
sig!         AB2A91F5 2006-01-04  James Troup &lt;james@nocrew.org&gt;
</example>

and then <url id="http://www.debian.org/doc/manuals/securing-debian-howto/ch7.en.html#s-deb-pack-sign" name="check the trust path"> from your key (or a key you trust) to at least
one of the keys used to sign the archive key. If you are sufficiently paranoid
you will tell apt to trust the key only if you find an acceptable path:

<example>
$ gpg --export -a 2D230C5F | sudo apt-key add -
Ok
</example>

<p>Note that the key is signed with the previous archive key, so theoretically
you can just build on your previous trust.

<sect2>Debian archive key yearly rotation

<p>As mentioned above, the Debian archive signing key is changed each year, in
January. Since secure apt is young, we don't have a great deal of experience
with changing the key and there are still rough spots.

<p>In January 2006, a new key for 2006 was made and the <file>Release</file> file began to
be signed by it, but to try to avoid breaking systems that had the old 2005
key, the <file>Release</file> file was signed by that as well. The intent was that apt would
accept one signature or the other depending on the key it had, but apt turned
out to be buggy and refused to trust the file unless it had both keys and was
able to check both signatures. This was fixed in apt version 0.6.43.1. There
was also confusion about how the key was distributed to users who already had
systems using secure apt; initially it was uploaded to the web site with no
announcement and no real way to verify it and users were forced to download it
by hand.

<p>In January 2006, a new key for 2006 was made and the Release file began to
be signed by it, but to try to avoid breaking systems that had the old 2005
key, the <file>Release</file> file was signed by that as well.  In order to
prevent confusion on the best distribution mechanism for users who already have
systems using secure apt, the debian-archive-keyring package was introduced,
which manages apt keyring updates.

<!-- This is too vague to include here:

<p>Here is how things are expected to work in 2007:

<list>
<item>Early in January a new key for 2007 will be created. Perhaps with an
announcement and a well-defined chain of trust this time.

<item>The <file>Release</file> file will be signed by this key, while also being signed still by the 2006 key. apt and other tools will accept either signature.

<item>A new package, <package>debian-archive-keyring</package>, will have been
installed on everyone's system beforehand. It will be updated to include the
2007 key. When users upgrade to the new version, it will use <prgn>apt-key</prgn> to update
their keyring, removing the 2006 key and adding the 2007 key.

<item>The 2006 key expires on January 31st, 2007.  

</list>

<p>Still uncertain is what will happen to anyone who doesn't upgrade at all in
January, and how this upgrade will be handled for people running stable, once
secure apt is available there.

-->

<sect2>Known release checking problems

<p>One not so obvious problem is that if your clock is very far off, secure apt
will not work. If it's set to a date in the past, such as 1999, apt will fail
with an unhelpful message such as this:

<example>
W: GPG error: http://archive.progeny.com sid Release: Unknown error executing gpg
</example>

<p>Although <prgn>apt-key</prgn> list will make the problem plain:

<example>
gpg: key 2D230C5F was created 192324901 seconds in the future (time warp or clock problem)
gpg: key 2D230C5F was created 192324901 seconds in the future (time warp or clock problem)
pub   1024D/2D230C5F 2006-01-03
uid                  Debian Archive Automatic Signing Key (2006) &lt;ftpmaster@debian.org&gt;
</example>

<p>If it's set to a date too far in the future, apt will treat the keys as expired.

<p>Another problem you may encouter if using testing or unstable is that if you
have not run <prgn>apt-get update</prgn> lately and <prgn>apt-get install</prgn> a package, apt might
complain that it cannot be authenticated (why does it do this?). <prgn>apt-get update</prgn>
will fix this. 

<sect2 id="manual-check-releases">Manual per distribution release check

<p>In case you want to add now the additional security checks and
don't want or cannot run the latest apt version<footnote>Either because
you are using the stable, <em>sarge</em>, release or an older release
or because you don't want to use the latest apt version, although we would
really appreciate testing of it.</footnote> you can use the script below,
provided by Anthony Towns. This script can automatically do some new
security checks to allow the user to be sure that the software s/he's
downloading matches the software Debian's distributing. This stops
Debian developers from hacking into someone's system without the
accountability provided by uploading to the main archive, or mirrors
mirroring something almost, but not quite like Debian, or mirrors
providing out of date copies of unstable with known security problems.

<p>This sample code, renamed as <prgn>apt-check-sigs</prgn>, should be 
used in the following way:
<example>
# apt-get update
# apt-check-sigs
(...results...)
# apt-get dist-upgrade
</example>

<p>First you need to:

<list>

<item>get the keys the archive software uses to sign <file>Release</file> files,
<url id="http://ftp-master.debian.org/ziyi_key_2006.asc"> and add them
to <file>~/.gnupg/trustedkeys.gpg</file> (which is what
<prgn>gpgv</prgn> uses by default).
<example>
  gpg --no-default-keyring --keyring trustedkeys.gpg --import ziyi_key_2006.asc
</example>

<item>remove any <file>/etc/apt/sources.list</file> lines that don't
use the normal "dists" structure, or change the script so that it
works with them.

<item>be prepared to ignore the fact that Debian security updates don't
have signed <file>Release</file> files, and that <file>Sources</file> files don't have
appropriate checksums in the <file>Release</file> file (yet).

<item>be prepared to check that the appropriate sources are signed by
the appropriate keys.

</list>

<p>This is the example code for <prgn>apt-check-sigs</prgn>, the
latest version can be retrieved from <url
id="http://people.debian.org/~ajt/apt-check-sigs">.
This code is currently in beta, for more information read
<url id="http://lists.debian.org/debian-devel/2002/debian-devel-200207/msg00421.html">.

<example>
#!/bin/bash

# Copyright (c) 2001 Anthony Towns &lt;ajt@debian.org&gt;
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

rm -rf /tmp/apt-release-check
mkdir /tmp/apt-release-check || exit 1
cd /tmp/apt-release-check

>OK
>MISSING
>NOCHECK
>BAD

arch=`dpkg --print-installation-architecture`

am_root () {
        [ `id -u` -eq 0 ]
}

get_md5sumsize () {
        cat "$1" | awk '/^MD5Sum:/,/^SHA1:/' | 
          MYARG="$2" perl -ne '@f = split /\s+/; if ($f[3] eq $ENV{"MYARG"}) {
print "$f[1] $f[2]\n"; exit(0); }'
}

checkit () {
        local FILE="$1"
        local LOOKUP="$2"

        Y="`get_md5sumsize Release "$LOOKUP"`"
        Y="`echo "$Y" | sed 's/^ *//;s/  */ /g'`"

        if [ ! -e "/var/lib/apt/lists/$FILE" ]; then
                if [ "$Y" = "" ]; then
                        # No file, but not needed anyway
                        echo "OK"
                        return
                fi
                echo "$FILE" >>MISSING
                echo "MISSING $Y"
                return
        fi
        if [ "$Y" = "" ]; then
                echo "$FILE" >>NOCHECK
                echo "NOCHECK"
                return
        fi
        X="`md5sum < /var/lib/apt/lists/$FILE | cut -d\  -f1` `wc -c < /var/lib
/apt/lists/$FILE`"
        X="`echo "$X" | sed 's/^ *//;s/  */ /g'`"
        if [ "$X" != "$Y" ]; then
                echo "$FILE" >>BAD
                echo "BAD"
                return
        fi
        echo "$FILE" >>OK
        echo "OK"
}

echo
echo "Checking sources in /etc/apt/sources.list:"
echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
echo
(echo "You should take care to ensure that the distributions you're downloading
"
echo "are the ones you think you are downloading, and that they are as up to"
echo "date as you would expect (testing and unstable should be no more than"
echo "two or three days out of date, stable-updates no more than a few weeks"
echo "or a month)."
) | fmt
echo

cat /etc/apt/sources.list | 
  sed 's/^ *//' | grep '^[^#]' |
  while read ty url dist comps; do
        if [ "${url%%:*}" = "http" -o "${url%%:*}" = "ftp" ]; then
                baseurl="${url#*://}"
        else
                continue
        fi

        echo "Source: ${ty} ${url} ${dist} ${comps}"

        rm -f Release Release.gpg
        lynx -reload -dump "${url}/dists/${dist}/Release" >/dev/null 2>&1
        wget -q -O Release "${url}/dists/${dist}/Release"

        if ! grep -q '^' Release; then
                echo "  * NO TOP-LEVEL Release FILE"
                >Release
        else
                origline=`sed -n 's/^Origin: *//p' Release | head -1`
                lablline=`sed -n 's/^Label: *//p' Release | head -1`
                suitline=`sed -n 's/^Suite: *//p' Release | head -1`
                codeline=`sed -n 's/^Codename: *//p' Release | head -1`
                dateline=`grep "^Date:" Release | head -1`
                dscrline=`grep "^Description:" Release | head -1`
                echo "  o Origin: $origline/$lablline"
                echo "  o Suite: $suitline/$codeline"
                echo "  o $dateline"
                echo "  o $dscrline"

                if [ "${dist%%/*}" != "$suitline" -a "${dist%%/*}" != "$codeline" ]; then
                        echo "  * WARNING: asked for $dist, got $suitline/$codeline"
                fi

                lynx -reload -dump "${url}/dists/${dist}/Release.gpg" >/dev/null 2>&1
                wget -q -O Release.gpg "${url}/dists/${dist}/Release.gpg"

                gpgv --status-fd 3 Release.gpg Release 3>&1 >/dev/null 2>&1 | sed -n "s/^\[GNUPG:\] //p" | (okay=0; err=""; while read gpgcode rest; do
                        if [ "$gpgcode" = "GOODSIG" ]; then
                            if [ "$err" != "" ]; then
                                echo "  * Signed by ${err# } key: ${rest#* }"
                            else
                                echo "  o Signed by: ${rest#* }"
                                okay=1
                            fi
                            err=""
                        elif [ "$gpgcode" = "BADSIG" ]; then
                            echo "  * BAD SIGNATURE BY: ${rest#* }"
                            err=""
                        elif [ "$gpgcode" = "ERRSIG" ]; then
                            echo "  * COULDN'T CHECK SIGNATURE BY KEYID: ${rest %% *}"
                            err=""
                        elif [ "$gpgcode" = "SIGREVOKED" ]; then
                            err="$err REVOKED"
                        elif [ "$gpgcode" = "SIGEXPIRED" ]; then
                            err="$err EXPIRED"
                        fi
                    done
                    if [ "$okay" != 1 ]; then
                        echo "  * NO VALID SIGNATURE"
                        >Release
                    fi)
        fi
        okaycomps=""
        for comp in $comps; do
                if [ "$ty" = "deb" ]; then
                        X=$(checkit "`echo "${baseurl}/dists/${dist}/${comp}/binary-${arch}/Release" | sed 's,//*,_,g'`" "${comp}/binary-${arch}/Release")
                        Y=$(checkit "`echo "${baseurl}/dists/${dist}/${comp}/binary-${arch}/Packages" | sed 's,//*,_,g'`" "${comp}/binary-${arch}/Packages")
                        if [ "$X $Y" = "OK OK" ]; then
                                okaycomps="$okaycomps $comp"
                        else
                                echo "  * PROBLEMS WITH $comp ($X, $Y)"
                        fi
                elif [ "$ty" = "deb-src" ]; then
                        X=$(checkit "`echo "${baseurl}/dists/${dist}/${comp}/source/Release" | sed 's,//*,_,g'`" "${comp}/source/Release")
                        Y=$(checkit "`echo "${baseurl}/dists/${dist}/${comp}/source/Sources" | sed 's,//*,_,g'`" "${comp}/source/Sources")
                        if [ "$X $Y" = "OK OK" ]; then
                                okaycomps="$okaycomps $comp"
                        else
                                echo "  * PROBLEMS WITH component $comp ($X, $Y)"
                        fi
                fi
        done
        [ "$okaycomps" = "" ] || echo "  o Okay:$okaycomps"
        echo
  done

echo "Results"
echo "~~~~~~~"
echo

allokay=true

cd /tmp/apt-release-check
diff <(cat BAD MISSING NOCHECK OK | sort) <(cd /var/lib/apt/lists && find . -type f -maxdepth 1 | sed 's,^\./,,g' | grep '_' | sort) | sed -n 's/^> //p' >UNVALIDATED

cd /tmp/apt-release-check
if grep -q ^ UNVALIDATED; then
    allokay=false
    (echo "The following files in /var/lib/apt/lists have not been validated."
    echo "This could turn out to be a harmless indication that this script"
    echo "is buggy or out of date, or it could let trojaned packages get onto"
    echo "your system."
    ) | fmt
    echo
    sed 's/^/    /' < UNVALIDATED
    echo
fi

if grep -q ^ BAD; then
    allokay=false
    (echo "The contents of the following files in /var/lib/apt/lists does not"
    echo "match what was expected. This may mean these sources are out of date,"
    echo "that the archive is having problems, or that someone is actively"
    echo "using your mirror to distribute trojans."
    if am_root; then 
        echo "The files have been renamed to have the extension .FAILED and"
        echo "will be ignored by apt."
        cat BAD | while read a; do
            mv /var/lib/apt/lists/$a /var/lib/apt/lists/${a}.FAILED
        done
    fi) | fmt
    echo
    sed 's/^/    /' < BAD
    echo
fi

if grep -q ^ MISSING; then
    allokay=false
    (echo "The following files from /var/lib/apt/lists were missing. This"
    echo "may cause you to miss out on updates to some vulnerable packages."
    ) | fmt
    echo
    sed 's/^/    /' < MISSING
    echo
fi

if grep -q ^ NOCHECK; then
    allokay=false
    (echo "The contents of the following files in /var/lib/apt/lists could not"
    echo "be validated due to the lack of a signed Release file, or the lack"
    echo "of an appropriate entry in a signed Release file. This probably"
    echo "means that the maintainers of these sources are slack, but may mean"
    echo "these sources are being actively used to distribute trojans."
    if am_root; then 
        echo "The files have been renamed to have the extension .FAILED and"
        echo "will be ignored by apt."
        cat NOCHECK | while read a; do
            mv /var/lib/apt/lists/$a /var/lib/apt/lists/${a}.FAILED
        done
    fi) | fmt
    echo
    sed 's/^/    /' < NOCHECK
    echo
fi

if $allokay; then
    echo 'Everything seems okay!'
    echo
fi

rm -rf /tmp/apt-release-check
</example>

<p>You might need to apply the following patch for <em>sid</em> since
<prgn>md5sum</prgn> adds an '-' after the sum when the input is stdin:

<example>
@@ -37,7 +37,7 @@
        local LOOKUP="$2"

        Y="`get_md5sumsize Release "$LOOKUP"`"
-       Y="`echo "$Y" | sed 's/^ *//;s/  */ /g'`"
+       Y="`echo "$Y" | sed 's/-//;s/^ *//;s/  */ /g'`"

        if [ ! -e "/var/lib/apt/lists/$FILE" ]; then
                if [ "$Y" = "" ]; then
@@ -55,7 +55,7 @@
                return
        fi
        X="`md5sum < /var/lib/apt/lists/$FILE` `wc -c < /var/lib/apt/lists/$FILE`"
-       X="`echo "$X" | sed 's/^ *//;s/  */ /g'`"
+       X="`echo "$X" | sed 's/-//;s/^ *//;s/  */ /g'`"
        if [ "$X" != "$Y" ]; then
                echo "$FILE" >>BAD
                echo "BAD"
</example>

<sect1 id="check-non-debian-releases">Release check of non Debian sources

<P>Notice that, when using the latest apt version (with <em>secure apt</em>) no extra
effort should be required on your part unless you use non-Debian
sources, in which case an extra confirmation step will be required by
apt-get. This is avoided by providing <file>Release</file> and <file>Release.gpg</file> files in
the non-Debian sources. The <file>Release</file> file can be generated with
<prgn>apt-ftparchive</prgn> (available in <package>apt-utils</package> 0.5.0 and later), 
the <file>Release.gpg</file> is just a detached signature. 
To generate both follow this simple procedure:

<example>
$ rm -f dists/unstable/Release
$ apt-ftparchive release dists/unstable > dists/unstable/Release
$ gpg --sign -ba -o dists/unstable/Release.gpg dists/unstable/Release
</example>

<sect1 id="check-pkg-sign">Alternative per-package signing scheme

<p>The additional scheme of signing each and every packages allows
packages to be checked when they are no longer referenced by an
existing <file>Packages</file> file, and also third-party packages where no
<file>Packages</file> ever existed for them can be also used in Debian but will not
be default scheme.

<p>This package signing scheme can be implemented using
<package>debsig-verify</package> and <package>debsigs</package>.
These two packages can sign and verify
embedded signatures in the .deb itself. Debian already has the
capability to do this now, but there is no feature plan to
implement the policy or other tools since the archive signing scheme 
is prefered. These tools are available for users and archive 
administrators that would rather use this scheme instead.

<p>Latest <prgn>dpkg</prgn> versions (since 1.9.21) incorporate a 
<url
id="http://lists.debian.org/debian-dpkg/2001/debian-dpkg-200103/msg00024.html"
name="patch"> that provides this functionality as soon as 
<package>debsig-verify</package> is installed.

<p>NOTE: Currently <file>/etc/dpkg/dpkg.cfg</file> ships with
"no-debsig" as per default.

<p>NOTE2: Signatures from developers are currently stripped when they
enter off the package archive since the currently preferred method is
release checks as described previously.

