mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Adding salt-rekey guide and links
This commit is contained in:
parent
1bd35592f2
commit
2d3af7aa28
3 changed files with 86 additions and 2 deletions
|
@ -118,3 +118,12 @@ quickly and safely as is possible.
|
|||
|
||||
The fastest place to receive security announcements is via the [salt-announce](https://groups.google.com/forum/#!forum/salt-announce)
|
||||
mailing list. This list is low-traffic.
|
||||
|
||||
## Guidance on Salt and security best practices
|
||||
|
||||
Reference the following documentation to ensure Salt best practices are being
|
||||
implemented in your infrastructure:
|
||||
|
||||
- [Docs: Hardening Salt](https://docs.saltproject.io/en/latest/topics/hardening.html)
|
||||
- [Docs: Salt Best Practices](https://docs.saltproject.io/en/latest/topics/best_practices.html)
|
||||
- [Blog: How I Hardened My Salt Environment](https://www.saltstack.com/blog/how-i-hardened-my-salt-environment/)
|
||||
|
|
|
@ -7,8 +7,10 @@ Salt :index:`Best Practices`
|
|||
Salt's extreme flexibility leads to many questions concerning the structure of
|
||||
configuration files.
|
||||
|
||||
This document exists to clarify these points through examples and
|
||||
code.
|
||||
This document exists to clarify these points through examples and code.
|
||||
|
||||
.. important::
|
||||
The guidance here should be taken in combination with :ref:`hardening-salt`.
|
||||
|
||||
General rules
|
||||
-------------
|
||||
|
|
|
@ -10,6 +10,9 @@ heavily on how you use Salt, where you use Salt, how your team is structured,
|
|||
where you get data from, and what kinds of access (internal and external) you
|
||||
require.
|
||||
|
||||
.. important::
|
||||
The guidance here should be taken in combination with :ref:`best-practices`.
|
||||
|
||||
.. important::
|
||||
|
||||
Refer to the :ref:`saltstack_security_announcements` documentation in order to stay updated
|
||||
|
@ -83,5 +86,75 @@ Salt hardening tips
|
|||
messages are logged at the ``error`` log level and start with ``Requested
|
||||
method not exposed``.
|
||||
|
||||
.. _rotating-salt-keys:
|
||||
|
||||
Rotating keys
|
||||
=============
|
||||
|
||||
There are several reasons to rotate keys. One example is exposure or a
|
||||
compromised key. An easy way to rotate a key is to remove the existing keys and
|
||||
let the ``salt-master`` or ``salt-minion`` process generate new keys on
|
||||
restart.
|
||||
|
||||
Rotate a minion key
|
||||
-------------------
|
||||
|
||||
Run the following on the Salt minion:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
salt-call saltutil.regen_keys
|
||||
systemctl stop salt-minion
|
||||
|
||||
Run the following on the Salt master:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
salt-key -d
|
||||
|
||||
Run the following on the Salt minion:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
systemctl start salt-minion
|
||||
|
||||
Run the following on the Salt master:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
salt-key -a
|
||||
|
||||
Rotate a master key
|
||||
-------------------
|
||||
|
||||
Run the following on the Salt master:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
systemctl stop salt-master
|
||||
rm <pki_dir>/master.{pem,pub}
|
||||
systemctl start salt-master
|
||||
|
||||
Run the following on the Salt minion:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
systemctl stop salt-minion
|
||||
rm <pki_dir>/minion_master.pub
|
||||
systemctl start salt-minion
|
||||
|
||||
Rotate all keys
|
||||
---------------
|
||||
|
||||
A script was designed to quickly re-key Salt minions. It was written originally
|
||||
as a part of the mitigation efforts for `CVE-2020-11651`_ and `CVE-2020-11652`_
|
||||
but it can be used in any scenario in which all minions connected to a Salt
|
||||
master should be forced to re-generate their keys and re-connect.
|
||||
|
||||
Reference `salt-rekey`_ for directions.
|
||||
|
||||
.. _salt-users: https://groups.google.com/forum/#!forum/salt-users
|
||||
.. _salt-announce: https://groups.google.com/forum/#!forum/salt-announce
|
||||
.. _salt-rekey: https://github.com/dwoz/salt-rekey/
|
||||
.. _CVE-2020-11651: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11651
|
||||
.. _CVE-2020-11652: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11652
|
||||
|
|
Loading…
Add table
Reference in a new issue