The Chef sudo
cookbook installs the sudo
package and configures the /etc/sudoers
file.
It also exposes an LWRP for adding and managing sudoers.
The platform has a package named sudo
and the sudoers
file is /etc/sudoers
.
node['authorization']['sudo']['groups']
- groups to enable sudo access (default:[ "sysadmin" ]
)node['authorization']['sudo']['users']
- users to enable sudo access (default:[]
)node['authorization']['sudo']['passwordless']
- use passwordless sudo (default:false
)node['authorization']['sudo']['include_sudoers_d']
- include and manager/etc/sudoers.d
(default:false
)node['authorization']['sudo']['agent_forwarding']
- preserveSSH_AUTH_SOCK
when sudoing (default:false
)node['authorization']['sudo']['sudoers_defaults']
- Array ofDefaults
entries to configure in/etc/sudoers
To use attributes for defining sudoers, set the attributes above on the node (or role) itself:
{
"default_attributes": {
"authorization": {
"sudo": {
"groups": ["admin", "wheel", "sysadmin"],
"users": ["jerry", "greg"],
"passwordless": "true"
}
}
}
}
# roles/example.rb
default_attributes(
"authorization" => {
"sudo" => {
"groups" => ["admin", "wheel", "sysadmin"],
"users" => ["jerry", "greg"],
"passwordless" => true
}
}
)
Note that the template for the sudoers file has the group "sysadmin" with ALL:ALL permission, though the group by default does not exist.
Configure a node attribute,
node['authorization']['sudo']['sudoers_defaults']
as an array of
Defaults
entries to configure in /etc/sudoers
. A list of examples
for common platforms is listed below:
Debian
node.default['authorization']['sudo']['sudoers_defaults'] = ['env_reset']
Ubuntu 10.04
node.default['authorization']['sudo']['sudoers_defaults'] = ['env_reset']
Ubuntu 12.04
node.default['authorization']['sudo']['sudoers_defaults'] = [
'env_reset',
'secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"'
]
FreeBSD
node.default['authorization']['sudo']['sudoers_defaults'] = [
'env_reset',
'secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"'
]
RHEL family 5.x
The version of sudo in RHEL 5 may not support +=
, as used in env_keep
, so its a single string.
node.default['authorization']['sudo']['sudoers_defaults'] = [
'!visiblepw',
'env_reset',
'env_keep = "COLORS DISPLAY HOSTNAME HISTSIZE INPUTRC KDEDIR \
LS_COLORS MAIL PS1 PS2 QTDIR USERNAME \
LANG LC_ADDRESS LC_CTYPE LC_COLLATE LC_IDENTIFICATION \
LC_MEASUREMENT LC_MESSAGES LC_MONETARY LC_NAME LC_NUMERIC \
LC_PAPER LC_TELEPHONE LC_TIME LC_ALL LANGUAGE LINGUAS \
_XKB_CHARSET XAUTHORITY"'
]
RHEL family 6.x
node.default['authorization']['sudo']['sudoers_defaults'] = [
'!visiblepw',
'env_reset',
'env_keep = "COLORS DISPLAY HOSTNAME HISTSIZE INPUTRC KDEDIR LS_COLORS"',
'env_keep += "MAIL PS1 PS2 QTDIR USERNAME LANG LC_ADDRESS LC_CTYPE"',
'env_keep += "LC_COLLATE LC_IDENTIFICATION LC_MEASUREMENT LC_MESSAGES"',
'env_keep += "LC_MONETARY LC_NAME LC_NUMERIC LC_PAPER LC_TELEPHONE"',
'env_keep += "LC_TIME LC_ALL LANGUAGE LINGUAS _XKB_CHARSET XAUTHORITY"',
'env_keep += "HOME"',
'always_set_home',
'secure_path = /sbin:/bin:/usr/sbin:/usr/bin'
]
Mac OS X
node.default['authorization']['sudo']['sudoers_defaults'] = [
'env_reset',
'env_keep += "BLOCKSIZE"',
'env_keep += "COLORFGBG COLORTERM"',
'env_keep += "__CF_USER_TEXT_ENCODING"',
'env_keep += "CHARSET LANG LANGUAGE LC_ALL LC_COLLATE LC_CTYPE"',
'env_keep += "LC_MESSAGES LC_MONETARY LC_NUMERIC LC_TIME"',
'env_keep += "LINES COLUMNS"',
'env_keep += "LSCOLORS"',
'env_keep += "TZ"',
'env_keep += "DISPLAY XAUTHORIZATION XAUTHORITY"',
'env_keep += "EDITOR VISUAL"',
'env_keep += "HOME MAIL"'
]
Note Sudo version 1.7.2 or newer is required to use the sudo LWRP as it relies on the "#includedir" directive introduced in version 1.7.2. The recipe does not enforce installing the version. To use this LWRP, set node['authorization']['sudo']['include_sudoers_d']
to true
.
There are two ways for rendering a sudoer-fragment using this LWRP:
- Using the built-in template
- Using a custom, cookbook-level template
Both methods will create the /etc/sudoers.d/#{username}
file with the correct permissions.
The LWRP also performs fragment validation. If a sudoer-fragment is not valid, the Chef run will throw an exception and fail. This ensures that your sudoers file is always valid and cannot become corrupt (from this cookbook).
Example using the built-in template:
sudo 'tomcat' do
user "%tomcat" # or a username
runas 'app_user' # or 'app_user:tomcat'
commands ['/etc/init.d/tomcat restart']
end
sudo 'tomcat' do
template 'my_tomcat.erb' # local cookbook template
variables :cmds => ['/etc/init.d/tomcat restart']
end
In either case, the following file would be generated in /etc/sudoers.d/tomcat
# This file is managed by Chef for node.example.com
# Do NOT modify this file directly.
%tomcat ALL=(app_user) /etc/init.d/tomcat restart
Attribute | Description | Example | Default |
---|---|---|---|
name | name of the `/etc/sudoers.d` file | restart-tomcat | current resource name |
commands | array of commands this sudoer can execute | ['/etc/init.d/tomcat restart'] | ['ALL'] |
group | group to provide sudo privileges to, except `%` is prepended to the name in case it is not already | %admin | |
nopasswd | supply a password to invoke sudo | true | false |
runas | User the command(s) can be run as | root | ALL |
template | the erb template to render instead of the default | restart-tomcat.erb | |
user | user to provide sudo privileges to | tomcat | |
defaults | array of defaults this user has | ['!requiretty','env_reset'] | |
env_keep_add | array of strings to add to env_keep | ['HOME', 'MY_ENV_VAR MY_OTHER_ENV_VAR'] | |
env_keep_subtract | array of strings to remove from env_keep | ['DISPLAY', 'MY_SECURE_ENV_VAR'] | |
variables | the variables to pass to the custom template | :commands => ['/etc/init.d/tomcat restart'] |
If you use the template attribute, all other attributes will be ignored except for the variables attribute.
This section details "quick development" steps. For a detailed explanation, see [[Contributing.md]].
-
Clone this repository from GitHub:
$ git clone [email protected]:opscode-cookbooks/sudo.git
-
Create a git branch
$ git checkout -b my_bug_fix
-
Install dependencies:
$ bundle install
-
Make your changes/patches/fixes, committing appropiately
-
Write tests
-
Run the tests:
bundle exec foodcritic -f any .
bundle exec rspec
bundle exec rubocop
bundle exec kitchen test
In detail:
- Foodcritic will catch any Chef-specific style errors
- RSpec will run the unit tests
- Rubocop will check for Ruby-specific style errors
- Test Kitchen will run and converge the recipes
- Author:: Bryan W. Berry [email protected]
- Author:: Adam Jacob [email protected]
- Author:: Seth Chisamore [email protected]
- Author:: Seth Vargo [email protected]
Copyright 2009-2012, Opscode, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.