keystone package

Subpackages

Submodules

keystone.backends module

keystone.clean module

keystone.clean.check_enabled(property_name, enabled)[source]
keystone.clean.check_length(property_name, value, min_length=1, max_length=64)[source]
keystone.clean.check_name(property_name, name, min_length=1, max_length=64)[source]
keystone.clean.check_type(property_name, value, expected_type, display_expected_type)[source]
keystone.clean.domain_enabled(enabled)[source]
keystone.clean.domain_name(name)[source]
keystone.clean.group_name(name)[source]
keystone.clean.project_enabled(enabled)[source]
keystone.clean.project_name(name)[source]
keystone.clean.user_enabled(enabled)[source]
keystone.clean.user_name(name)[source]

keystone.cli module

keystone.config module

Wrapper for keystone.common.config that configures itself on import.

keystone.config.find_paste_config()[source]

Find Keystone’s paste.deploy configuration file.

Keystone’s paste.deploy configuration file is specified in the [paste_deploy] section of the main Keystone configuration file, keystone.conf.

For example:

[paste_deploy]
config_file = keystone-paste.ini
Returns:The selected configuration filename
Raises:exception.ConfigFileNotFound
keystone.config.set_default_for_default_log_levels()[source]

Set the default for the default_log_levels option for keystone.

Keystone uses some packages that other OpenStack services don’t use that do logging. This will set the default_log_levels default level for those packages.

This function needs to be called before CONF().

keystone.config.setup_logging()[source]

Sets up logging for the keystone package.

keystone.controllers module

keystone.exception module

exception keystone.exception.AdditionalAuthRequired(auth_response=None, **kwargs)[source]

Bases: keystone.exception.AuthPluginException

message_format = u'Additional authentications steps required.'
exception keystone.exception.AssignmentTypeCalculationError(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

message_format = u'Unexpected combination of grant attributes - User: %(user_id)s, Group: %(group_id)s, Project: %(project_id)s, Domain: %(domain_id)s'
exception keystone.exception.AuthMethodNotSupported(*args, **kwargs)[source]

Bases: keystone.exception.AuthPluginException

message_format = u'Attempted to authenticate with an unsupported method.'
exception keystone.exception.AuthPluginException(*args, **kwargs)[source]

Bases: keystone.exception.Unauthorized

message_format = u'Authentication plugin error.'
exception keystone.exception.CertificateFilesUnavailable(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

debug_message_format = u'Expected signing certificates are not available on the server. Please check Keystone configuration.'
exception keystone.exception.CircularRegionHierarchyError(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 400
message_format = u'The specified parent region %(parent_region_id)s would create a circular region hierarchy.'
title = 'Bad Request'
exception keystone.exception.ConfigFileNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

debug_message_format = u'The Keystone configuration file %(config_file)s could not be found.'
exception keystone.exception.Conflict(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 409
message_format = u'Conflict occurred attempting to store %(type)s - %(details)s'
title = 'Conflict'
exception keystone.exception.CredentialNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find credential: %(credential_id)s'
exception keystone.exception.CrossBackendNotAllowed(message=None, **kwargs)[source]

Bases: keystone.exception.Forbidden

message_format = u'Group membership across backend boundaries is not allowed, group in question is %(group_id)s, user is %(user_id)s'
exception keystone.exception.DomainConfigNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find %(group_or_option)s in domain configuration for domain %(domain_id)s'
exception keystone.exception.DomainNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find domain: %(domain_id)s'
exception keystone.exception.EndpointGroupNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find Endpoint Group: %(endpoint_group_id)s'
exception keystone.exception.EndpointNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find endpoint: %(endpoint_id)s'
exception keystone.exception.Error(message=None, **kwargs)[source]

Bases: exceptions.Exception

Base error class.

Child classes should define an HTTP status code, title, and a message_format.

code = None
message_format = None
title = None
exception keystone.exception.FederatedProtocolNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find federated protocol %(protocol_id)s for Identity Provider: %(idp_id)s'
exception keystone.exception.Forbidden(message=None, **kwargs)[source]

Bases: keystone.exception.SecurityError

code = 403
message_format = u'You are not authorized to perform the requested action.'
title = 'Forbidden'
exception keystone.exception.ForbiddenAction(message=None, **kwargs)[source]

Bases: keystone.exception.Forbidden

message_format = u'You are not authorized to perform the requested action: %(action)s'
exception keystone.exception.Gone(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 410
message_format = u'The service you have requested is no longer available on this server.'
title = 'Gone'
exception keystone.exception.GroupNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find group: %(group_id)s'
exception keystone.exception.IdentityProviderNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find Identity Provider: %(idp_id)s'
exception keystone.exception.ImmutableAttributeError(message=None, **kwargs)[source]

Bases: keystone.exception.Forbidden

message_format = u"Could not change immutable attribute(s) '%(attributes)s' in target %(target)s"
exception keystone.exception.InvalidDomainConfig(message=None, **kwargs)[source]

Bases: keystone.exception.Forbidden

message_format = u'Invalid domain specific configuration: %(reason)s'
exception keystone.exception.InvalidParentProject(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Cannot create project with parent: %(project_id)s'
exception keystone.exception.InvalidPolicyAssociation(message=None, **kwargs)[source]

Bases: keystone.exception.Forbidden

message_format = u'Invalid mix of entities for policy association - only Endpoint, Service or Region+Service allowed. Request was - Endpoint: %(endpoint_id)s, Service: %(service_id)s, Region: %(region_id)s'
exception keystone.exception.KeysNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

message_format = u'No encryption keys found; run keystone-manage fernet_setup to bootstrap one.'
exception keystone.exception.MalformedEndpoint(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

debug_message_format = u'Malformed endpoint URL (%(endpoint)s), see ERROR log for details.'
exception keystone.exception.MappedGroupNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

debug_message_format = u'Group %(group_id)s returned by mapping %(mapping_id)s was not found in the backend.'
exception keystone.exception.MappingNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find mapping: %(mapping_id)s'
exception keystone.exception.MetadataFileError(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

message_format = u'Error while reading metadata file, %(reason)s'
exception keystone.exception.MetadataNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

(dolph): metadata is not a user-facing concept, so this exception should not be exposed

message_format = u'An unhandled exception has occurred: Could not find metadata.'
exception keystone.exception.MigrationNotProvided(mod_name, path)[source]

Bases: exceptions.Exception

exception keystone.exception.MissingGroups(message=None, **kwargs)[source]

Bases: keystone.exception.Unauthorized

message_format = u'Unable to find valid groups while using mapping %(mapping_id)s'
exception keystone.exception.MultipleSQLDriversInConfig(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

message_format = u'The Keystone domain-specific configuration has specified more than one SQL driver (only one is permitted): %(source)s.'
exception keystone.exception.NotFound(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 404
message_format = u'Could not find: %(target)s'
title = 'Not Found'
exception keystone.exception.NotImplemented(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 501
message_format = u'The action you have requested has not been implemented.'
title = 'Not Implemented'
exception keystone.exception.OAuthHeadersMissingError(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

debug_message_format = u'No Authorization headers found, cannot proceed with OAuth related calls, if running under HTTPd or Apache, ensure WSGIPassAuthorization is set to On.'
title = 'Error retrieving OAuth headers'
exception keystone.exception.PKITokenExpected(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 403
message_format = u'The certificates you requested are not available. It is likely that this server does not use PKI tokens otherwise this is the result of misconfiguration.'
title = 'Cannot retrieve certificates'
exception keystone.exception.PasswordVerificationError(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 403
message_format = u'The password length must be less than or equal to %(size)i. The server could not comply with the request because the password is invalid.'
title = 'Forbidden'
exception keystone.exception.PolicyAssociationNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find policy association'
exception keystone.exception.PolicyNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find policy: %(policy_id)s'
exception keystone.exception.ProjectNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find project: %(project_id)s'
exception keystone.exception.PublicIDNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = '%(id)s'
exception keystone.exception.RegionDeletionError(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 403
message_format = u'Unable to delete region %(region_id)s because it or its child regions have associated endpoints.'
title = 'Forbidden'
exception keystone.exception.RegionNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find region: %(region_id)s'
exception keystone.exception.RoleAssignmentNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find role assignment with role: %(role_id)s, user or group: %(actor_id)s, project or domain: %(target_id)s'
exception keystone.exception.RoleNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find role: %(role_id)s'
exception keystone.exception.SAMLSigningError(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

debug_message_format = u'Unable to sign SAML assertion. It is likely that this server does not have xmlsec1 installed, or this is the result of misconfiguration. Reason %(reason)s'
title = 'Error signing SAML assertion'
exception keystone.exception.SchemaValidationError(message=None, **kwargs)[source]

Bases: keystone.exception.ValidationError

message_format = u'%(detail)s'
exception keystone.exception.SecurityError(message=None, **kwargs)[source]

Bases: keystone.exception.Error

Avoids exposing details of security failures, unless in debug mode.

amendment = u'(Disable debug mode to suppress these details.)'
exception keystone.exception.ServiceNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find service: %(service_id)s'
exception keystone.exception.ServiceProviderNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find Service Provider: %(sp_id)s'
exception keystone.exception.StringLengthExceeded(message=None, **kwargs)[source]

Bases: keystone.exception.ValidationError

message_format = u"String length exceeded.The length of string '%(string)s' exceeded the limit of column %(type)s(CHAR(%(length)d))."
exception keystone.exception.TokenNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find token: %(token_id)s'
exception keystone.exception.TrustConsumeMaximumAttempt(message=None, **kwargs)[source]

Bases: keystone.exception.UnexpectedError

debug_message_format = u'Unable to consume trust %(trust_id)s, unable to acquire lock.'
exception keystone.exception.TrustNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find trust: %(trust_id)s'
exception keystone.exception.TrustUseLimitReached(message=None, **kwargs)[source]

Bases: keystone.exception.Forbidden

message_format = u'No remaining uses for trust: %(trust_id)s'
exception keystone.exception.Unauthorized(message=None, **kwargs)[source]

Bases: keystone.exception.SecurityError

code = 401
message_format = u'The request you have made requires authentication.'
title = 'Unauthorized'
exception keystone.exception.UnexpectedError(message=None, **kwargs)[source]

Bases: keystone.exception.SecurityError

Avoids exposing details of failures, unless in debug mode.

code = 500
debug_message_format = u'An unexpected error prevented the server from fulfilling your request: %(exception)s'
message_format[source]

Return the generic message format string unless debug is enabled.

title = 'Internal Server Error'
exception keystone.exception.UnsupportedTokenVersionException[source]

Bases: exceptions.Exception

Token version is unrecognizable or unsupported.

exception keystone.exception.UserNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find user: %(user_id)s'
exception keystone.exception.ValidationError(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 400
message_format = u'Expecting to find %(attribute)s in %(target)s - the server could not comply with the request since it is either malformed or otherwise incorrect. The client is assumed to be in error.'
title = 'Bad Request'
exception keystone.exception.ValidationSizeError(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 400
message_format = u'Request attribute %(attribute)s must be less than or equal to %(size)i. The server could not comply with the request because the attribute size is invalid (too large). The client is assumed to be in error.'
title = 'Bad Request'
exception keystone.exception.ValidationTimeStampError(message=None, **kwargs)[source]

Bases: keystone.exception.Error

code = 400
message_format = u'Timestamp not in expected format. The server could not comply with the request since it is either malformed or otherwise incorrect. The client is assumed to be in error.'
title = 'Bad Request'
exception keystone.exception.VersionNotFound(message=None, **kwargs)[source]

Bases: keystone.exception.NotFound

message_format = u'Could not find version: %(version)s'

keystone.i18n module

oslo.i18n integration module.

See http://docs.openstack.org/developer/oslo.i18n/usage.html .

keystone.notifications module

keystone.routers module

keystone.service module

Module contents