Skip to content
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

Jump to bottom

docs: Update docs to use yaml style when defining vars #219

Merged
merged 1 commit into from
Dec 8, 2023
Merged

docs: Update docs to use yaml style when defining vars #219

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
41 changes: 31 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,11 @@ module.

```yaml
selinux_booleans:
- {name: 'samba_enable_home_dirs', state: true}
- {name: 'ssh_sysadm_login', state: true, persistent: true}
- name: samba_enable_home_dirs
state: true
- name: ssh_sysadm_login
state: true
persistent: true
```

### selinux_fcontexts
Expand All @@ -95,7 +98,10 @@ module.

```yaml
selinux_fcontexts:
- {target: '/tmp/test_dir(/.*)?', setype: 'user_home_dir_t', ftype: 'd', state: 'present'}
- target: '/tmp/test_dir(/.*)?'
setype: 'user_home_dir_t'
ftype: d
state: present
```

Users may also pass the following optional parameters:
Expand All @@ -115,7 +121,11 @@ module.

```yaml
selinux_ports:
- {ports: '22100', proto: 'tcp', setype: 'ssh_port_t', state: 'present', local: true}
- ports: 22100
proto: tcp
setype: ssh_port_t
state: present
local: true
```

### selinux_restore_dirs
Expand All @@ -137,8 +147,13 @@ module.

```yaml
selinux_logins:
- {login: 'plautrba', seuser: 'staff_u', state: 'absent'}
- {login: '__default__', seuser: 'staff_u', serange: 's0-s0:c0.c1023', state: 'present'}
- login: plautrba
seuser: staff_u
state: absent
- login: default
seuser: staff_u
serange: s0-s0:c0.c1023
state: present
```

### selinux_modules
Expand All @@ -148,10 +163,16 @@ which would contain a `list` of `dict`, e.g.:

```yaml
selinux_modules:
- {path: 'localmodule.pp', state: 'enabled'}
- {path: 'localmodule.cil', priority: '350', state: 'enabled'}
- {name: 'unconfineduser', state: 'disabled'}
- {name: 'localmodule', priority: '350', state: 'absent'}
- path: localmodule.pp
state: enabled
- path: localmodule.cil
priority: 350
state: enabled
- name: unconfineduser
state: disabled
- name: localmodule
priority: 350
state: absent
```

* `path`: a local module file (either .cil or .pp) to be installed on a node,
Expand Down
45 changes: 31 additions & 14 deletions examples/selinux-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,51 +10,68 @@
selinux_booleans:
# Set the 'samba_enable_home_dirs' boolean to 'on' in the current
# session only
- {name: 'samba_enable_home_dirs', state: 'on'}
- name: samba_enable_home_dirs
state: true
# Set the 'ssh_sysadm_login' boolean to 'on' permanently
- {name: 'ssh_sysadm_login', state: 'on', persistent: 'yes'}
- name: ssh_sysadm_login
state: true
persistent: true
# Map '/tmp/test_dir' and its subdirectories to the 'user_home_dir_t'
# SELinux file type
selinux_fcontexts:
- {target: '/tmp/test_dir(/.*)?', setype: 'user_home_dir_t', ftype: 'd'}
- target: '/tmp/test_dir(/.*)?'
setype: user_home_dir_t
ftype: d
state: present
# Restore SELinux file contexts in '/tmp/test_dir'
selinux_restore_dirs:
- /tmp/test_dir
# Map tcp port 22100 to the 'ssh_port_t' SELinux port type
selinux_ports:
- {ports: '22100', proto: 'tcp', setype: 'ssh_port_t', state: 'present'}
- ports: 22100
proto: tcp
setype: ssh_port_t
state: present
# Map the 'sar-user' Linux user to the 'staff_u' SELinux user
selinux_logins:
- {login: 'sar-user', seuser: 'staff_u', serange: 's0-s0:c0.c1023',
state: 'present'}
- login: sar-user
seuser: staff_u
serange: s0-s0:c0.c1023
state: present
# Manage modules
selinux_modules:
# Install the 'localpolicy.cil' with priority 300
- {path: "localpolicy.cil", priority: "300", state: "enabled"}
- path: localpolicy.cil
priority: 300
state: enabled
# Disable the 'unconfineduser' module with priority 100
- {name: "unconfineduser", priority: "100", state: "disabled"}
- name: unconfineduser
priority: 100
state: disabled
# Remove the 'temporarypolicy' module with priority 400
- {name: "temporarypolicy", priority: "400", state: "absent"}

# Prepare the prerequisites required for this playbook
- name: temporarypolicy
priority: 400
state: absent
tasks:
- name: Creates directory
file:
path: /tmp/test_dir
state: directory
mode: "0755"

- name: Add a Linux System Roles SELinux User
user:
comment: Linux System Roles SELinux User
name: sar-user
- name: Execute the role and catch errors

- name: Execute the role and reboot in a rescue block
block:
- name: Include selinux role
include_role:
name: linux-system-roles.selinux
rescue:
# Fail if failed for a different reason than selinux_reboot_required.
- name: Handle errors
- name: >-
Fail if failed for a different reason than selinux_reboot_required
fail:
msg: "role failed"
when: not selinux_reboot_required
Expand Down
Loading