diff --git a/lib/ansible/module_utils/basic.py b/lib/ansible/module_utils/basic.py index 12fcc3ac541..a5c6dbb5e1e 100644 --- a/lib/ansible/module_utils/basic.py +++ b/lib/ansible/module_utils/basic.py @@ -519,17 +519,23 @@ class AnsibleModule(object): def set_mode_if_different(self, path, mode, changed): path = os.path.expanduser(path) + path_stat = os.lstat(path) + if mode is None: return changed - try: - # FIXME: support English modes - if not isinstance(mode, int): - mode = int(mode, 8) - except Exception, e: - self.fail_json(path=path, msg='mode needs to be something octalish', details=str(e)) - st = os.lstat(path) - prev_mode = stat.S_IMODE(st[stat.ST_MODE]) + if not isinstance(mode, int): + try: + mode = int(mode, 8) + except Exception: + try: + mode = self._symbolic_mode_to_octal(path_stat, mode) + except Exception, e: + self.fail_json(path=path, + msg="mode must be in octal or symbolic form", + details=str(e)) + + prev_mode = stat.S_IMODE(path_stat.st_mode) if prev_mode != mode: if self.check_mode: @@ -551,13 +557,93 @@ class AnsibleModule(object): except Exception, e: self.fail_json(path=path, msg='chmod failed', details=str(e)) - st = os.lstat(path) - new_mode = stat.S_IMODE(st[stat.ST_MODE]) + path_stat = os.lstat(path) + new_mode = stat.S_IMODE(path_stat.st_mode) if new_mode != prev_mode: changed = True return changed + def _symbolic_mode_to_octal(self, path_stat, symbolic_mode): + new_mode = stat.S_IMODE(path_stat.st_mode) + + mode_re = re.compile(r'^(?P[ugoa]+)(?P[-+=])(?P[rwxXst]*|[ugo])$') + for mode in symbolic_mode.split(','): + match = mode_re.match(mode) + if match: + users = match.group('users') + operator = match.group('operator') + perms = match.group('perms') + + if users == 'a': users = 'ugo' + + for user in users: + mode_to_apply = self._get_octal_mode_from_symbolic_perms(path_stat, user, perms) + new_mode = self._apply_operation_to_mode(user, operator, mode_to_apply, new_mode) + else: + raise ValueError("bad symbolic permission for mode: %s" % mode) + return new_mode + + def _apply_operation_to_mode(self, user, operator, mode_to_apply, current_mode): + if operator == '=': + if user == 'u': mask = stat.S_IRWXU | stat.S_ISUID + elif user == 'g': mask = stat.S_IRWXG | stat.S_ISGID + elif user == 'o': mask = stat.S_IRWXO | stat.S_ISVTX + + # mask out u, g, or o permissions from current_mode and apply new permissions + inverse_mask = mask ^ 07777 + new_mode = (current_mode & inverse_mask) | mode_to_apply + elif operator == '+': + new_mode = current_mode | mode_to_apply + elif operator == '-': + new_mode = current_mode - (current_mode & mode_to_apply) + return new_mode + + def _get_octal_mode_from_symbolic_perms(self, path_stat, user, perms): + prev_mode = stat.S_IMODE(path_stat.st_mode) + + is_directory = stat.S_ISDIR(path_stat.st_mode) + has_x_permissions = (prev_mode & 00111) > 0 + apply_X_permission = is_directory or has_x_permissions + + # Permission bits constants documented at: + # http://docs.python.org/2/library/stat.html#stat.S_ISUID + user_perms_to_modes = { + 'u': { + 'r': stat.S_IRUSR, + 'w': stat.S_IWUSR, + 'x': stat.S_IXUSR, + 'X': stat.S_IXUSR if apply_X_permission else 0, + 's': stat.S_ISUID, + 't': 0, + 'u': prev_mode & stat.S_IRWXU, + 'g': (prev_mode & stat.S_IRWXG) << 3, + 'o': (prev_mode & stat.S_IRWXO) << 6 }, + 'g': { + 'r': stat.S_IRGRP, + 'w': stat.S_IWGRP, + 'x': stat.S_IXGRP, + 'X': stat.S_IXGRP if apply_X_permission else 0, + 's': stat.S_ISGID, + 't': 0, + 'u': (prev_mode & stat.S_IRWXU) >> 3, + 'g': prev_mode & stat.S_IRWXG, + 'o': (prev_mode & stat.S_IRWXO) << 3 }, + 'o': { + 'r': stat.S_IROTH, + 'w': stat.S_IWOTH, + 'x': stat.S_IXOTH, + 'X': stat.S_IXOTH if apply_X_permission else 0, + 's': 0, + 't': stat.S_ISVTX, + 'u': (prev_mode & stat.S_IRWXU) >> 6, + 'g': (prev_mode & stat.S_IRWXG) >> 3, + 'o': prev_mode & stat.S_IRWXO } + } + + or_reduce = lambda mode, perm: mode | user_perms_to_modes[user][perm] + return reduce(or_reduce, perms, 0) + def set_fs_attributes_if_different(self, file_args, changed): # set modes owners and context as needed changed = self.set_context_if_different( diff --git a/test/integration/roles/test_file/tasks/main.yml b/test/integration/roles/test_file/tasks/main.yml index 7799bd8df9e..7c8262c27da 100644 --- a/test/integration/roles/test_file/tasks/main.yml +++ b/test/integration/roles/test_file/tasks/main.yml @@ -228,3 +228,157 @@ that: - 'file17_result.failed == true' - 'file17_result.state == "directory"' + +- name: test file creation with symbolic mode + file: dest={{output_dir}}/test_symbolic state=touch mode=u=rwx,g=rwx,o=rwx + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0777' + +- name: modify symbolic mode for all + file: dest={{output_dir}}/test_symbolic state=touch mode=a=r + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0444' + +- name: modify symbolic mode for owner + file: dest={{output_dir}}/test_symbolic state=touch mode=u+w + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0644' + +- name: modify symbolic mode for group + file: dest={{output_dir}}/test_symbolic state=touch mode=g+w + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0664' + +- name: modify symbolic mode for world + file: dest={{output_dir}}/test_symbolic state=touch mode=o+w + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0666' + +- name: modify symbolic mode for owner + file: dest={{output_dir}}/test_symbolic state=touch mode=u+x + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0766' + +- name: modify symbolic mode for group + file: dest={{output_dir}}/test_symbolic state=touch mode=g+x + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0776' + +- name: modify symbolic mode for world + file: dest={{output_dir}}/test_symbolic state=touch mode=o+x + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0777' + +- name: remove symbolic mode for world + file: dest={{output_dir}}/test_symbolic state=touch mode=o-wx + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0774' + +- name: remove symbolic mode for group + file: dest={{output_dir}}/test_symbolic state=touch mode=g-wx + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0744' + +- name: remove symbolic mode for owner + file: dest={{output_dir}}/test_symbolic state=touch mode=u-wx + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0444' + +- name: set sticky bit with symbolic mode + file: dest={{output_dir}}/test_symbolic state=touch mode=o+t + register: result + +- name: assert file mode + assert: + that: + - result.mode == '01444' + +- name: remove sticky bit with symbolic mode + file: dest={{output_dir}}/test_symbolic state=touch mode=o-t + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0444' + +- name: add setgid with symbolic mode + file: dest={{output_dir}}/test_symbolic state=touch mode=g+s + register: result + +- name: assert file mode + assert: + that: + - result.mode == '02444' + +- name: remove setgid with symbolic mode + file: dest={{output_dir}}/test_symbolic state=touch mode=g-s + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0444' + +- name: add setuid with symbolic mode + file: dest={{output_dir}}/test_symbolic state=touch mode=u+s + register: result + +- name: assert file mode + assert: + that: + - result.mode == '04444' + +- name: remove setuid with symbolic mode + file: dest={{output_dir}}/test_symbolic state=touch mode=u-s + register: result + +- name: assert file mode + assert: + that: + - result.mode == '0444' +