doc/apt-key.8.xml

   1 <?xml version="1.0" encoding="utf-8" standalone="no"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4 <!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
   5 <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
   6 <!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
   7 ]>
   8
   9 <refentry>
  10  <refentryinfo>
  11    &apt-author.jgunthorpe;
  12    &apt-author.team;
  13    &apt-email;
  14    &apt-product;
  15    <!-- The last update date -->
  16    <date>2015-10-15T00:00:00Z</date>
  17  </refentryinfo>
  18
  19  <refmeta>
  20    <refentrytitle>apt-key</refentrytitle>
  21    <manvolnum>8</manvolnum>
  22    <refmiscinfo class="manual">APT</refmiscinfo>
  23  </refmeta>
  24
  25  <!-- Man page title -->
  26  <refnamediv>
  27     <refname>apt-key</refname>
  28     <refpurpose>APT key management utility</refpurpose>
  29  </refnamediv>
  30
  31  &synopsis-command-apt-key;
  32
  33  <refsect1><title>Description</title>
  34    <para>
  35    <command>apt-key</command> is used to manage the list of keys used
  36    by apt to authenticate packages.  Packages which have been
  37    authenticated using these keys will be considered trusted.
  38    </para>
  39 </refsect1>
  40
  41 <refsect1><title>Commands</title>
  42    <variablelist>
  43      <varlistentry><term><option>add</option> <option>&synopsis-param-filename;</option></term>
  44      <listitem>
  45      <para>
  46        Add a new key to the list of trusted keys.
  47        The key is read from the filename given with the parameter
  48        &synopsis-param-filename; or if the filename is <literal>-</literal>
  49        from standard input.
  50      </para>
  51      <para>
  52      It is critical that keys added manually via <command>apt-key</command> are
  53      verified to belong to the owner of the repositories they claim to be for
  54      otherwise the &apt-secure; infrastructure is completely undermined.
  55      </para>
  56      </listitem>
  57      </varlistentry>
  58
  59      <varlistentry><term><option>del</option> <option>&synopsis-param-keyid;</option></term>
  60      <listitem>
  61      <para>
  62
  63        Remove a key from the list of trusted keys.
  64
  65      </para>
  66
  67      </listitem>
  68      </varlistentry>
  69
  70      <varlistentry><term><option>export</option> <option>&synopsis-param-keyid;</option></term>
  71      <listitem>
  72      <para>
  73
  74         Output the key &synopsis-param-keyid; to standard output.
  75
  76      </para>
  77
  78      </listitem>
  79      </varlistentry>
  80
  81      <varlistentry><term><option>exportall</option></term>
  82      <listitem>
  83      <para>
  84
  85         Output all trusted keys to standard output.
  86
  87      </para>
  88
  89      </listitem>
  90      </varlistentry>
  91
  92      <varlistentry><term><option>list</option>, <option>finger</option></term>
  93      <listitem>
  94      <para>
  95
  96        List trusted keys with fingerprints.
  97
  98      </para>
  99
 100      </listitem>
 101      </varlistentry>
 102
 103      <varlistentry><term><option>adv</option></term>
 104      <listitem>
 105      <para>
 106      Pass advanced options to gpg. With <command>adv --recv-key</command> you
 107      can e.g. download key from keyservers directly into the the trusted set of
 108      keys. Note that there are <emphasis>no</emphasis> checks performed, so it is
 109      easy to completely undermine the &apt-secure; infrastructure if used without
 110      care.
 111      </para>
 112
 113      </listitem>
 114      </varlistentry>
 115
 116      <varlistentry><term><option>update</option></term>
 117      <listitem>
 118      <para>
 119
 120        Update the local keyring with the archive keyring and remove from
 121        the local keyring the archive keys which are no longer valid.
 122        The archive keyring is shipped in the <literal>archive-keyring</literal> package of your
 123        distribution, e.g. the &keyring-package; package in &keyring-distro;.
 124
 125      </para>
 126
 127      </listitem>
 128      </varlistentry>
 129
 130      <varlistentry><term><option>net-update</option></term>
 131      <listitem>
 132      <para>
 133
 134        Perform an update working similarly to the <command>update</command> command above,
 135        but get the archive keyring from a URI instead and validate it against a master key.
 136
 137        This requires an installed &wget; and an APT build configured to have
 138        a server to fetch from and a master keyring to validate.
 139
 140        APT in Debian does not support this command, relying on
 141        <command>update</command> instead, but Ubuntu's APT does.
 142
 143      </para>
 144
 145      </listitem>
 146      </varlistentry>
 147    </variablelist>
 148 </refsect1>
 149
 150  <refsect1><title>Options</title>
 151 <para>Note that options need to be defined before the commands described in the previous section.</para>
 152    <variablelist>
 153       <varlistentry><term><option>--keyring</option> <option>&synopsis-param-filename;</option></term>
 154       <listitem><para>With this option it is possible to specify a particular keyring
 155       file the command should operate on. The default is that a command is executed
 156       on the <filename>trusted.gpg</filename> file as well as on all parts in the
 157       <filename>trusted.gpg.d</filename> directory, though <filename>trusted.gpg</filename>
 158       is the primary keyring which means that e.g. new keys are added to this one.
 159       </para></listitem>
 160       </varlistentry>
 161    </variablelist>
 162  </refsect1>
 163
 164  <refsect1><title>Files</title>
 165    <variablelist>
 166
 167      &file-trustedgpg;
 168
 169      <varlistentry><term><filename>/etc/apt/trustdb.gpg</filename></term>
 170      <listitem><para>Local trust database of archive keys.</para></listitem>
 171      </varlistentry>
 172
 173      <varlistentry><term>&keyring-filename;</term>
 174      <listitem><para>Keyring of &keyring-distro; archive trusted keys.</para></listitem>
 175      </varlistentry>
 176
 177      <varlistentry><term>&keyring-removed-filename;</term>
 178      <listitem><para>Keyring of &keyring-distro; archive removed trusted keys.</para></listitem>
 179      </varlistentry>
 180
 181    </variablelist>
 182
 183 </refsect1>
 184
 185 <refsect1><title>See Also</title>
 186 <para>
 187 &apt-get;, &apt-secure;
 188 </para>
 189 </refsect1>
 190
 191  &manbugs;
 192  &manauthor;
 193
 194 </refentry>
 195