-# == Define: apt::key
+# @summary Manages the GPG keys that Apt uses to authenticate packages.
#
-# The apt::key defined type allows for keys to be added to apt's keyring
-# which is used for package validation. This defined type uses the apt_key
-# native type to manage keys. This is a simple wrapper around apt_key with
-# a few safeguards in place.
+# @note
+# The apt::key defined type makes use of the apt_key type, but includes extra functionality to help prevent duplicate keys.
#
-# === Parameters
+# @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"',
+# }
#
-# [*key*]
-# _default_: +$title+, the title/name of the resource
+# @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).
#
-# Is a GPG key ID. This key ID is validated with a regex enforcing it
-# to only contain valid hexadecimal characters, be precisely 8 or 16
-# characters long and optionally prefixed with 0x.
+# @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).
#
-# [*ensure*]
-# _default_: +present+
+# @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.
#
-# The state we want this key in, may be either one of:
-# * +present+
-# * +absent+
+# @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.
#
-# [*key_content*]
-# _default_: +undef+
+# @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.
#
-# This parameter can be used to pass in a GPG key as a
-# string in case it cannot be fetched from a remote location
-# and using a file resource is for other reasons inconvenient.
+# @param weak_ssl
+# Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
#
-# [*key_source*]
-# _default_: +undef+
+# @param options
+# Passes additional options to `apt-key adv --keyserver-options`.
#
-# This parameter can be used to pass in the location of a GPG
-# key. This URI can take the form of a:
-# * +URL+: ftp, http or https
-# * +path+: absolute path to a file on the target system.
-#
-# [*key_server*]
-# _default_: +undef+
-#
-# The keyserver from where to fetch our GPG key. It can either be a domain
-# name or url. It defaults to
-# undef which results in apt_key's default keyserver being used,
-# currently +keyserver.ubuntu.com+.
-#
-# [*key_options*]
-# _default_: +undef+
-#
-# Additional options to pass on to `apt-key adv --keyserver-options`.
define apt::key (
- $key = $title,
- $ensure = present,
- $key_content = undef,
- $key_source = undef,
- $key_server = undef,
- $key_options = undef,
+ 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,
) {
-
- validate_re($key, ['\A(0x)?[0-9a-fA-F]{8}\Z', '\A(0x)?[0-9a-fA-F]{16}\Z'])
- validate_re($ensure, ['\Aabsent|present\Z',])
-
- if $key_content {
- validate_string($key_content)
- }
-
- if $key_source {
- validate_re($key_source, ['\Ahttps?:\/\/', '\Aftp:\/\/', '\A\/\w+'])
- }
-
- if $key_server {
- validate_re($key_server,['\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$'])
- }
-
- if $key_options {
- validate_string($key_options)
- }
-
case $ensure {
- present: {
- if defined(Anchor["apt_key ${key} absent"]){
- fail("key with id ${key} already ensured as absent")
+ /^(refreshed|present)$/: {
+ if defined(Anchor["apt_key ${id} absent"]) {
+ fail("key with id ${id} already ensured as absent")
}
- if !defined(Anchor["apt_key ${key} present"]) {
+ if !defined(Anchor["apt_key ${id} present"]) {
apt_key { $title:
- ensure => $ensure,
- id => $key,
- source => $key_source,
- content => $key_content,
- server => $key_server,
- keyserver_options => $key_options,
- } ->
- anchor { "apt_key ${key} present": }
+ ensure => present,
+ refresh => $ensure == 'refreshed',
+ id => $id,
+ source => $source,
+ content => $content,
+ server => $server,
+ weak_ssl => $weak_ssl,
+ options => $options,
+ } -> anchor { "apt_key ${id} present": }
+
+ case $facts['os']['name'] {
+ 'Debian': {
+ if versioncmp($facts['os']['release']['major'], '9') >= 0 {
+ ensure_packages(['gnupg'])
+ Apt::Key<| title == $title |>
+ }
+ }
+ 'Ubuntu': {
+ if versioncmp($facts['os']['release']['full'], '17.04') >= 0 {
+ ensure_packages(['gnupg'])
+ Apt::Key<| title == $title |>
+ }
+ }
+ default: {
+ # Nothing in here
+ }
+ }
}
}
- absent: {
- if defined(Anchor["apt_key ${key} present"]){
- fail("key with id ${key} already ensured as present")
+ /^absent$/: {
+ if defined(Anchor["apt_key ${id} present"]) {
+ fail("key with id ${id} already ensured as present")
}
- if !defined(Anchor["apt_key ${key} absent"]){
+ if !defined(Anchor["apt_key ${id} absent"]) {
apt_key { $title:
- ensure => $ensure,
- id => $key,
- source => $key_source,
- content => $key_content,
- server => $key_server,
- keyserver_options => $key_options,
- } ->
- anchor { "apt_key ${key} absent": }
+ 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 apt::key"
+ fail("Invalid \'ensure\' value \'${ensure}\' for apt::key")
}
}
}
Code Review / puppet-modules / puppetlabs-apt.git / blobdiff