Skip to content

Add optional root shell timeout #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 21, 2020
Merged

Add optional root shell timeout #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ If a different module manages Kerberos for root, disable Kerberos in this module
root::manage_kerberos: false
```

Set an automatic logout for idle interactive shells (in seconds):

```yaml
root::logout_timeout: 600
```

## Reference

[http://treydock.github.io/puppet-module-root/](http://treydock.github.io/puppet-module-root/)
Expand Down
26 changes: 26 additions & 0 deletions manifests/init.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@
# @param ssh_public_key_source
# The source for root's SSH RSA public key
#
# @param logout_timeout
# Time (in seconds) before idle interactive terminals will logout
#
# @param manage_kerberos
# Boolean that sets if Kerberos files should be managed
#
Expand All @@ -70,6 +73,7 @@
Boolean $manage_kerberos = true,
Array $kerberos_login_principals = [],
Hash[String[1], Variant[String, Array]] $kerberos_users_commands = {},
Optional[Integer[0, default]] $logout_timeout = undef,
) inherits root::params {

if $mailaliases_hiera_merge {
Expand Down Expand Up @@ -160,6 +164,28 @@
notify => Exec['root newaliases'],
}

if $logout_timeout {
$timeout_ensure = 'file'
} else {
$timeout_ensure = 'absent'
}

file {'/etc/profile.d/root_logout_timeout.sh':
ensure => $timeout_ensure,
owner => 'root',
group => 'root',
mode => '0644',
content => template('root/root_logout_timeout.sh.erb')
}

file {'/etc/profile.d/root_logout_timeout.csh':
ensure => $timeout_ensure,
owner => 'root',
group => 'root',
mode => '0644',
content => template('root/root_logout_timeout.csh.erb')
}

if $_ssh_authorized_keys =~ Array {
$_ssh_authorized_keys.each |$key| {
root::ssh_authorized_key { $key: }
Expand Down
59 changes: 59 additions & 0 deletions spec/classes/root_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@

it { is_expected.to contain_mailalias('root').with_ensure('absent') }

it do
is_expected.to contain_file('/etc/profile.d/root_logout_timeout.csh').with(ensure: 'absent')
end

it do
is_expected.to contain_file('/etc/profile.d/root_logout_timeout.sh').with(ensure: 'absent')
end

context 'authorized_keys as an Array' do
let(:params) { { ssh_authorized_keys: ['ssh-rsa longhashfoo== foo', 'ssh-dss longhashbar== bar'] } }

Expand Down Expand Up @@ -134,6 +142,57 @@
end
end

context 'with timeout set over 1 minute' do
let(:params) { { logout_timeout: 90 } }

it do
is_expected.to contain_file('/etc/profile.d/root_logout_timeout.csh').with(ensure: 'file',
owner: 'root',
group: 'root',
mode: '0644').with_content(%r{^\s*set -r autologout 1$})
end
it do
is_expected.to contain_file('/etc/profile.d/root_logout_timeout.sh').with(ensure: 'file',
owner: 'root',
group: 'root',
mode: '0644').with_content(%r{^\s*TMOUT=90$})
end
end

context 'with timeout set less than 1 minute' do
let(:params) { { logout_timeout: 20 } }

it do
is_expected.to contain_file('/etc/profile.d/root_logout_timeout.csh').with(ensure: 'file',
owner: 'root',
group: 'root',
mode: '0644').with_content(%r{^\s*set -r autologout 1$})
end
it do
is_expected.to contain_file('/etc/profile.d/root_logout_timeout.sh').with(ensure: 'file',
owner: 'root',
group: 'root',
mode: '0644').with_content(%r{^\s*TMOUT=20$})
end
end

context 'with timeout set to 0' do
let(:params) { { logout_timeout: 0 } }

it do
is_expected.to contain_file('/etc/profile.d/root_logout_timeout.csh').with(ensure: 'file',
owner: 'root',
group: 'root',
mode: '0644').with_content(%r{^\s*set -r autologout 0$})
end
it do
is_expected.to contain_file('/etc/profile.d/root_logout_timeout.sh').with(ensure: 'file',
owner: 'root',
group: 'root',
mode: '0644').with_content(%r{^\s*TMOUT=0$})
end
end

context 'export_key => true' do
let(:params) { { export_key: true } }
let(:facts) do
Expand Down
11 changes: 11 additions & 0 deletions templates/root_logout_timeout.csh.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# File managed by Puppet (root::logout_timeout = <%= scope['root::logout_timeout'] %>), DO NOT EDIT
<% if scope['root::logout_timeout'] -%>
<% inminutes = Integer(scope['root::logout_timeout'] / 60) -%>
<% if scope['root::logout_timeout'] > 0 && inminutes == 0 -%>
<%# csh defines in minutes not seconds, cover edge case <60 seconds -%>
<% inminutes = 1 -%>
<% end -%>
if ( `id -u` == "0" ) then
set -r autologout <%= inminutes %>
endif
<% end -%>
7 changes: 7 additions & 0 deletions templates/root_logout_timeout.sh.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# File managed by Puppet (root::logout_timeout = <%= scope['root::logout_timeout'] %>), DO NOT EDIT
<% if scope['root::logout_timeout'] -%>
if [ `id -u` = 0 ] ; then
TMOUT=<%= scope['root::logout_timeout'] %>
export TMOUT
fi
<% end -%>