mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
5f6db0e164
- become constants inherit existing sudo/su ones - become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group - changed method signatures as privlege escalation is collapsed to become - added tests for su and become, diabled su for lack of support in local.py - updated playbook,play and task objects to become - added become to runner - added whoami test for become/sudo/su - added home override dir for plugins - removed useless method from ask pass - forced become pass to always be string also uses to_bytes - fixed fakerunner for tests - corrected reference in synchronize action plugin - added pfexec (needs testing) - removed unused sudo/su in runner init - removed deprecated info - updated pe tests to allow to run under sudo and not need root - normalized become options into a funciton to avoid duplication and inconsistencies - pushed suppored list to connection classs property - updated all connection plugins to latest 'become' pe - includes fixes from feedback (including typos) - added draft docs - stub of become_exe, leaving for future v2 fixes
83 lines
2.7 KiB
ReStructuredText
83 lines
2.7 KiB
ReStructuredText
Ansible Privilege Escalation
|
|
++++++++++++++++++++++++++++
|
|
|
|
Ansible can use existing privilege escalation systems to allow a user to execute tasks as another.
|
|
|
|
.. contents:: Topics
|
|
|
|
Become
|
|
``````
|
|
Before 1.9 Ansible mostly allowed the use of sudo and a limited use of su to allow a login/remote user to become a different user
|
|
and execute tasks, create resources with the 2nd user's permissions. As of 1.9 'become' supersedes the old sudo/su, while still
|
|
being backwards compatible. This new system also makes it easier to add other privilege escalation tools like pbrun (Powerbroker),
|
|
pfexec and others.
|
|
|
|
|
|
New directives
|
|
--------------
|
|
|
|
become
|
|
equivalent to adding sudo: or su: to a play or task, set to true/yes to activate privilege escalation
|
|
|
|
become_user
|
|
equivalent to adding sudo_user: or su_user: to a play or task
|
|
|
|
become_method
|
|
at play or task level overrides the default method set in ansibile.cfg
|
|
|
|
|
|
New ansible_ variables
|
|
----------------------
|
|
Each allows you to set an option per group and/or host
|
|
|
|
ansible_become
|
|
equivalent to ansible_sudo or ansbile_su, allows to force privilege escalation
|
|
|
|
ansible_become_method
|
|
allows to set privilege escalation method
|
|
|
|
ansible_become_user
|
|
equivalent to ansible_sudo_user or ansbile_su_user, allows to set the user you become through privilege escalation
|
|
|
|
ansible_become_pass
|
|
equivalent to ansible_sudo_pass or ansbile_su_pass, allows you to set the privilege escalation password
|
|
|
|
|
|
New command line options
|
|
-----------------------
|
|
|
|
--ask-become-pass
|
|
ask for privilege escalation password
|
|
|
|
-b, --become
|
|
run operations with become (no passorwd implied)
|
|
|
|
--become-method=BECOME_METHOD
|
|
privilege escalation method to use (default=sudo),
|
|
valid choices: [ sudo | su | pbrun | pfexec ]
|
|
|
|
--become-user=BECOME_USER
|
|
run operations as this user (default=root)
|
|
|
|
|
|
sudo and su still work!
|
|
-----------------------
|
|
|
|
Old playbooks will not need to be changed, even though they are deprecated, sudo and su directives will continue to work though it
|
|
is recommended to move to become as they may be retired at one point. You cannot mix directives on the same object though, ansible
|
|
will complain if you try to.
|
|
|
|
Become will default to using the old sudo/su configs and variables if they exist, but will override them if you specify any of the
|
|
new ones.
|
|
|
|
|
|
|
|
.. note:: Privilege escalation methods must also be supported by the connection plugin used, most will warn if they do not, some will just ignore it as they always run as root (jail, chroot, etc).
|
|
|
|
.. seealso::
|
|
|
|
`Mailing List <http://groups.google.com/group/ansible-project>`_
|
|
Questions? Help? Ideas? Stop by the list on Google Groups
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|
|
|