Defined Type: openssh::server::match

Defined in:
manifests/server/match.pp

Overview

Declare a SSH server match block

Examples:

Declaring an SFTP-only group

include ::openssh::server
::openssh::server::match { 'sftponly':
  group                => ['sftponly'],
  chroot_directory     => '%h',
  force_command        => 'internal-sftp',
  allow_tcp_forwarding => false,
  x11_forwarding       => false,
}

Parameters:

  • user (Optional[Array[String, 1]]) (defaults to: undef)
  • group (Optional[Array[String, 1]]) (defaults to: undef)
  • host (Optional[Array[String, 1]]) (defaults to: undef)
  • local_address (Optional[Array[String, 1]]) (defaults to: undef)
  • local_port (Optional[Array[String, 1]]) (defaults to: undef)
  • address (Optional[Array[String, 1]]) (defaults to: undef)
  • order (Variant[String, Integer[0]]) (defaults to: 10)
  • accept_env (Optional[Array[String, 1]]) (defaults to: undef)
  • allow_agent_forwarding (Optional[Boolean]) (defaults to: undef)
  • allow_groups (Optional[Array[String, 1]]) (defaults to: undef)
  • allow_stream_local_forwarding (Optional[Variant[Boolean, Enum['all', 'local', 'remote']]]) (defaults to: undef)
  • allow_tcp_forwarding (Optional[Variant[Boolean, Enum['all', 'local', 'remote']]]) (defaults to: undef)
  • allow_users (Optional[Array[String, 1]]) (defaults to: undef)
  • authentication_methods (Optional[Array[Array[String, 1], 1]]) (defaults to: undef)
  • authorized_keys_command (Optional[String]) (defaults to: undef)
  • authorized_keys_command_user (Optional[String]) (defaults to: undef)
  • authorized_keys_command_run_as (Optional[String]) (defaults to: undef)
  • authorized_keys_file (Optional[String]) (defaults to: undef)
  • authorized_principals_command (Optional[String]) (defaults to: undef)
  • authorized_principals_command_user (Optional[String]) (defaults to: undef)
  • authorized_principals_file (Optional[String]) (defaults to: undef)
  • banner (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • chroot_directory (Optional[String]) (defaults to: undef)
  • client_alive_count_max (Optional[Integer[0]]) (defaults to: undef)
  • client_alive_interval (Optional[Integer[0]]) (defaults to: undef)
  • deny_groups (Optional[Array[String, 1]]) (defaults to: undef)
  • deny_users (Optional[Array[String, 1]]) (defaults to: undef)
  • force_command (Optional[String]) (defaults to: undef)
  • gateway_ports (Optional[Variant[Boolean, Enum['clientspecified']]]) (defaults to: undef)
  • gssapi_authentication (Optional[Boolean]) (defaults to: undef)
  • hostbased_accepted_key_types (Optional[Array[String, 1]]) (defaults to: undef)
  • hostbased_authentication (Optional[Boolean]) (defaults to: undef)
  • hostbased_uses_name_from_packet_only (Optional[Boolean]) (defaults to: undef)
  • ip_qos (Optional[Tuple[OpenSSH::QoS, 1, 2]]) (defaults to: undef)
  • kbd_interactive_authentication (Optional[Boolean]) (defaults to: undef)
  • kerberos_authentication (Optional[Boolean]) (defaults to: undef)
  • kerberos_use_kuserok (Optional[Boolean]) (defaults to: undef)
  • max_auth_tries (Optional[Integer[0]]) (defaults to: undef)
  • max_sessions (Optional[Integer[0]]) (defaults to: undef)
  • password_authentication (Optional[Boolean]) (defaults to: undef)
  • permit_empty_passwords (Optional[Boolean]) (defaults to: undef)
  • permit_open (Optional[Variant[Enum['any', 'none'], Array[OpenSSH::PermitOpen, 1]]]) (defaults to: undef)
  • permit_root_login (Optional[Variant[Boolean, Enum['without-password', 'forced-commands-only']]]) (defaults to: undef)
  • permit_tty (Optional[Boolean]) (defaults to: undef)
  • permit_tunnel (Optional[Variant[Boolean, Enum['point-to-point', 'ethernet']]]) (defaults to: undef)
  • permit_user_rc (Optional[Boolean]) (defaults to: undef)
  • pubkey_authentication (Optional[Boolean]) (defaults to: undef)
  • rekey_limit (Optional[OpenSSH::RekeyLimit]) (defaults to: undef)
  • revoked_keys (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • stream_local_bind_mask (Optional[Pattern[/(?x) ^ [0-7]{4} $/]]) (defaults to: undef)
  • stream_local_bind_unlink (Optional[Boolean]) (defaults to: undef)
  • trusted_user_ca_keys (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • x11_display_offset (Optional[Integer[0]]) (defaults to: undef)
  • x11_forwarding (Optional[Boolean]) (defaults to: undef)
  • x11_max_displays (Optional[Integer[0]]) (defaults to: undef)
  • x11_use_localhost (Optional[Boolean]) (defaults to: undef)

See Also:



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'manifests/server/match.pp', line 71

define openssh::server::match (
  Optional[Array[String, 1]]                                                   $user                                 = undef,
  Optional[Array[String, 1]]                                                   $group                                = undef,
  Optional[Array[String, 1]]                                                   $host                                 = undef,
  Optional[Array[String, 1]]                                                   $local_address                        = undef,
  Optional[Array[String, 1]]                                                   $local_port                           = undef,
  Optional[Array[String, 1]]                                                   $address                              = undef,
  Variant[String, Integer[0]]                                                  $order                                = 10,
  # sshd_config settings below
  Optional[Array[String, 1]]                                                   $accept_env                           = undef,
  Optional[Boolean]                                                            $allow_agent_forwarding               = undef,
  Optional[Array[String, 1]]                                                   $allow_groups                         = undef,
  Optional[Variant[Boolean, Enum['all', 'local', 'remote']]]                   $allow_stream_local_forwarding        = undef,
  Optional[Variant[Boolean, Enum['all', 'local', 'remote']]]                   $allow_tcp_forwarding                 = undef,
  Optional[Array[String, 1]]                                                   $allow_users                          = undef,
  Optional[Array[Array[String, 1], 1]]                                         $authentication_methods               = undef,
  Optional[String]                                                             $authorized_keys_command              = undef,
  Optional[String]                                                             $authorized_keys_command_user         = undef,
  Optional[String]                                                             $authorized_keys_command_run_as       = undef,
  Optional[String]                                                             $authorized_keys_file                 = undef,
  Optional[String]                                                             $authorized_principals_command        = undef,
  Optional[String]                                                             $authorized_principals_command_user   = undef,
  Optional[String]                                                             $authorized_principals_file           = undef,
  Optional[Stdlib::Absolutepath]                                               $banner                               = undef,
  Optional[String]                                                             $chroot_directory                     = undef,
  Optional[Integer[0]]                                                         $client_alive_count_max               = undef,
  Optional[Integer[0]]                                                         $client_alive_interval                = undef,
  Optional[Array[String, 1]]                                                   $deny_groups                          = undef,
  Optional[Array[String, 1]]                                                   $deny_users                           = undef,
  Optional[String]                                                             $force_command                        = undef,
  Optional[Variant[Boolean, Enum['clientspecified']]]                          $gateway_ports                        = undef,
  Optional[Boolean]                                                            $gssapi_authentication                = undef,
  Optional[Array[String, 1]]                                                   $hostbased_accepted_key_types         = undef,
  Optional[Boolean]                                                            $hostbased_authentication             = undef,
  Optional[Boolean]                                                            $hostbased_uses_name_from_packet_only = undef,
  Optional[Tuple[OpenSSH::QoS, 1, 2]]                                          $ip_qos                               = undef,
  Optional[Boolean]                                                            $kbd_interactive_authentication       = undef,
  Optional[Boolean]                                                            $kerberos_authentication              = undef,
  Optional[Boolean]                                                            $kerberos_use_kuserok                 = undef,
  Optional[Integer[0]]                                                         $max_auth_tries                       = undef,
  Optional[Integer[0]]                                                         $max_sessions                         = undef,
  Optional[Boolean]                                                            $password_authentication              = undef,
  Optional[Boolean]                                                            $permit_empty_passwords               = undef,
  Optional[Variant[Enum['any', 'none'], Array[OpenSSH::PermitOpen, 1]]]        $permit_open                          = undef,
  Optional[Variant[Boolean, Enum['without-password', 'forced-commands-only']]] $permit_root_login                    = undef,
  Optional[Boolean]                                                            $permit_tty                           = undef,
  Optional[Variant[Boolean, Enum['point-to-point', 'ethernet']]]               $permit_tunnel                        = undef,
  Optional[Boolean]                                                            $permit_user_rc                       = undef,
  Optional[Boolean]                                                            $pubkey_authentication                = undef,
  Optional[OpenSSH::RekeyLimit]                                                $rekey_limit                          = undef,
  Optional[Stdlib::Absolutepath]                                               $revoked_keys                         = undef,
  Optional[Pattern[/(?x) ^ [0-7]{4} $/]]                                       $stream_local_bind_mask               = undef,
  Optional[Boolean]                                                            $stream_local_bind_unlink             = undef,
  Optional[Stdlib::Absolutepath]                                               $trusted_user_ca_keys                 = undef,
  Optional[Integer[0]]                                                         $x11_display_offset                   = undef,
  Optional[Boolean]                                                            $x11_forwarding                       = undef,
  Optional[Integer[0]]                                                         $x11_max_displays                     = undef,
  Optional[Boolean]                                                            $x11_use_localhost                    = undef,
) {

  if ! defined(Class['::openssh::server']) {
    fail('You must include the openssh::server base class before using any openssh::server defined resources')
  }

  $_permit_open = $permit_open ? {
    undef   => undef,
    default => type($permit_open) ? {
      Type[String] => $permit_open,
      default      => $permit_open.map |$x| { [bodgitlib::enclose_ipv6($x[0]), $x[1]] },
    },
  }

  $content = template("${module_name}/server/match.erb")

  # Only include a fragment if there some actual settings applied. If the last
  # line of the fragment is the 'Match ...' header, there are none
  if split($content, '\n')[-1] !~ /^Match / {
    ::concat::fragment { "${module_name} server match ${title}":
      target  => $::openssh::server::conf_file,
      order   => "30-${order}",
      content => $content,
    }
  }
}