+# @summary Manages the GPG keys that Apt uses to authenticate packages.
+#
+# @note
+# The apt::key defined type makes use of the apt_key type, but includes extra functionality to help prevent duplicate keys.
+#
+# @example Declare Apt key for apt.puppetlabs.com source
+# apt::key { 'puppetlabs':
+# id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
+# server => 'hkps.pool.sks-keyservers.net',
+# options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
+# }
+#
+# @param id
+# Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal
+# characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters).
+#
+# @param ensure
+# Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto
+# update when they have expired (assuming a new key exists on the key server).
+#
+# @param content
+# 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.
+#
+# @param source
+# Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or
+# an absolute path.
+#
+# @param server
+# Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
+# hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
+#
+# @param options
+# Passes additional options to `apt-key adv --keyserver-options`.
+#
define apt::key (
- $key = $title,
- $ensure = present,
- $key_content = false,
- $key_source = false,
- $key_server = 'keyserver.ubuntu.com',
- $key_options = false
-) {
+ 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,
+ Enum['present', 'absent', 'refreshed'] $ensure = present,
+ Optional[String] $content = undef,
+ Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]] $source = undef,
+ Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/] $server = $::apt::keyserver,
+ Optional[String] $options = undef,
+ ) {
- include apt::params
-
- $upkey = upcase($key)
- # trim the key to the last 8 chars so we can match longer keys with apt-key list too
- $trimmedkey = regsubst($upkey, '^.*(.{8})$', '\1')
-
- if $key_content {
- $method = 'content'
- } elsif $key_source {
- $method = 'source'
- } elsif $key_server {
- $method = 'server'
- }
-
- # This is a hash of the parts of the key definition that we care about.
- # It is used as a unique identifier for this instance of apt::key. It gets
- # hashed to ensure that the resource name doesn't end up being pages and
- # pages (e.g. in the situation where key_content is specified).
- $digest = sha1("${upkey}/${key_content}/${key_source}/${key_server}/")
-
- # Allow multiple ensure => present for the same key to account for many
- # apt::source resources that all reference the same key.
case $ensure {
- present: {
-
- anchor { "apt::key/${title}": }
-
- if defined(Exec["apt::key ${upkey} absent"]) {
- fail("Cannot ensure Apt::Key[${upkey}] present; ${upkey} already ensured absent")
- }
-
- if !defined(Anchor["apt::key ${upkey} present"]) {
- anchor { "apt::key ${upkey} present": }
+ /^(refreshed|present)$/: {
+ if defined(Anchor["apt_key ${id} absent"]){
+ fail(translate('key with id %{_id} already ensured as absent'), {'_id' => id})
}
- if $key_options{
- $options_string = "--keyserver-options ${key_options}"
- }
- else{
- $options_string = ''
- }
+ if !defined(Anchor["apt_key ${id} present"]) {
+ apt_key { $title:
+ ensure => present,
+ refresh => $ensure == 'refreshed',
+ id => $id,
+ source => $source,
+ content => $content,
+ server => $server,
+ options => $options,
+ } -> anchor { "apt_key ${id} present": }
- if !defined(Exec[$digest]) {
- $digest_command = $method ? {
- 'content' => "echo '${key_content}' | /usr/bin/apt-key add -",
- 'source' => "wget -q '${key_source}' -O- | apt-key add -",
- 'server' => "apt-key adv --keyserver '${key_server}' ${options_string} --recv-keys '${upkey}'",
- }
- exec { $digest:
- command => $digest_command,
- path => '/bin:/usr/bin',
- unless => "/usr/bin/apt-key list | /bin/grep '${trimmedkey}'",
- logoutput => 'on_failure',
- before => Anchor["apt::key ${upkey} present"],
+ case $facts['os']['name'] {
+ 'Debian': {
+ if versioncmp($facts['os']['release']['major'], '9') >= 0 {
+ ensure_packages(['dirmngr'])
+ Apt::Key<| title == $title |>
+ }
+ }
+ 'Ubuntu': {
+ if versioncmp($facts['os']['release']['full'], '17.04') >= 0 {
+ ensure_packages(['dirmngr'])
+ Apt::Key<| title == $title |>
+ }
+ }
+ default: { }
}
}
-
- Anchor["apt::key ${upkey} present"] -> Anchor["apt::key/${title}"]
-
}
- absent: {
- if defined(Anchor["apt::key ${upkey} present"]) {
- fail("Cannot ensure Apt::Key[${upkey}] absent; ${upkey} already ensured present")
+ absent: {
+ if defined(Anchor["apt_key ${id} present"]){
+ fail(translate('key with id %{_id} already ensured as present', {'_id' => id}))
}
- exec { "apt::key ${upkey} absent":
- command => "apt-key del '${upkey}'",
- path => '/bin:/usr/bin',
- onlyif => "apt-key list | grep '${trimmedkey}'",
- user => 'root',
- group => 'root',
- logoutput => 'on_failure',
+ if !defined(Anchor["apt_key ${id} absent"]){
+ apt_key { $title:
+ ensure => $ensure,
+ id => $id,
+ source => $source,
+ content => $content,
+ server => $server,
+ options => $options,
+ } -> anchor { "apt_key ${id} absent": }
}
}
default: {
- fail "Invalid 'ensure' value '${ensure}' for aptkey"
+ fail translate('Invalid \'ensure\' value \'%{_ensure}\' for apt::key', {'_ensure' => ensure})
}
}
}
Code Review / puppet-modules / puppetlabs-apt.git / blobdiff