Development repository for sudo cookbook
Clone or download
tas50 Release 5.4.2
Signed-off-by: Tim Smith <tsmith@chef.io>
Latest commit 11316a6 Sep 5, 2018

README.md

sudo cookbook

Build Status Cookbook Version

The default recipe configures the /etc/sudoers file. The cookbook also includes a sudo resource to adding and removing individual sudo entries.

NOTE: The sudo resource is now built into Chef 14+. When Chef 15 is released (April 2019) this resource will be removed from this cookbook as all users should be on Chef 14+.

Requirements

Platforms

  • AIX
  • Debian/Ubuntu
  • RHEL/CentOS/Scientific/Amazon/Oracle
  • Amazon Linux
  • FreeBSD
  • macOS
  • openSUSE / SUSE Enterprise

Chef

  • Chef 12.21.3+

Cookbooks

  • None

Resource

Use the sudo resource to add or remove individual sudo entries using sudoers.d files.

Note Sudo version 1.7.2 or newer is required to use the sudo resource as it relies on the "#includedir" directive introduced in version 1.7.2. The resource does not enforce installing the version. Supported releases of Ubuntu, Debian and RHEL (6+) all support this feature.

Actions

  • :create - Create a sudoers config
  • :delete - Delete a sudoers config

Properties

Property Description Example Value Default Value
filename name of the /etc/sudoers.d file restart-tomcat resource's name
commands array of commands this sudoer can execute ['/etc/init.d/tomcat restart'] ['ALL']
groups group(s) to provide sudo privileges to. This accepts either an array or a comma separated list. Leading % on group names is optional. This property was named 'group' prior to the 5.1 cookbook release. %admin,superadmin []
nopasswd allow running sudo without specifying a password sudo true false
noexec prevents commands from shelling out 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
users user(s) to provide sudo privileges to. This accepts either an array or a comma separated. This property was named 'user' prior to the 5.1 cookbook release. list. [tomcat, webapp] []
defaults array of defaults this user has ['!requiretty','env_reset']
setenv whether to permit the preserving of environment with sudo -E true false
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. Ignored if not using a custom template. commands: ['/etc/init.d/tomcat restart']

If you use the template property, all other properties will be ignored except for the variables property.

Examples

user bob sudo privileges for any command

sudo 'bob' do
  user 'bob'
end

group sysadmin passwordless sudo privileges for any command

sudo "sysadmin" do
  group "sysadmin"
  nopasswd true
end

group sysadmin/superadmin and user bob passwordless sudo privileges for any command

sudo "sysadmin" do
  group ['sysadmin', 'superadmin']
  user "bob"
  nopasswd true
end

Built-In vs. Provided Templates

The resource provides two methods for templating the sudoers config files:

  1. Using the built-in template
  2. Using a custom, cookbook-level template

Both methods will create the /etc/sudoers.d/#{resourcename} files with the correct permissions.

The resource 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).

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

Specifying Your Own Template

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

Usage

We highly recommend using the sudo resource to define individual sudo entries, but this cookbook also ships with a recipe that can be included on a run_list and controlled using attributes.

Attributes

  • node['authorization']['sudo']['groups'] - groups to enable sudo access (default: [])
  • 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 manage /etc/sudoers.d (default: true on Linux systems. Note: older / EOL distros do not support this feature)
  • node['authorization']['sudo']['agent_forwarding'] - preserve SSH_AUTH_SOCK when sudoing (default: false)
  • node['authorization']['sudo']['sudoers_defaults'] - Array of Defaults entries to configure in /etc/sudoers
  • node['authorization']['sudo']['setenv'] - Whether to permit preserving of environment with sudo -E (default: false)

Using the Attributes

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"
      }
    }
  }
}
{
  "default_attributes": {
    "authorization": {
      "sudo": {
        "command_aliases": [{
          "name": "TEST",
          "command_list": [
            "/usr/bin/ls",
            "/usr/bin/cat"
          ]
        }],
        "custom_commands": {
          "users": [
            {
              "user": "test_user",
              "passwordless": true,
              "command_list": [
                "TEST"
              ]
            }
          ],
          "groups": [
            {
              "group": "test_group",
              "passwordless": false,
              "command_list": [
                "TEST"
              ]
            }
          ]
        }
      }
    }
  }
}
# 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.

Sudoers Defaults

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

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 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"'
]

Maintainers

This cookbook is maintained by Chef's Community Cookbook Engineering team. Our goal is to improve cookbook quality and to aid the community in contributing to cookbooks. To learn more about our team, process, and design goals see our team documentation. To learn more about contributing to cookbooks like this see our contributing documentation, or if you have general questions about this cookbook come chat with us in #cookbok-engineering on the Chef Community Slack

License

Copyright: 2008-2018, Chef Software, 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.