keystone.cmd.cli module

class keystone.cmd.cli.BaseApp[source]

Bases: object

classmethod add_argument_parser(subparsers)[source]
name = None
class keystone.cmd.cli.BasePermissionsSetup[source]

Bases: BaseApp

Common user/group setup for file permissions.

classmethod add_argument_parser(subparsers)[source]
static get_user_group()[source]
classmethod initialize_fernet_repository(keystone_user_id, keystone_group_id, config_group=None)[source]
classmethod rotate_fernet_repository(keystone_user_id, keystone_group_id, config_group=None)[source]
class keystone.cmd.cli.BootStrap[source]

Bases: BaseApp

Perform the basic bootstrap process.

classmethod add_argument_parser(subparsers)[source]
do_bootstrap()[source]

Perform the bootstrap actions.

Create bootstrap user, project, and role so that CMS, humans, or scripts can continue to perform initial setup (domains, projects, services, endpoints, etc) of Keystone when standing up a new deployment.

classmethod main()[source]
name = 'bootstrap'
class keystone.cmd.cli.CreateJWSKeyPair[source]

Bases: BasePermissionsSetup

Create a key pair for signing and validating JWS tokens.

This command creates a public and private key pair to use for signing and validating JWS token signatures. The key pair is written to the directory where the command is invoked.

classmethod add_argument_parser(subparsers)[source]
classmethod main()[source]
name = 'create_jws_keypair'
class keystone.cmd.cli.CredentialMigrate[source]

Bases: BasePermissionsSetup

Provides the ability to encrypt credentials using a new primary key.

This assumes that there is already a credential key repository in place and that the database backend has been upgraded to at least the Newton schema. If the credential repository doesn’t exist yet, you can use keystone-manage credential_setup to create one.

classmethod main()[source]
migrate_credentials()[source]
name = 'credential_migrate'
class keystone.cmd.cli.CredentialRotate[source]

Bases: BasePermissionsSetup

Rotate Fernet encryption keys for credential encryption.

This assumes you have already run keystone-manage credential_setup.

A new primary key is placed into rotation only if all credentials are encrypted with the current primary key. If any credentials are encrypted with a secondary key the rotation will abort. This protects against removing a key that is still required to decrypt credentials. Once a key is removed from the repository, it is impossible to recover the original data without restoring from a backup external to keystone (more on backups below). To make sure all credentials are encrypted with the latest primary key, please see the keystone-manage credential_migrate command. Since the maximum number of keys in the credential repository is 3, once all credentials are encrypted with the latest primary key we can safely introduce a new primary key. All credentials will still be decryptable since they are all encrypted with the only secondary key in the repository.

It is imperitive to understand the importance of backing up keys used to encrypt credentials. In the event keys are overrotated, applying a key repository from backup can help recover otherwise useless credentials. Persisting snapshots of the key repository in secure and encrypted source control, or a dedicated key management system are good examples of encryption key backups.

The keystone-manage credential_rotate and keystone-manage credential_migrate commands are intended to be done in sequence. After performing a rotation, a migration must be done before performing another rotation. This ensures we don’t over-rotate encryption keys.

classmethod main()[source]
name = 'credential_rotate'
validate_primary_key()[source]
class keystone.cmd.cli.CredentialSetup[source]

Bases: BasePermissionsSetup

Setup a Fernet key repository for credential encryption.

The purpose of this command is very similar to keystone-manage fernet_setup only the keys included in this repository are for encrypting and decrypting credential secrets instead of token payloads. Keys can be rotated using keystone-manage credential_rotate.

classmethod main()[source]
name = 'credential_setup'
class keystone.cmd.cli.DbSync[source]

Bases: BaseApp

Sync the database.

classmethod add_argument_parser(subparsers)[source]
classmethod check_db_sync_status()[source]
static main()[source]
name = 'db_sync'
class keystone.cmd.cli.DbVersion[source]

Bases: BaseApp

Print the current migration version of the database.

static main()[source]
name = 'db_version'
class keystone.cmd.cli.Doctor[source]

Bases: BaseApp

Diagnose common problems with keystone deployments.

classmethod add_argument_parser(subparsers)[source]
static main()[source]
name = 'doctor'
class keystone.cmd.cli.DomainConfigUpload[source]

Bases: BaseApp

Upload the domain specific configuration files to the database.

classmethod add_argument_parser(subparsers)[source]
static main()[source]
name = 'domain_config_upload'
class keystone.cmd.cli.DomainConfigUploadFiles(domain_config_finder=<function _domain_config_finder>)[source]

Bases: object

load_backends()[source]
read_domain_configs_from_files()[source]

Read configs from file(s) and load into database.

The command line parameters have already been parsed and the CONF command option will have been set. It is either set to the name of an explicit domain, or it’s None to indicate that we want all domain config files.

run()[source]
valid_options()[source]

Validate the options, returning True if they are indeed valid.

It would be nice to use the argparse automated checking for this validation, but the only way I can see doing that is to make the default (i.e. if no optional parameters are specified) to upload all configuration files - and that sounds too dangerous as a default. So we use it in a slightly unconventional way, where all parameters are optional, but you must specify at least one.

class keystone.cmd.cli.FernetRotate[source]

Bases: BasePermissionsSetup

Rotate Fernet encryption keys.

This assumes you have already run keystone-manage fernet_setup.

A new primary key is placed into rotation, which is used for new tokens. The old primary key is demoted to secondary, which can then still be used for validating tokens. Excess secondary keys (beyond [fernet_tokens] max_active_keys) are revoked. Revoked keys are permanently deleted. A new staged key will be created and used to validate tokens. The next time key rotation takes place, the staged key will be put into rotation as the primary key.

Rotating keys too frequently, or with [fernet_tokens] max_active_keys set too low, will cause tokens to become invalid prior to their expiration.

classmethod main()[source]
name = 'fernet_rotate'
class keystone.cmd.cli.FernetSetup[source]

Bases: BasePermissionsSetup

Setup key repositories for Fernet tokens and auth receipts.

This also creates a primary key used for both creating and validating Fernet tokens and auth receipts. To improve security, you should rotate your keys (using keystone-manage fernet_rotate, for example).

classmethod main()[source]
name = 'fernet_setup'
class keystone.cmd.cli.MappingEngineTester[source]

Bases: BaseApp

Execute mapping engine locally.

classmethod add_argument_parser(subparsers)[source]
classmethod main()[source]
name = 'mapping_engine'
normalize_assertion()[source]
normalize_rules()[source]
read_assertion(path)[source]
read_rules(path)[source]
class keystone.cmd.cli.MappingPopulate[source]

Bases: BaseApp

Pre-populate entries from domain-specific backends.

Running this command is not required. It should only be run right after the LDAP was configured, when many new users were added, or when “mapping_purge” is run.

This command will take a while to run. It is perfectly fine for it to run more than several minutes.

classmethod add_argument_parser(subparsers)[source]
classmethod load_backends()[source]
classmethod main()[source]

Process entries for id_mapping_api.

name = 'mapping_populate'
class keystone.cmd.cli.MappingPurge[source]

Bases: BaseApp

Purge the mapping table.

classmethod add_argument_parser(subparsers)[source]
static main()[source]
name = 'mapping_purge'
class keystone.cmd.cli.ReceiptRotate[source]

Bases: BasePermissionsSetup

Rotate auth receipts encryption keys.

This assumes you have already run keystone-manage receipt_setup.

A new primary key is placed into rotation, which is used for new receipts. The old primary key is demoted to secondary, which can then still be used for validating receipts. Excess secondary keys (beyond [receipt] max_active_keys) are revoked. Revoked keys are permanently deleted. A new staged key will be created and used to validate receipts. The next time key rotation takes place, the staged key will be put into rotation as the primary key.

Rotating keys too frequently, or with [receipt] max_active_keys set too low, will cause receipts to become invalid prior to their expiration.

classmethod main()[source]
name = 'receipt_rotate'
class keystone.cmd.cli.ReceiptSetup[source]

Bases: BasePermissionsSetup

Setup a key repository for auth receipts.

This also creates a primary key used for both creating and validating receipts. To improve security, you should rotate your keys (using keystone-manage receipt_rotate, for example).

classmethod main()[source]
name = 'receipt_setup'
class keystone.cmd.cli.SamlIdentityProviderMetadata[source]

Bases: BaseApp

Generate Identity Provider metadata.

static main()[source]
name = 'saml_idp_metadata'
class keystone.cmd.cli.TokenRotate[source]

Bases: BasePermissionsSetup

Rotate token encryption keys.

This assumes you have already run keystone-manage token_setup.

A new primary key is placed into rotation, which is used for new tokens. The old primary key is demoted to secondary, which can then still be used for validating tokens. Excess secondary keys (beyond [token] max_active_keys) are revoked. Revoked keys are permanently deleted. A new staged key will be created and used to validate tokens. The next time key rotation takes place, the staged key will be put into rotation as the primary key.

Rotating keys too frequently, or with [token] max_active_keys set too low, will cause tokens to become invalid prior to their expiration.

classmethod main()[source]
name = 'token_rotate'
class keystone.cmd.cli.TokenSetup[source]

Bases: BasePermissionsSetup

Setup a key repository for tokens.

This also creates a primary key used for both creating and validating tokens. To improve security, you should rotate your keys (using keystone-manage token_rotate, for example).

classmethod main()[source]
name = 'token_setup'
class keystone.cmd.cli.TrustFlush[source]

Bases: BaseApp

Flush expired and non-expired soft deleted trusts from the backend.

classmethod add_argument_parser(subparsers)[source]
classmethod main()[source]
name = 'trust_flush'
keystone.cmd.cli.add_command_parsers(subparsers)[source]
keystone.cmd.cli.main(argv=None, developer_config_file=None)[source]

Main entry point into the keystone-manage CLI utility.

Parameters:
  • argv (list) – Arguments supplied via the command line using the sys standard library.

  • developer_config_file (string) – The location of a configuration file normally found in development environments.