Merge pull request #483 from bastelfreak/empty

usermanagement: prohibit empty ssh keys
puppetlabs · May 7, 2024 · 883ba88 · 883ba88
2 parents 927c433 + 9fab5e9
commit 883ba88
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -505,7 +505,7 @@ Default value: `'0600'`
 
 ##### <a name="-accounts--user--sshkeys"></a>`sshkeys`
 
-Data type: `Array[String]`
+Data type: `Array[String[1]]`
 
 An array of SSH public keys associated with the user. These should be
 complete public key strings that include the type, content and name of the
@@ -559,7 +559,7 @@ The returned options element can by an empty string.
 accounts_ssh_authorized_keys_line_parser_string('options ssh-rsa AAAA... comment)
 ```
 
-#### `accounts_ssh_authorized_keys_line_parser(String $str)`
+#### `accounts_ssh_authorized_keys_line_parser(String[1] $str)`
 
 Parse an ssh authorized_keys line string into an array using its expected
 pattern by using a combination of regex matching and extracting the substring
@@ -580,7 +580,7 @@ accounts_ssh_authorized_keys_line_parser_string('options ssh-rsa AAAA... comment
 
 ##### `str`
 
-Data type: `String`
+Data type: `String[1]`
 
 ssh authorized_keys line string
 

diff --git a/lib/puppet/functions/accounts_ssh_authorized_keys_line_parser.rb b/lib/puppet/functions/accounts_ssh_authorized_keys_line_parser.rb
@@ -12,7 +12,7 @@
   # @example Calling the function
   #   accounts_ssh_authorized_keys_line_parser_string('options ssh-rsa AAAA... comment)
   dispatch :accounts_ssh_authorized_keys_line_parser_string do
-    param 'String', :str
+    param 'String[1]', :str
   end
 
   def accounts_ssh_authorized_keys_line_parser_string(str)

diff --git a/manifests/key_management.pp b/manifests/key_management.pp
@@ -42,7 +42,7 @@
   Accounts::User::Name           $sshkey_group       = $group,
   Accounts::User::Name           $sshkey_owner       = $user,
   Variant[Integer[0],String]     $sshkey_mode        = '0600',
-  Array[String]                  $sshkeys            = [],
+  Array[String[1]]               $sshkeys            = [],
   Optional[Stdlib::Unixpath]     $user_home          = undef,
 ) {
   if $user_home {
@@ -98,7 +98,7 @@
   }
 
   if $sshkeys != [] {
-    $sshkeys.each |$sshkey| {
+    $sshkeys.each |String[1] $sshkey| {
       accounts::manage_keys { "${sshkey} for ${user}":
         ensure    => $ensure,
         keyspec   => $sshkey,

diff --git a/manifests/manage_keys.pp b/manifests/manage_keys.pp
@@ -20,7 +20,7 @@
 #
 define accounts::manage_keys (
   Stdlib::Unixpath         $key_file,
-  String                   $keyspec,
+  String[1]                $keyspec,
   Accounts::User::Name     $user,
   Enum['absent','present'] $ensure    = 'present',
   Accounts::User::Name     $key_owner = $user,

diff --git a/manifests/user.pp b/manifests/user.pp
@@ -213,7 +213,7 @@
   Optional[Accounts::User::Name]           $sshkey_group             = $group,
   Optional[Accounts::User::Name]           $sshkey_owner             = $name,
   Variant[Integer[0],String]               $sshkey_mode              = '0600',
-  Array[String]                            $sshkeys                  = [],
+  Array[String[1]]                         $sshkeys                  = [],
   Boolean                                  $system                   = false,
   Optional[Accounts::User::Uid]            $uid                      = undef,
 ) {

diff --git a/spec/functions/accounts_ssh_authorized_keys_line_parser_spec.rb b/spec/functions/accounts_ssh_authorized_keys_line_parser_spec.rb
@@ -8,7 +8,7 @@
   }
 
   it {
-    expect(subject).to run.with_params('').and_raise_error(ArgumentError, %r{Wrong Keyline format!})
+    expect(subject).to run.with_params('').and_raise_error(ArgumentError, %r{'accounts_ssh_authorized_keys_line_parser' parameter 'str' expects a String\[1\] value, got String})
   }
 
   it {
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,7 @@ @@
       }
       it {
-        expect(subject).to run.with_params('').and_raise_error(ArgumentError, %r{Wrong Keyline format!})
+        expect(subject).to run.with_params('').and_raise_error(ArgumentError, %r{'accounts_ssh_authorized_keys_line_parser' parameter 'str' expects a String\[1\] value, got String})
       }
       it {
@@ Expand Down @@