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  => 'keyserver.ubuntu.com',
  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 weak_ssl
  33 #    Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
  34 #
  35 # @param options
  36 #   Passes additional options to `apt-key adv --keyserver-options`.
  37 #
  38 define apt::key (
  39   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,
  40   Enum['present', 'absent', 'refreshed'] $ensure                                                                        = present,
  41   Optional[String] $content                                                                                             = undef,
  42   Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]] $source                                                   = undef,
  43   Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?(\/[a-zA-Z\d\-_.]+)*\/?$/] $server = $apt::keyserver,
  44   Boolean $weak_ssl                                                                                                     = false,
  45   Optional[String] $options                                                                                             = $apt::key_options,
  46 ) {
  47   case $ensure {
  48     /^(refreshed|present)$/: {
  49       if defined(Anchor["apt_key ${id} absent"]) {
  50         fail("key with id ${id} already ensured as absent")
  51       }
  52
  53       if !defined(Anchor["apt_key ${id} present"]) {
  54         apt_key { $title:
  55           ensure   => present,
  56           refresh  => $ensure == 'refreshed',
  57           id       => $id,
  58           source   => $source,
  59           content  => $content,
  60           server   => $server,
  61           weak_ssl => $weak_ssl,
  62           options  => $options,
  63         } -> anchor { "apt_key ${id} present": }
  64
  65         case $facts['os']['name'] {
  66           'Debian': {
  67             if versioncmp($facts['os']['release']['major'], '9') >= 0 {
  68               ensure_packages(['gnupg'])
  69               Apt::Key<| title == $title |>
  70             }
  71           }
  72           'Ubuntu': {
  73             if versioncmp($facts['os']['release']['full'], '17.04') >= 0 {
  74               ensure_packages(['gnupg'])
  75               Apt::Key<| title == $title |>
  76             }
  77           }
  78           default: {
  79             # Nothing in here
  80           }
  81         }
  82       }
  83     }
  84
  85     /^absent$/: {
  86       if defined(Anchor["apt_key ${id} present"]) {
  87         fail("key with id ${id} already ensured as present")
  88       }
  89
  90       if !defined(Anchor["apt_key ${id} absent"]) {
  91         apt_key { $title:
  92           ensure   => $ensure,
  93           id       => $id,
  94           source   => $source,
  95           content  => $content,
  96           server   => $server,
  97           weak_ssl => $weak_ssl,
  98           options  => $options,
  99         } -> anchor { "apt_key ${id} absent": }
 100       }
 101     }
 102
 103     default: {
 104       fail("Invalid \'ensure\' value \'${ensure}\' for apt::key")
 105     }
 106   }
 107 }