Chapter 1. Using Fernet Tokens in the Overcloud
Chapter 1. Using Fernet Tokens in the Overcloud Fernet is now the default token provider, replacing uuid . This guide describes how to review your Fernet deployment, and how to rotate the Fernet keys. 1.1. Review the Fernet Deployment This procedure reviews your configuration to confirm that Fernet tokens are working correctly. Retrieve the IP address of the controller node. SSH to the controller. Retrieve the values of the token driver and provider settings. Test the Fernet provider. The result should include the long Fernet token. 1.2. Rotate the Fernet keys Red Hat recommends erring on the side of security when considering the length of rotation cycles, as the rotation process can be performed with relative ease. If you don't have any guidance from your security posture, a monthly rotation cycle is a good starting point. Fernet uses three types of keys, which are stored in /var/lib/config-data/puppet-generated/keystone/etc/keystone/fernet-keys . The highest-numbered directory contains the primary key, which is used to generate new tokens and decrypt existing ones. During the key rotation process, the primary key is relegated to secondary key status, and a new primary key is issued, thereby reducing the value of a compromised primary key. Secondary keys can only be used to decrypt tokens that were created with primary keys, and cannot issue new ones. 1.2.1. Rotate the Fernet Keys Using Mistral By default, director is configured to manage the overcloud's Fernet keys; this setting is managed in the environment file using ManageKeystoneFernetKeys . As a result, the Fernet keys are stored in Mistral (under KeystoneFernetKeys ). This approach means that you can rotate the Fernet keys with Mistral, and they will still persist after stack updates. Review the existing Fernet keys. Identify the Fernet key location. Note The /etc/keystone/ directory refers to the container file system path. Review the current Fernet key directories. 0 - Contains the staged key, (which becomes the primary key) and will always be numbered 0 . 1 - Contains the secondary key. 2 - Contains the primary key. This number will increment each time the keys are rotated, with the highest number always serving as the primary key. Note The maximum number of keys is determined by the max_active_keys property, by default 5 keys. The keys are propagated across all controllers. Rotate the Fernet keys using the Mistral workflow. Get the ID and ensure that the workflow was executed successfully. On the controller, review the number of Fernet keys, and compare with the result. 0 - Contains the staged key, and will always be numbered 0 . This key will be promoted to a primary key during the rotation. 1 & 2 - Contain the secondary keys. 3 - Contains the primary key. This number will increment each time the keys are rotated, with the highest number always serving as the primary key. Note The maximum number of keys is determined by the max_active_keys property, by default 5 keys. The keys are propagated across all controllers.
[stack@director ~]USD source ~/stackrc [stack@director ~]USD openstack server list +--------------------------------------+-------------------------+--------+---------------------+ | ID | Name | Status | Networks | +--------------------------------------+-------------------------+--------+---------------------+ | 756fbd73-e47b-46e6-959c-e24d7fb71328 | overcloud-controller-0 | ACTIVE | ctlplane=192.0.2.16 | | 62b869df-1203-4d58-8e45-fac6cd4cfbee | overcloud-novacompute-0 | ACTIVE | ctlplane=192.0.2.8 | +--------------------------------------+-------------------------+--------+---------------------+ [heat-admin@overcloud-controller-0 ~]USD ssh heat-admin@192.0.2.16 [heat-admin@overcloud-controller-0 ~]USD sudo crudini --get /var/lib/config-data/puppet-generated/keystone/etc/keystone/keystone.conf token driver sql [heat-admin@overcloud-controller-0 ~]USD sudo crudini --get /var/lib/config-data/puppet-generated/keystone/etc/keystone/keystone.conf token provider fernet [heat-admin@overcloud-controller-0 ~]USD exit [stack@director ~]USD source ~/overcloudrc [stack@director ~]USD openstack token issue +------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Field | Value | +------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | expires | 2016-09-20 05:26:17+00:00 | | id | gAAAAABX4LppE8vaiFZ992eah2i3edpO1aDFxlKZq6a_RJzxUx56QVKORrmW0-oZK3-Xuu2wcnpYq_eek2SGLz250eLpZOzxKBR0GsoMfxJU8mEFF8NzfLNcbuS-iz7SV-N1re3XEywSDG90JcgwjQfXW-8jtCm-n3LL5IaZexAYIw059T_-cd8 | | project_id | 26156621d0d54fc39bf3adb98e63b63d | | user_id | 397daf32cadd490a8f3ac23a626ac06c | +------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ SSH back to the controller [heat-admin@overcloud-controller-0 ~]USD sudo crudini --get /var/lib/config-data/puppet-generated/keystone/etc/keystone/keystone.conf fernet_tokens key_repository /etc/keystone/fernet-keys [heat-admin@overcloud-controller-0 ~]USD sudo ls /var/lib/config-data/puppet-generated/keystone/etc/keystone/fernet-keys 0 1 2 [stack@director ~]USD source ~/stackrc [stack@director ~]USD openstack workflow execution create tripleo.fernet_keys.v1.rotate_fernet_keys '{"container": "overcloud"}' +-------------------+-------------------------------------------+ | Field | Value | +-------------------+-------------------------------------------+ | ID | 58c9c664-b966-4f82-b368-af5ed8de5b47 | | Workflow ID | 78f0990a-3d34-4bf2-a127-10c149bb275c | | Workflow name | tripleo.fernet_keys.v1.rotate_fernet_keys | | Description | | | Task Execution ID | <none> | | State | RUNNING | | State info | None | | Created at | 2017-12-20 11:13:50 | | Updated at | 2017-12-20 11:13:50 | +-------------------+-------------------------------------------+ [stack@director ~]USD openstack workflow execution show 58c9c664-b966-4f82-b368-af5ed8de5b47 +-------------------+-------------------------------------------+ | Field | Value | +-------------------+-------------------------------------------+ | ID | 58c9c664-b966-4f82-b368-af5ed8de5b47 | | Workflow ID | 78f0990a-3d34-4bf2-a127-10c149bb275c | | Workflow name | tripleo.fernet_keys.v1.rotate_fernet_keys | | Description | | | Task Execution ID | <none> | | State | SUCCESS | | State info | None | | Created at | 2017-12-20 11:13:50 | | Updated at | 2017-12-20 11:15:00 | +-------------------+-------------------------------------------+ [heat-admin@overcloud-controller-0 ~]USD sudo ls /var/lib/config-data/puppet-generated/keystone/etc/keystone/fernet-keys 0 1 2 3