keystone.auth package

Subpackages

• keystone.auth.plugins package
  • Submodules
  • keystone.auth.plugins.base module
  • keystone.auth.plugins.core module
  • keystone.auth.plugins.external module
  • keystone.auth.plugins.mapped module
  • keystone.auth.plugins.oauth1 module
  • keystone.auth.plugins.password module
  • keystone.auth.plugins.token module
  • keystone.auth.plugins.totp module
  • Module contents

Submodules

keystone.auth.controllers module

class keystone.auth.controllers.Auth(*args, **kw)

Bases: keystone.common.controller.V3Controller

authenticate(request, auth_info, auth_context)

Authenticate user.

authenticate_for_token(request, auth=None)

Authenticate user and issue a token.

check_token(request, *args, **kwargs)

collection_name = 'tokens'

get_auth_catalog(request, *args, **kwargs)

get_auth_domains(request, *args, **kwargs)

get_auth_projects(request, *args, **kwargs)

member_name = 'token'

revocation_list(request, *args, **kwargs)

revoke_token(request, *args, **kwargs)

validate_token(request, *args, **kwargs)

keystone.auth.controllers.render_token_data_response(token_id, token_data, created=False)

Render token data HTTP response.

Stash token ID into the X-Subject-Token header.

keystone.auth.controllers.validate_issue_token_auth(auth=None)

keystone.auth.core module

class keystone.auth.core.AuthContext

Bases: dict

Retrofitting auth_context to reconcile identity attributes.

The identity attributes must not have conflicting values among the auth plug-ins. The only exception is expires_at, which is set to its earliest value.

IDENTITY_ATTRIBUTES = frozenset(['expires_at', 'project_id', 'access_token_id', 'user_id', 'domain_id'])

update(E=None, **F)

Override update to prevent conflicting values.

class keystone.auth.core.AuthInfo(*args, **kwargs)

Bases: object

Encapsulation of “auth” request.

static create(auth=None, scope_only=False)

get_method_data(method)

Get the auth method payload.

Returns:auth method payload

get_method_names()

Return the identity method names.

Returns:list of auth method names

get_scope()

Get scope information.

Verify and return the scoping information.

Returns:(domain_id, project_id, trust_ref, unscoped). If scope to a project, (None, project_id, None, None) will be returned. If scoped to a domain, (domain_id, None, None, None) will be returned. If scoped to a trust, (None, project_id, trust_ref, None), Will be returned, where the project_id comes from the trust definition. If unscoped, (None, None, None, ‘unscoped’) will be returned.

set_scope(domain_id=None, project_id=None, trust=None, unscoped=None)

Set scope information.

class keystone.auth.core.UserMFARulesValidator(*args, **kwargs)

Bases: object

Helper object that can validate the MFA Rules.

check_auth_methods_against_rules(user_id, auth_methods)

Validate the MFA rules against the successful auth methods.

Parameters:

• user_id (str) – The user’s ID (uuid).
• auth_methods (set) – List of methods that were used for auth

Returns:

Boolean, True means rules match and auth may proceed, False means rules do not match.

keystone.auth.core.get_auth_method(method_name)

keystone.auth.core.load_auth_method(method)

keystone.auth.core.load_auth_methods()

keystone.auth.routers module

class keystone.auth.routers.Routers

Bases: keystone.common.wsgi.RoutersBase

append_v3_routers(mapper, routers)

keystone.auth.schema module

Module contents