/ansible-mysql-hardening

This Ansible role provides security configuration for MySQL.

Primary LanguageRuby

mysql-hardening (Ansible role)

Build Status Gitter Chat Ansible Galaxy

Description

Provides security configurations for MySQL. It is intended to set up production-ready mysql instances that are configured with minimal surface for attackers. Furthermore it is intended to be compliant with the DevSec MySQL Baseline.

This role focuses on security configuration of MySQL. Therefore you can add this hardening role alongside your existing MySQL configuration in Ansible.

Requirements

  • Ansible
  • Set up mysql_root_password variable

Installation

Install the role with ansible-galaxy:

ansible-galaxy install dev-sec.mysql-hardening

Example Playbook

- hosts: localhost
  roles:
    - dev-sec.mysql-hardening

This hardening role installs the hardening but expects an existing installation of MySQL, MariaDB or Percona. Please ensure that the following variables are set accordingly:

  • mysql_hardening_enabled: yes role is enabled by default and can be disabled without removing it from a playbook. You can use conditional variable, for example: mysql_hardening_enabled: "{{ true if mysql_enabled else false }}"
  • mysql_hardening_user: 'mysql' The user that mysql runs as.
  • mysql_datadir: '/var/lib/mysql' The MySQL data directory
  • mysql_hardening_mysql_hardening_conf_file: '/etc/mysql/conf.d/hardening.cnf' The path to the configuration file where the hardening will be performed

Security Options

Further information is already available at Deutsche Telekom (German) and Symantec

Name Default Value Description
mysql_hardening_chroot "" chroot
mysql_hardening_options.safe-user-create 1 safe-user-create
mysql_hardening_options.secure-auth 1 secure-auth
mysql_hardening_options.skip-symbolic-links 1 skip-symbolic-links
mysql_hardening_skip_grant_tables: false skip-grant-tables
mysql_hardening_skip_show_database 1 skip-show-database
mysql_hardening_options.local-infile 0 local-infile
mysql_hardening_options.allow-suspicious-udfs 0 allow-suspicious-udfs
mysql_hardening_chroot.automatic-sp-privileges 0 automatic_sp_privileges
mysql_hardening_options.secure-file-priv /tmp secure-file-priv
mysql_allow_remote_root false delete remote root users
mysql_remove_anonymous_users true remove users without authentication
mysql_remove_test_database true remove test database

Local Testing

The preferred way of locally testing the role is to use Docker. You will have to install Docker on your system. See Get started for a Docker package suitable to for your system.

You can also use vagrant and Virtualbox or VMWare to run tests locally. You will have to install Virtualbox and Vagrant on your system. See Vagrant Downloads for a vagrant package suitable for your system. For all our tests we use test-kitchen. If you are not familiar with test-kitchen please have a look at their guide.

Next install test-kitchen:

# Install dependencies
gem install bundler
bundle install

Testing with Docker

# fast test on one machine
bundle exec kitchen test default-ubuntu-1204

# test on all machines
bundle exec kitchen test

# for development
bundle exec kitchen create default-ubuntu-1204
bundle exec kitchen converge default-ubuntu-1204

Testing with Virtualbox

# fast test on one machine
KITCHEN_YAML=".kitchen.vagrant.yml" bundle exec kitchen test default-ubuntu-1404

# test on all machines
KITCHEN_YAML=".kitchen.vagrant.yml" bundle exec kitchen test

# for development
KITCHEN_YAML=".kitchen.vagrant.yml" bundle exec kitchen create default-ubuntu-1404
KITCHEN_YAML=".kitchen.vagrant.yml" bundle exec kitchen converge default-ubuntu-1404

For more information see test-kitchen

License and Author

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.