manifests/key.pp

   1 # @summary Manages the GPG keys that Apt uses to authenticate packages.
   2 #
   3 # @note
   4 #   The apt::key defined type makes use of the apt_key type, but includes extra functionality to help prevent duplicate keys.
   5 #
   6 # @example Declare Apt key for apt.puppetlabs.com source
   7 #   apt::key { 'puppetlabs':
   8 #     id      => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
   9 #     server  => 'hkps.pool.sks-keyservers.net',
  10 #     options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
  11 #   }
  12 #
  13 # @param id
  14 #   Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal
  15 #   characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters).
  16 #
  17 # @param ensure
  18 #   Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto
  19 #   update when they have expired (assuming a new key exists on the key server).
  20 #
  21 # @param content
  22 #   Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient.
  23 #
  24 # @param source
  25 #   Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or
  26 #   an absolute path.
  27 #
  28 # @param server
  29 #   Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
  30 #   hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
  31 #
  32 # @param options
  33 #   Passes additional options to `apt-key adv --keyserver-options`.
  34 #
  35 define apt::key (
  36   Pattern[/\A(0x)?[0-9a-fA-F]{8}\Z/, /\A(0x)?[0-9a-fA-F]{16}\Z/, /\A(0x)?[0-9a-fA-F]{40}\Z/] $id     = $title,
  37   Enum['present', 'absent', 'refreshed'] $ensure                                                     = present,
  38   Optional[String] $content                                                                          = undef,
  39   Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]] $source                                = undef,
  40   Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/] $server = $::apt::keyserver,
  41   Optional[String] $options                                                                          = undef,
  42   ) {
  43
  44   case $ensure {
  45     /^(refreshed|present)$/: {
  46       if defined(Anchor["apt_key ${id} absent"]){
  47         fail(translate('key with id %{_id} already ensured as absent'), {'_id' => id})
  48       }
  49
  50       if !defined(Anchor["apt_key ${id} present"]) {
  51         apt_key { $title:
  52           ensure  => present,
  53           refresh => $ensure == 'refreshed',
  54           id      => $id,
  55           source  => $source,
  56           content => $content,
  57           server  => $server,
  58           options => $options,
  59         } -> anchor { "apt_key ${id} present": }
  60
  61         case $facts['os']['name'] {
  62           'Debian': {
  63             if versioncmp($facts['os']['release']['major'], '9') >= 0 {
  64               ensure_packages(['dirmngr'])
  65               Apt::Key<| title == $title |>
  66             }
  67           }
  68           'Ubuntu': {
  69             if versioncmp($facts['os']['release']['full'], '17.04') >= 0 {
  70               ensure_packages(['dirmngr'])
  71               Apt::Key<| title == $title |>
  72             }
  73           }
  74           default: { }
  75         }
  76       }
  77     }
  78
  79     absent: {
  80       if defined(Anchor["apt_key ${id} present"]){
  81         fail(translate('key with id %{_id} already ensured as present', {'_id' => id}))
  82       }
  83
  84       if !defined(Anchor["apt_key ${id} absent"]){
  85         apt_key { $title:
  86           ensure  => $ensure,
  87           id      => $id,
  88           source  => $source,
  89           content => $content,
  90           server  => $server,
  91           options => $options,
  92         } -> anchor { "apt_key ${id} absent": }
  93       }
  94     }
  95
  96     default: {
  97       fail translate('Invalid \'ensure\' value \'%{_ensure}\' for apt::key', {'_ensure' => ensure})
  98     }
  99   }
 100 }