# Readme

[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_selinux&style=plastic)](https://jenkins.confdroid.com/job/confdroid_selinux/)
[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_selinux&metric=security_hotspots&token=sqb_cc73d9e100a7cda91c7f45b8a7690bd16498e852)](https://sonarqube.confdroid.com/dashboard?id=confdroid_selinux)

## Synopsis

[Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a Linux kernel security module that provides a mechanism for supporting access control security policies.

`confdroid_selinux` is a Puppet  module to automate installation, configuration and troubleshooting of selinux.

## WARNING

***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production***

## Features

Installation:

- install binaries required for selinux and  related tools

Configuration

- manage `/etc/sysconfig/selinux` file (file system permissions, selinux context, content)
- manage current selinux status (permissive,enforcing)

## Repo Documentation

See the full Puppet documentation including parameters in `docs/index.html`.

## Dependencies

All dependencies must be included in the catalogue.

- [confdroid_resources](https://sourcecode.confdroid.com/confdroid/confdroid_resources) for yum repo resources.

## Deployment

- native Puppet deployment

via site.pp or nodes.pp

```ruby
node 'example.example.net' {
  include confdroid_selinux
}
```

- through Foreman:

In order to apply parameters through Foreman, **confdroid_selinux::params*- must be added to the host or host group in question.

See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).

## SELINUX

All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.

## Known Problems

- Systems reconfigured with selinux disabled require once a reboot for selinux to be enabled. This module will **not**- do the reboot for you to avoid unexpected outages.

## Support

- OS: Rocky 9 (any RHEL9-based OS should work, but Rocky has been tested)
- Puppet 8

## Tests

- Puppet Lint
  - excluded tests:
    - `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
- Puppet Parser
- ERB Template Parser
- Sonar Quality Gate

## Contact Us

- [contact Us](https://confdroid.com/contact/)
- [Feedback Portal](https://feedback.confdroid.com/)

## Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments  (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.