+# @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 => 'keyserver.ubuntu.com',
+# 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 weak_ssl
+# Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
+#
+# @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"
+ 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})?(\/[a-zA-Z\d\-_.]+)*\/?$/] $server = $apt::keyserver,
+ Boolean $weak_ssl = false,
+ Optional[String] $options = $apt::key_options,
) {
-
- include apt::params
-
- $upkey = upcase($key)
-
- 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")
+ /^(refreshed|present)$/: {
+ if defined(Anchor["apt_key ${id} absent"]) {
+ fail("key with id ${id} already ensured as absent")
}
- if !defined(Anchor["apt::key $upkey present"]) {
- anchor { "apt::key $upkey present":; }
- }
+ if !defined(Anchor["apt_key ${id} present"]) {
+ apt_key { $title:
+ ensure => present,
+ refresh => $ensure == 'refreshed',
+ id => $id,
+ source => $source,
+ content => $content,
+ server => $server,
+ weak_ssl => $weak_ssl,
+ options => $options,
+ } -> anchor { "apt_key ${id} present": }
- if !defined(Exec[$digest]) {
- exec { $digest:
- path => "/bin:/usr/bin",
- unless => "/usr/bin/apt-key list | /bin/grep '${upkey}'",
- before => Anchor["apt::key $upkey present"],
- 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}' --recv-keys '${upkey}'",
- };
+ case $facts['os']['name'] {
+ 'Debian': {
+ if versioncmp($facts['os']['release']['major'], '9') >= 0 {
+ stdlib::ensure_packages(['gnupg'])
+ Apt::Key<| title == $title |>
+ }
+ }
+ 'Ubuntu': {
+ if versioncmp($facts['os']['release']['full'], '17.04') >= 0 {
+ stdlib::ensure_packages(['gnupg'])
+ Apt::Key<| title == $title |>
+ }
+ }
+ default: {
+ # Nothing in here
+ }
}
}
-
- 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("key with id ${id} already ensured as present")
}
- exec { "apt::key $upkey absent":
- path => "/bin:/usr/bin",
- onlyif => "apt-key list | grep '$upkey'",
- command => "apt-key del '$upkey'",
- user => "root",
- group => "root",
+ if !defined(Anchor["apt_key ${id} absent"]) {
+ apt_key { $title:
+ ensure => $ensure,
+ id => $id,
+ source => $source,
+ content => $content,
+ server => $server,
+ weak_ssl => $weak_ssl,
+ options => $options,
+ } -> anchor { "apt_key ${id} absent": }
}
}
default: {
- fail "Invalid 'ensure' value '$ensure' for aptkey"
+ fail("Invalid \'ensure\' value \'${ensure}\' for apt::key")
}
}
}
Code Review / puppet-modules / puppetlabs-apt.git / blobdiff