+# == Define: apt::key
+#
+# 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.
+#
+# === Parameters
+#
+# [*key*]
+# _default_: +$title+, the title/name of the resource
+#
+# 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.
+#
+# [*ensure*]
+# _default_: +present+
+#
+# The state we want this key in, may be either one of:
+# * +present+
+# * +absent+
+#
+# [*key_content*]
+# _default_: +undef+
+#
+# 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.
+#
+# [*key_source*]
+# _default_: +undef+
+#
+# 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 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 = false,
- $key_source = false,
- $key_server = 'keyserver.ubuntu.com',
- $key_options = false
+ $key = $title,
+ $ensure = present,
+ $key_content = undef,
+ $key_source = undef,
+ $key_server = undef,
+ $key_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')
+ 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 {
- $method = 'content'
- } elsif $key_source {
- $method = 'source'
- } elsif $key_server {
- $method = 'server'
+ validate_string($key_content)
}
- # 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 $key_source {
+ validate_re($key_source, ['\Ahttps?:\/\/', '\Aftp:\/\/', '\A\/\w+'])
+ }
- if defined(Exec["apt::key ${upkey} absent"]) {
- fail("Cannot ensure Apt::Key[${upkey}] present; ${upkey} already ensured absent")
- }
+ if $key_server {
+ if !is_domain_name($key_server) {
+ fail('$key_server must be a valid domain name')
+ }
+ }
- if !defined(Anchor["apt::key ${upkey} present"]) {
- anchor { "apt::key ${upkey} present": }
- }
+ if $key_options {
+ validate_string($key_options)
+ }
- if $key_options{
- $options_string = "--keyserver-options ${key_options}"
- }
- else{
- $options_string = ''
+ case $ensure {
+ present: {
+ if defined(Anchor["apt_key ${key} absent"]){
+ fail("key with id ${key} already ensured as absent")
}
- 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"],
- }
+ if !defined(Anchor["apt_key ${key} 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": }
}
-
- 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 ${key} present"]){
+ fail("key with id ${key} already ensured as present")
}
- 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 ${key} 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": }
}
}
default: {
- fail "Invalid 'ensure' value '${ensure}' for aptkey"
+ fail "Invalid 'ensure' value '${ensure}' for apt::key"
}
}
}
require 'spec_helper'
+
describe 'apt::key', :type => :define do
let(:facts) { { :lsbdistid => 'Debian' } }
+ GPG_KEY_ID = '4BD6EC30'
+
let :title do
- '8347A27F'
+ GPG_KEY_ID
end
- let :default_params do
- {
- :key => title,
- :ensure => 'present',
- :key_server => "keyserver.ubuntu.com",
- :key_source => false,
- :key_content => false
- }
- end
+ describe 'normal operation' do
+ describe 'default options' do
+ it 'contains the apt::key' do
+ should contain_apt__key(title).with({
+ :key => title,
+ :ensure => 'present',
+ })
+ end
+ it 'contains the apt_key' do
+ should contain_apt_key(title).with({
+ :id => title,
+ :ensure => 'present',
+ :source => nil,
+ :server => nil,
+ :content => nil,
+ :keyserver_options => nil,
+ })
+ end
+ it 'contains the apt_key present anchor' do
+ should contain_anchor("apt_key #{title} present")
+ end
+ end
+
+ describe 'title and key =>' do
+ let :title do
+ 'puppetlabs'
+ end
+
+ let :params do {
+ :key => GPG_KEY_ID,
+ } end
+
+ it 'contains the apt::key' do
+ should contain_apt__key(title).with({
+ :key => GPG_KEY_ID,
+ :ensure => 'present',
+ })
+ end
+ it 'contains the apt_key' do
+ should contain_apt_key(title).with({
+ :id => GPG_KEY_ID,
+ :ensure => 'present',
+ :source => nil,
+ :server => nil,
+ :content => nil,
+ :keyserver_options => nil,
+ })
+ end
+ it 'contains the apt_key present anchor' do
+ should contain_anchor("apt_key #{GPG_KEY_ID} present")
+ end
+ end
- [{},
- {
- :ensure => 'absent'
- },
- {
- :ensure => 'random'
- },
- {
- :key_source => 'ftp://ftp.example.org/key',
- },
- {
- :key_content => 'deadbeef',
- }
- ].each do |param_set|
-
- let :param_hash do
- param_hash = default_params.merge(param_set)
- param_hash[:key].upcase! if param_hash[:key]
- param_hash
+ describe 'ensure => absent' do
+ let :params do {
+ :ensure => 'absent',
+ } end
+
+ it 'contains the apt::key' do
+ should contain_apt__key(title).with({
+ :key => title,
+ :ensure => 'absent',
+ })
+ end
+ it 'contains the apt_key' do
+ should contain_apt_key(title).with({
+ :id => title,
+ :ensure => 'absent',
+ :source => nil,
+ :server => nil,
+ :content => nil,
+ :keyserver_options => nil,
+ })
+ end
+ it 'contains the apt_key absent anchor' do
+ should contain_anchor("apt_key #{title} absent")
+ end
end
- let :params do
- param_set
+ describe 'key_content =>' do
+ let :params do {
+ :key_content => 'GPG key content',
+ } end
+
+ it 'contains the apt::key' do
+ should contain_apt__key(title).with({
+ :key => title,
+ :ensure => 'present',
+ :key_content => params[:key_content],
+ })
+ end
+ it 'contains the apt_key' do
+ should contain_apt_key(title).with({
+ :id => title,
+ :ensure => 'present',
+ :source => nil,
+ :server => nil,
+ :content => params[:key_content],
+ :keyserver_options => nil,
+ })
+ end
+ it 'contains the apt_key present anchor' do
+ should contain_anchor("apt_key #{title} present")
+ end
end
- let :digest do
- str = String.new
- str << param_hash[:key].to_s << '/'
- str << param_hash[:key_content].to_s << '/'
- str << param_hash[:key_source].to_s << '/'
- str << param_hash[:key_server].to_s << '/'
- Digest::SHA1.hexdigest(str)
+ describe 'key_source =>' do
+ let :params do {
+ :key_source => 'http://apt.puppetlabs.com/pubkey.gpg',
+ } end
+
+ it 'contains the apt::key' do
+ should contain_apt__key(title).with({
+ :key => title,
+ :ensure => 'present',
+ :key_source => params[:key_source],
+ })
+ end
+ it 'contains the apt_key' do
+ should contain_apt_key(title).with({
+ :id => title,
+ :ensure => 'present',
+ :source => params[:key_source],
+ :server => nil,
+ :content => nil,
+ :keyserver_options => nil,
+ })
+ end
+ it 'contains the apt_key present anchor' do
+ should contain_anchor("apt_key #{title} present")
+ end
+ end
+
+ describe 'key_server =>' do
+ let :params do {
+ :key_server => 'pgp.mit.edu',
+ } end
+
+ it 'contains the apt::key' do
+ should contain_apt__key(title).with({
+ :key => title,
+ :ensure => 'present',
+ :key_server => 'pgp.mit.edu',
+ })
+ end
+ it 'contains the apt_key' do
+ should contain_apt_key(title).with({
+ :id => title,
+ :ensure => 'present',
+ :source => nil,
+ :server => params[:key_server],
+ :content => nil,
+ :keyserver_options => nil,
+ })
+ end
+ it 'contains the apt_key present anchor' do
+ should contain_anchor("apt_key #{title} present")
+ end
end
- describe "when #{param_set == {} ? "using default" : "specifying"} define parameters" do
-
- it {
- if [:present, 'present', :absent, 'absent'].include? param_hash[:ensure]
- should contain_apt__params
- end
- }
-
- it {
- if [:present, 'present'].include? param_hash[:ensure]
- should_not contain_exec("apt::key #{param_hash[:key]} absent")
- should contain_anchor("apt::key #{param_hash[:key]} present")
- should contain_exec(digest).with({
- "path" => "/bin:/usr/bin",
- "unless" => "/usr/bin/apt-key list | /bin/grep '#{param_hash[:key]}'"
- })
- elsif [:absent, 'absent'].include? param_hash[:ensure]
- should_not contain_anchor("apt::key #{param_hash[:key]} present")
- should contain_exec("apt::key #{param_hash[:key]} absent").with({
- "path" => "/bin:/usr/bin",
- "onlyif" => "apt-key list | grep '#{param_hash[:key]}'",
- "command" => "apt-key del '#{param_hash[:key]}'"
- })
- else
- expect { should raise_error(Puppet::Error) }
- end
- }
-
- it {
- if [:present, 'present'].include? param_hash[:ensure]
- if param_hash[:key_content]
- should contain_exec(digest).with({
- "command" => "echo '#{param_hash[:key_content]}' | /usr/bin/apt-key add -"
- })
- elsif param_hash[:key_source]
- should contain_exec(digest).with({
- "command" => "wget -q '#{param_hash[:key_source]}' -O- | apt-key add -"
- })
- elsif param_hash[:key_server]
- should contain_exec(digest).with({
- "command" => "apt-key adv --keyserver '#{param_hash[:key_server]}' --recv-keys '#{param_hash[:key]}'"
- })
- end
- end
- }
+ describe 'key_options =>' do
+ let :params do {
+ :key_options => 'debug',
+ } end
+ it 'contains the apt::key' do
+ should contain_apt__key(title).with({
+ :key => title,
+ :ensure => 'present',
+ :key_options => 'debug',
+ })
+ end
+ it 'contains the apt_key' do
+ should contain_apt_key(title).with({
+ :id => title,
+ :ensure => 'present',
+ :source => nil,
+ :server => nil,
+ :content => nil,
+ :keyserver_options => params[:key_options],
+ })
+ end
+ it 'contains the apt_key present anchor' do
+ should contain_anchor("apt_key #{title} present")
+ end
end
end
- [{ :ensure => 'present' }, { :ensure => 'absent' }].each do |param_set|
- describe "should correctly handle duplicate definitions" do
+ describe 'validation' do
+ context 'invalid key' do
+ let :title do
+ 'Out of rum. Why? Why are we out of rum?'
+ end
+ it 'fails' do
+ expect { subject }.to raise_error(/does not match/)
+ end
+ end
- let :pre_condition do
- "apt::key { 'duplicate': key => '#{title}'; }"
+ context 'invalid source' do
+ let :params do {
+ :key_source => 'afp://puppetlabs.com/key.gpg',
+ } end
+ it 'fails' do
+ expect { subject }.to raise_error(/does not match/)
end
+ end
- let(:params) { param_set }
+ context 'invalid content' do
+ let :params do {
+ :key_content => [],
+ } end
+ it 'fails' do
+ expect { subject }.to raise_error(/is not a string/)
+ end
+ end
- it {
- if param_set[:ensure] == 'present'
- should contain_anchor("apt::key #{title} present")
- should contain_apt__key(title)
- should contain_apt__key("duplicate")
- elsif param_set[:ensure] == 'absent'
- expect { should raise_error(Puppet::Error) }
- end
- }
+ context 'invalid server' do
+ let :params do {
+ :key_server => 'two bottles of rum',
+ } end
+ it 'fails' do
+ expect { subject }.to raise_error(/must be a valid domain name/)
+ end
+ end
+ context 'invalid keyserver_options' do
+ let :params do {
+ :key_options => {},
+ } end
+ it 'fails' do
+ expect { subject }.to raise_error(/is not a string/)
+ end
end
end
-end
+ describe 'duplication' do
+ context 'two apt::key resources for same key, different titles' do
+ let :pre_condition do
+ "apt::key { 'duplicate': key => #{title}, }"
+ end
+ it 'contains two apt::key resources' do
+ should contain_apt__key('duplicate').with({
+ :key => title,
+ :ensure => 'present',
+ })
+ should contain_apt__key(title).with({
+ :key => title,
+ :ensure => 'present',
+ })
+ end
+
+ it 'contains only a single apt_key' do
+ should contain_apt_key('duplicate').with({
+ :id => title,
+ :ensure => 'present',
+ :source => nil,
+ :server => nil,
+ :content => nil,
+ :keyserver_options => nil,
+ })
+ should_not contain_apt_key(title)
+ end
+ end
+
+ context 'two apt::key resources, different ensure' do
+ let :pre_condition do
+ "apt::key { 'duplicate': key => #{title}, ensure => 'absent', }"
+ end
+ it 'informs the user of the impossibility' do
+ expect { subject }.to raise_error(/already ensured as absent/)
+ end
+ end
+ end
+end
Code Review / puppet-modules / puppetlabs-apt.git / commitdiff