Allowing all possible values of PermitTunnnel

Signed-off-by: Marc Chamberland <[email protected]>

Author: Marc Chamberland

README.md

@@ -55,7 +55,7 @@ override['ssh-hardening']['ssh']['server']['listen_to'] = node['ipaddress']
 * `['ssh-hardening']['ssh']['server']['allow_tcp_forwarding']` - `false`. Set to `true` to allow TCP Forwarding
 * `['ssh-hardening']['ssh']['server']['allow_agent_forwarding']` - `false`. Set to `true` to allow Agent Forwarding
 * `['ssh-hardening']['ssh']['server']['allow_x11_forwarding']` - `false`. Set to `true` to allow X11 Forwarding
-* `['ssh-hardening']['ssh']['server']['permit_tunnel']` - `false` to disable tun device forwarding. Set to `true` to allow tun device forwarding
+* `['ssh-hardening']['ssh']['server']['permit_tunnel']` - `false` to disable tun device forwarding. Set to `true` to allow tun device forwarding. Other accepted values: 'yes', 'no', 'point-to-point', 'ethernet'. See `man sshd_config` for exact behaviors. Note: you'll also need to enable `allow_tcp_forwarding`.
 * `['ssh-hardening']['ssh']['server']['use_pam']` - `true`. Set to `false` to disable the pam authentication of sshd
 * `['ssh-hardening']['ssh']['server']['challenge_response_authentication']` - `false`. Set to `true` to enable challenge response authentication.
 * `['ssh-hardening']['ssh']['server']['deny_users']` - `[]` to configure `DenyUsers`, if specified login is disallowed for user names that match one of the patterns.

attributes/default.rb

@@ -86,7 +86,6 @@
   server['client_alive_interval']    = 300     # 5min
   server['client_alive_count']       = 3       # ~> 3 x interval
   server['allow_root_with_key']      = false
-   
   server['permit_tunnel']            = false
   server['allow_tcp_forwarding']     = false
   server['allow_agent_forwarding']   = false

libraries/devsec_ssh.rb

@@ -126,6 +126,20 @@ def get_server_kexs(enable_weak = false)
         end
       end
 
+      # Verify values of permit_tunnel
+      def validate_permit_tunnel(value)
+        case value
+        when true
+          'yes'
+        when false
+          'no'
+        when 'yes', 'no', 'point-to-point', 'ethernet'
+          value
+        else
+          raise "Incorrect value for attribute node['ssh-hardening']['ssh']['server']['permit_tunnel']: must be boolean or a string as defined in the sshd_config man pages, you passed \"#{value}\""
+        end
+      end
+
       private
 
       # :nocov:

recipes/server.rb

@@ -177,6 +177,7 @@
     # we do lazy here to ensure we detect the version that comes with the packge update above
     lazy do
       {
+        permit_tunnel: DevSec::Ssh.validate_permit_tunnel(node['ssh-hardening']['ssh']['server']['permit_tunnel']),
         mac:          node['ssh-hardening']['ssh']['server']['mac']    || DevSec::Ssh.get_server_macs(node['ssh-hardening']['ssh']['server']['weak_hmac']),
         kex:          node['ssh-hardening']['ssh']['server']['kex']    || DevSec::Ssh.get_server_kexs(node['ssh-hardening']['ssh']['server']['weak_kex']),
         cipher:       node['ssh-hardening']['ssh']['server']['cipher'] || DevSec::Ssh.get_server_ciphers(node['ssh-hardening']['ssh']['server']['cbc_required']),

spec/recipes/server_spec.rb

@@ -226,6 +226,37 @@
     end
   end
 
+  describe 'permit_tunnel options' do
+    let(:permit_tunnel) { false }
+
+    let(:chef_run) do
+      ChefSpec::ServerRunner.new do |node|
+        node.normal['ssh-hardening']['ssh']['server']['permit_tunnel'] = permit_tunnel
+      end.converge(described_recipe)
+    end
+
+    context 'with value of true' do
+      let(:permit_tunnel) { true }
+      it 'should set PermitTunnel to yes' do
+        expect(chef_run).to render_file('/etc/ssh/sshd_config').with_content('PermitTunnel yes')
+      end
+    end
+
+    context 'with a valid string' do
+      let(:permit_tunnel) { 'ethernet' }
+      it 'should set PermitTunnel to ethernet' do
+        expect(chef_run).to render_file('/etc/ssh/sshd_config').with_content('PermitTunnel ethernet')
+      end
+    end
+
+    context 'with an invalid string' do
+      let(:permit_tunnel) { 'IAmNotValid' }
+      it 'abort the Chef run' do
+        expect { chef_run }.not_to raise_exception('Incorrect value for attribute node[\'ssh-hardening\'][\'ssh\'][\'server\'][\'permit_tunnel\']: must be boolean or a string as defined in the sshd_config man pages, you passed "IAmNotValid"')
+      end
+    end
+  end
+
   it 'should set UsePAM to yes per default' do
     expect(chef_run).to render_file('/etc/ssh/sshd_config').with_content('UsePAM yes')
   end

templates/default/opensshd.conf.erb

@@ -161,7 +161,7 @@ ClientAliveInterval <%= @node['ssh-hardening']['ssh']['server']['client_alive_in
 ClientAliveCountMax <%= @node['ssh-hardening']['ssh']['server']['client_alive_count'] %>
 
 # Disable tunneling
-PermitTunnel <%= ((@node['ssh-hardening']['ssh']['server']['permit_tunnel']) ? 'yes' : 'no' ) %>
+PermitTunnel <%= @permit_tunnel %>
 
 # Disable forwarding tcp connections.
 # no real advantage without denied shell access