Puppet Function: sshclient_options_to_augeas_ssh_config

Defined in:
lib/puppet/parser/functions/sshclient_options_to_augeas_ssh_config.rb
Function type:
Ruby 3.x API

Overview

sshclient_options_to_augeas_ssh_config() ⇒ Any

This function will convert a key-value hash to a format understandable by the augeas sshd_config provider It will also optionally deal with keys that should be absent, and inject static parameters if supplied.

Usage: sshclient_options_to_augeas_ssh_config($options_present, $options_absent, $other_parameters)

  • $options_hash is mandatory and must be a hash.

  • $options_absent is optional and can be either a single value or an array.

  • $other_parameters is optional and must be a hash.

Example: $options = {

   'Host *.example.com' => {
      'ForwardAgent' => 'yes',
      'BatchMode'    => 'yes',
   },
   'ForwardAgent'           => 'no',
   'BatchMode'              => 'no',
   'StrictHostKeyChecking'  => 'no',
}

$options_absent = [‘StrictHostKeyChecking’,‘NoneField’] $other_parameters = { ‘target’ => ‘/etc/ssh/ssh_config’ }

$options_final_augeas = sshclient_options_to_augeas_ssh_config($options, $options_absent, $other_parameters)

In this case, the value of $options_final_augeas would be:

‘ForwardAgent *.example.com’ => {

   'ensure'    => 'present',
   'host'      => '*.example.com',
   'key'       => 'ForwardAgent',
   'value'     => 'yes',
   'target'    => '/etc/ssh/ssh_config',
}

‘BatchMode *.example.com’ => {

   'ensure'    => 'present',
   'host'      => '*.example.com',
   'key'       => 'BatchMode',
   'value'     => 'yes',
   'target'    => '/etc/ssh/ssh_config',
}

‘ForwardAgent’ => {

   'ensure'    => 'present',
   'key'       => 'ForwardAgent',
   'value'     => 'yes',
   'target'    => '/etc/ssh/ssh_config',
}

‘BatchMode’ => {

   'ensure'    => 'present',
   'key'       => 'BatchMode',
   'value'     => 'yes',
   'target'    => '/etc/ssh/ssh_config',
}

‘StrictHostKeyChecking’ => {

   'ensure'    => 'absent',
   'key'       => 'StrictHostKeyChecking',
   'target'    => '/etc/ssh/ssh_config',
}
'NoneField' => {
   'ensure'    => 'absent',
   'key'       => 'NoneField',
   'target'    => '/etc/ssh/ssh_config',
}

Note how the word “Host” is stripped a

Returns:

  • (Any) 


4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/puppet/parser/functions/sshclient_options_to_augeas_ssh_config.rb', line 4

newfunction(:sshclient_options_to_augeas_ssh_config, type: :rvalue, doc: <<-DOC) do |args|
This function will convert a key-value hash to a format understandable by the augeas sshd_config provider
It will also optionally deal with keys that should be absent, and inject static parameters if supplied.

Usage: sshclient_options_to_augeas_ssh_config($options_present, $options_absent, $other_parameters)
-  $options_hash is mandatory and must be a hash.
-  $options_absent is optional and can be either a single value or an array.
-  $other_parameters is optional and must be a hash.

Example:
$options = {
              'Host *.example.com' => {
                 'ForwardAgent' => 'yes',
                 'BatchMode'    => 'yes',
              },
              'ForwardAgent'           => 'no',
              'BatchMode'              => 'no',
              'StrictHostKeyChecking'  => 'no',
           }
$options_absent = ['StrictHostKeyChecking','NoneField']
$other_parameters = { 'target' => '/etc/ssh/ssh_config' }

$options_final_augeas = sshclient_options_to_augeas_ssh_config($options, $options_absent, $other_parameters)

In this case, the value of $options_final_augeas would be:

'ForwardAgent *.example.com' => {
    'ensure'    => 'present',
    'host'      => '*.example.com',
    'key'       => 'ForwardAgent',
    'value'     => 'yes',
    'target'    => '/etc/ssh/ssh_config',
 }
'BatchMode *.example.com' => {
    'ensure'    => 'present',
    'host'      => '*.example.com',
    'key'       => 'BatchMode',
    'value'     => 'yes',
    'target'    => '/etc/ssh/ssh_config',
 }
'ForwardAgent' => {
    'ensure'    => 'present',
    'key'       => 'ForwardAgent',
    'value'     => 'yes',
    'target'    => '/etc/ssh/ssh_config',
 }
'BatchMode' => {
    'ensure'    => 'present',
    'key'       => 'BatchMode',
    'value'     => 'yes',
    'target'    => '/etc/ssh/ssh_config',
 }
'StrictHostKeyChecking' => {
    'ensure'    => 'absent',
    'key'       => 'StrictHostKeyChecking',
    'target'    => '/etc/ssh/ssh_config',
 }
 'NoneField' => {
    'ensure'    => 'absent',
    'key'       => 'NoneField',
    'target'    => '/etc/ssh/ssh_config',
 }

Note how the word "Host" is stripped away.

DOC

  raise Puppet::ParseError, 'sshclient_options_to_augeas_ssh_config: expects at least one argument' if args.empty?

  options = args[0]
  raise Puppet::ParseError, 'sshclient_options_to_augeas_ssh_config: first argument must be a hash' unless options.is_a?(Hash)

  options_absent = args[1] if args[1]
  other_parameters = args[2] if args[2]
  raise Puppet::ParseError, 'sshclient_options_to_augeas_ssh_config: second argument, if supplied, must be an array or a string' if options_absent && !(options_absent.is_a?(Array) || options_absent.is_a?(String))
  raise Puppet::ParseError, 'sshclient_options_to_augeas_ssh_config: third argument, if supplied, must be a hash' if other_parameters && !other_parameters.is_a?(Hash)

  options_final_augeas = {}
  options.each do |key1, value1|
    if value1.is_a?(Hash)
      value1.each do |key2, value2|
        v = { 'ensure' => 'present' }.merge('host' => key1.gsub('Host ', '')).merge('key' => key2, 'value' => value2)
        options_final_augeas["#{key2} #{key1.gsub('Host ', '')}"] = v.merge(other_parameters)
      end
    else
      options_final_augeas[key1] = { 'ensure' => 'present' }.merge('key' => key1, 'value' => value1).merge(other_parameters)
    end
  end
  options_absent.each do |value|
    options_final_augeas[value] = { 'ensure' => 'absent' }.merge('key' => value).merge(other_parameters)
  end
  return options_final_augeas
end