keystoneauth1.identity package

Subpackages

Submodules

Module contents

class keystoneauth1.identity.BaseIdentityPlugin(auth_url: str | None = None, reauthenticate: bool = True)

Bases: BaseAuthPlugin

MIN_TOKEN_LIFE_SECONDS: int = 120
__abstractmethods__ = frozenset({'get_auth_ref'})
__annotations__ = {'MIN_TOKEN_LIFE_SECONDS': <class 'int'>, '_discovery_cache': 'dict[str, discover.Discover]', 'auth_ref': typing.Optional[keystoneauth1.access.access.AccessInfo], 'auth_url': typing.Optional[str], 'reauthenticate': <class 'bool'>}
__doc__ = None
__firstlineno__ = 31
__init__(auth_url: str | None = None, reauthenticate: bool = True)
__module__ = 'keystoneauth1.identity.base'
__static_attributes__ = ('_lock', 'auth_ref', 'auth_url', 'reauthenticate')
_abc_impl = <_abc._abc_data object>
_needs_reauthenticate() → bool

Return if the existing token needs to be re-authenticated.

The token should be refreshed if it is about to expire.

Returns:

True if the plugin should fetch a new token. False otherwise.

auth_ref: AccessInfo | None
auth_url: str | None
get_access(session: Session, **kwargs: Any) → AccessInfo

Fetch or return a current AccessInfo object.

If a valid AccessInfo is present then it is returned otherwise a new one will be fetched.

Parameters:

session (keystoneauth1.session.Session) – A session object that can be used for communication.

Raises:

keystoneauth1.exceptions.http.HttpError – An error from an invalid HTTP response.

Returns:

Valid AccessInfo

Return type:

keystoneauth1.access.AccessInfo

get_all_version_data(session: Session, interface: str = 'public', region_name: str | None = None, service_type: str | None = None) → dict[str, dict[str, dict[str, list[VersionData]]]]

Get version data for all services in the catalog.

Parameters:

  • session (keystoneauth1.session.Session) – A session object that can be used for communication.

  • interface – Type of endpoint to get version data for. Can be a single value or a list of values. A value of None indicates that all interfaces should be queried. (optional, defaults to public)

  • region_name (string) – Region of endpoints to get version data for. A valueof None indicates that all regions should be queried. (optional, defaults to None)

  • service_type (string) – Limit the version data to a single service. (optional, defaults to None)

Returns:

A dictionary keyed by region_name with values containing dictionaries keyed by interface with values being a list of VersionData.

get_api_major_version(session: Session, *, endpoint_override: str | None = None, service_type: str | None = None, interface: str | None = None, region_name: str | None = None, service_name: str | None = None, version: str | None = None, allow: dict[str, Any] | None = None, allow_version_hack: bool = True, skip_discovery: bool = False, discover_versions: bool = False, min_version: str | int | float | Iterable[str | int | float] | None = None, max_version: str | int | float | Iterable[str | int | float] | None = None, **kwargs: Any) → tuple[int | float, ...] | None

Return the major API version for a service.

If a valid token is not present then a new one will be fetched using the session and kwargs.

version, min_version and max_version can all be given either as a string or a tuple.

Valid interface types: public or publicURL,

internal or internalURL, admin or ‘adminURL`

Parameters:

  • session (keystoneauth1.session.Session) – A session object that can be used for communication.

  • endpoint_override (str) – URL to use for version discovery.

  • service_type (string) – The type of service to lookup the endpoint for. This plugin will return None (failure) if service_type is not provided.

  • interface – Type of endpoint. Can be a single value or a list of values. If it’s a list of values, they will be looked for in order of preference. Can also be keystoneauth1.plugin.AUTH_INTERFACE to indicate that the auth_url should be used instead of the value in the catalog. (optional, defaults to public)

  • region_name (string) – The region the endpoint should exist in. (optional)

  • service_name (string) – The name of the service in the catalog. (optional)

  • version – The minimum version number required for this endpoint. (optional)

  • allow (dict) – Extra filters to pass when discovering API versions. (optional)

  • allow_version_hack (bool) – Allow keystoneauth to hack up catalog URLS to support older schemes. (optional, default True)

  • skip_discovery (bool) – Whether to skip version discovery even if a version has been given. This is useful if endpoint_override or similar has been given and grabbing additional information about the endpoint is not useful.

  • discover_versions (bool) – Whether to get version metadata from the version discovery document even if it’s not neccessary to fulfill the major version request. Defaults to False because get_endpoint doesn’t need metadata. (optional, defaults to False)

  • min_version – The minimum version that is acceptable. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is ‘latest’. (optional)

  • max_version – The maximum version that is acceptable. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is ‘latest’. (optional)

Raises:

keystoneauth1.exceptions.http.HttpError – An error from an invalid HTTP response.

Returns:

The major version of the API of the service discovered.

Return type:

tuple or None

Note

Implementation notes follow. Users should not need to wrap their head around these implementation notes. get_api_major_version should do what is expected with the least possible cost while still consistently returning a value if possible.

There are many cases when major version can be satisfied without actually calling the discovery endpoint (like when the version is in the url). If the user has a cloud with the versioned endpoint https://volume.example.com/v3 in the catalog for the block-storage service and they do:

client = adapter.Adapter(
    session,
    service_type='block-storage',
    min_version=2,
    max_version=3,
)
volume_version = client.get_api_major_version()

The version actually be returned with no api calls other than getting the token. For that reason, get_api_major_version() first calls get_endpoint_data() with discover_versions=False.

If their catalog has an unversioned endpoint https://volume.example.com for the block-storage service and they do this:

client = adapter.Adapter(session, service_type='block-storage')

client is now set up to “use whatever is in the catalog”. Since the url doesn’t have a version, get_endpoint_data() with discover_versions=False will result in api_version=None. (No version was requested so it didn’t need to do the round trip)

In order to find out what version the endpoint actually is, we must make a round trip. Therefore, if api_version is None after the first call, get_api_major_version() will make a second call to get_endpoint_data() with discover_versions=True.

abstract get_auth_ref(session: Session) → AccessInfo

Obtain a token from an OpenStack Identity Service.

This method is overridden by the various token version plugins.

This function should not be called independently and is expected to be invoked via the do_authenticate function.

This function will be invoked if the AcessInfo object cached by the plugin is not valid. Thus plugins should always fetch a new AccessInfo when invoked. If you are looking to just retrieve the current auth data then you should use get_access.

Parameters:

session (keystoneauth1.session.Session) – A session object that can be used for communication.

Raises:
Returns:

Token access information.

Return type:

keystoneauth1.access.AccessInfo

get_auth_state() → str | None

Retrieve the current authentication state for the plugin.

Retrieve any internal state that represents the authenticated plugin.

This should not fetch any new data if it is not present.

Returns:

a string that can be stored or None if there is no auth state present in the plugin. This string can be reloaded with set_auth_state to set the same authentication.

Return type:

str or None if no auth present.

get_cache_id() → str | None

Fetch an identifier that uniquely identifies the auth options.

The returned identifier need not be decomposable or otherwise provide any way to recreate the plugin.

This string MUST change if any of the parameters that are used to uniquely identity this plugin change. It should not change upon a reauthentication of the plugin.

Returns:

A unique string for the set of options

Return type:

str or None if this is unsupported or unavailable.

get_cache_id_elements() → dict[str, str | None]

Get the elements for this auth plugin that make it unique.

As part of the get_cache_id requirement we need to determine what aspects of this plugin and its values that make up the unique elements.

This should be overridden by plugins that wish to allow caching.

Returns:

The unique attributes and values of this plugin.

Return type:

A flat dict with a str key and str or None value. This is required as we feed these values into a hash. Pairs where the value is None are ignored in the hashed id.

get_discovery(session: Session, url: str, authenticated: bool | None = None) → Discover

Return the discovery object for a URL.

Check the session and the plugin cache to see if we have already performed discovery on the URL and if so return it, otherwise create a new discovery object, cache it and return it.

This function is expected to be used by subclasses and should not be needed by users.

Parameters:

  • session (keystoneauth1.session.Session) – A session object to discover with.

  • url (str) – The url to lookup.

  • authenticated (bool) – Include a token in the discovery call. (optional) Defaults to None (use a token if a plugin is installed).

Raises:
Returns:

A discovery object with the results of looking up that URL.

get_endpoint(session: Session, service_type: str | None = None, interface: str | None = None, region_name: str | None = None, service_name: str | None = None, version: str | int | float | Iterable[str | int | float] | None = None, allow: dict[str, Any] | None = None, allow_version_hack: bool = True, skip_discovery: bool = False, min_version: str | int | float | Iterable[str | int | float] | None = None, max_version: str | int | float | Iterable[str | int | float] | None = None, **kwargs: Any) → str | None

Return a valid endpoint for a service.

If a valid token is not present then a new one will be fetched using the session and kwargs.

version, min_version and max_version can all be given either as a string or a tuple.

Valid interface types: public or publicURL,

internal or internalURL, admin or ‘adminURL`

Parameters:

  • session (keystoneauth1.session.Session) – A session object that can be used for communication.

  • service_type (string) – The type of service to lookup the endpoint for. This plugin will return None (failure) if service_type is not provided.

  • interface – Type of endpoint. Can be a single value or a list of values. If it’s a list of values, they will be looked for in order of preference. Can also be keystoneauth1.plugin.AUTH_INTERFACE to indicate that the auth_url should be used instead of the value in the catalog. (optional, defaults to public)

  • region_name (string) – The region the endpoint should exist in. (optional)

  • service_name (string) – The name of the service in the catalog. (optional)

  • version – The minimum version number required for this endpoint. (optional)

  • allow (dict) – Extra filters to pass when discovering API versions. (optional)

  • allow_version_hack (bool) – Allow keystoneauth to hack up catalog URLS to support older schemes. (optional, default True)

  • skip_discovery (bool) – Whether to skip version discovery even if a version has been given. This is useful if endpoint_override or similar has been given and grabbing additional information about the endpoint is not useful.

  • min_version – The minimum version that is acceptable. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is ‘latest’. (optional)

  • max_version – The maximum version that is acceptable. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is ‘latest’. (optional)

Raises:

keystoneauth1.exceptions.http.HttpError – An error from an invalid HTTP response.

Returns:

A valid endpoint URL or None if not available.

Return type:

string or None

get_endpoint_data(session: Session, *, endpoint_override: str | None = None, discover_versions: bool = True, service_type: str | None = None, interface: str | None = None, region_name: str | None = None, service_name: str | None = None, allow: dict[str, Any] | None = None, allow_version_hack: bool = True, skip_discovery: bool = False, min_version: str | int | float | Iterable[str | int | float] | None = None, max_version: str | int | float | Iterable[str | int | float] | None = None, **kwargs: Any) → EndpointData | None

Return a valid endpoint data for a service.

If a valid token is not present then a new one will be fetched using the session and kwargs.

version, min_version and max_version can all be given either as a string or a tuple.

Valid interface types: public or publicURL,

internal or internalURL, admin or ‘adminURL`

Parameters:

  • session (keystoneauth1.session.Session) – A session object that can be used for communication.

  • endpoint_override (str) – URL to use instead of looking in the catalog. Catalog lookup will be skipped, but version discovery will be run. Sets allow_version_hack to False (optional)

  • discover_versions (bool) – Whether to get version metadata from the version discovery document even if it’s not neccessary to fulfill the major version request. (optional, defaults to True)

  • service_type (string) – The type of service to lookup the endpoint for. This plugin will return None (failure) if service_type is not provided.

  • interface – Type of endpoint. Can be a single value or a list of values. If it’s a list of values, they will be looked for in order of preference. Can also be keystoneauth1.plugin.AUTH_INTERFACE to indicate that the auth_url should be used instead of the value in the catalog. (optional, defaults to public)

  • region_name (string) – The region the endpoint should exist in. (optional)

  • service_name (string) – The name of the service in the catalog. (optional)

  • allow (dict) – Extra filters to pass when discovering API versions. (optional)

  • allow_version_hack (bool) – Allow keystoneauth to hack up catalog URLS to support older schemes. (optional, default True)

  • skip_discovery (bool) – Whether to skip version discovery even if a version has been given. This is useful if endpoint_override or similar has been given and grabbing additional information about the endpoint is not useful.

  • min_version – The minimum version that is acceptable. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is ‘latest’. (optional)

  • max_version – The maximum version that is acceptable. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is ‘latest’. (optional)

  • kwargs – Ignored.

Raises:

keystoneauth1.exceptions.http.HttpError – An error from an invalid HTTP response.

Returns:

Valid EndpointData or None if not available.

Return type:

keystoneauth1.discover.EndpointData or None

get_project_id(session: Session) → str | None

Return the project id that we are authenticated to.

Wherever possible the project id should be inferred from the token however there are certain URLs and other places that require access to the currently authenticated project id.

Parameters:

session (keystoneauth1.session.Session) – A session object so the plugin can make HTTP calls.

Returns:

A project identifier or None if one is not available.

Return type:

str

get_sp_auth_url(session: Session, sp_id: str) → str | None

Return auth_url from the Service Provider object.

This url is used for obtaining unscoped federated token from remote cloud.

Parameters:

sp_id (string) – ID of the Service Provider to be queried.

Returns:

A Service Provider auth_url or None if one is not available.

Return type:

str

get_sp_url(session: Session, sp_id: str) → str | None

Return sp_url from the Service Provider object.

This url is used for passing SAML2 assertion to the remote cloud.

Parameters:

sp_id (str) – ID of the Service Provider to be queried.

Returns:

A Service Provider sp_url or None if one is not available.

Return type:

str

get_token(session: Session) → str | None

Return a valid auth token.

If a valid token is not present then a new one will be fetched.

Parameters:

session (keystoneauth1.session.Session) – A session object that can be used for communication.

Raises:

keystoneauth1.exceptions.http.HttpError – An error from an invalid HTTP response.

Returns:

A valid token.

Return type:

string

get_user_id(session: Session) → str | None

Return a unique user identifier of the plugin.

Wherever possible the user id should be inferred from the token however there are certain URLs and other places that require access to the currently authenticated user id.

Parameters:

session (keystoneauth1.session.Session) – A session object so the plugin can make HTTP calls.

Returns:

A user identifier or None if one is not available.

Return type:

str

invalidate() → bool

Invalidate the current authentication data.

This should result in fetching a new token on next call.

A plugin may be invalidated if an Unauthorized HTTP response is returned to indicate that the token may have been revoked or is otherwise now invalid.

Returns:

True if there was something that the plugin did to invalidate. This means that it makes sense to try again. If nothing happens returns False to indicate give up.

Return type:

bool

reauthenticate: bool
set_auth_state(data: str) → None

Install existing authentication state for a plugin.

Take the output of get_auth_state and install that authentication state into the current authentication plugin.

class keystoneauth1.identity.Password(auth_url: str, username: str | None = None, user_id: str | None = None, password: str | None = None, user_domain_id: str | None = None, user_domain_name: str | None = None, *, tenant_id: str | None = None, tenant_name: str | None = None, project_id: str | None = None, project_name: str | None = None, project_domain_id: str | None = None, project_domain_name: str | None = None, domain_id: str | None = None, domain_name: str | None = None, system_scope: str | None = None, trust_id: str | None = None, default_domain_id: str | None = None, default_domain_name: str | None = None, reauthenticate: bool = True)

Bases: BaseGenericPlugin

A common user/password authentication plugin.

Parameters:

  • username (string) – Username for authentication.

  • user_id (string) – User ID for authentication.

  • password (string) – Password for authentication.

  • user_domain_id (string) – User’s domain ID for authentication.

  • user_domain_name (string) – User’s domain name for authentication.

__abstractmethods__ = frozenset({})
__annotations__ = {'MIN_TOKEN_LIFE_SECONDS': 'int', '_discovery_cache': 'dict[str, discover.Discover]', '_plugin': 'ty.Union[v2.Auth, v3.Auth, None]', 'auth_ref': 'ty.Optional[access.AccessInfo]', 'auth_url': 'str', 'reauthenticate': 'bool'}
__doc__ = "A common user/password authentication plugin.\n\n:param string username: Username for authentication.\n:param string user_id: User ID for authentication.\n:param string password: Password for authentication.\n:param string user_domain_id: User's domain ID for authentication.\n:param string user_domain_name: User's domain name for authentication.\n"
__firstlineno__ = 22
__init__(auth_url: str, username: str | None = None, user_id: str | None = None, password: str | None = None, user_domain_id: str | None = None, user_domain_name: str | None = None, *, tenant_id: str | None = None, tenant_name: str | None = None, project_id: str | None = None, project_name: str | None = None, project_domain_id: str | None = None, project_domain_name: str | None = None, domain_id: str | None = None, domain_name: str | None = None, system_scope: str | None = None, trust_id: str | None = None, default_domain_id: str | None = None, default_domain_name: str | None = None, reauthenticate: bool = True)
__module__ = 'keystoneauth1.identity.generic.password'
__static_attributes__ = ('_password', '_user_domain_id', '_user_domain_name', '_user_id', '_username')
_abc_impl = <_abc._abc_data object>
create_plugin(session: Session, version: tuple[int | float, ...], url: str, raw_status: str | None = None) → None | Password | Password

Create a plugin from the given parameters.

This function will be called multiple times with the version and url of a potential endpoint. If a plugin can be constructed that fits the params then it should return it. If not return None and then another call will be made with other available URLs.

Parameters:

  • session (keystoneauth1.session.Session) – A session object.

  • version (tuple) – A tuple of the API version at the URL.

  • url (str) – The base URL for this version.

  • raw_status (str) – The status that was in the discovery field.

Returns:

A plugin that can match the parameters or None if nothing.

get_cache_id_elements() → dict[str, str | None]

Get the elements for this auth plugin that make it unique.

As part of the get_cache_id requirement we need to determine what aspects of this plugin and its values that make up the unique elements.

This should be overridden by plugins that wish to allow caching.

Returns:

The unique attributes and values of this plugin.

Return type:

A flat dict with a str key and str or None value. This is required as we feed these values into a hash. Pairs where the value is None are ignored in the hashed id.

property user_domain_id: str | None
property user_domain_name: str | None
class keystoneauth1.identity.Token(auth_url: str, token: str, *, tenant_id: str | None = None, tenant_name: str | None = None, project_id: str | None = None, project_name: str | None = None, project_domain_id: str | None = None, project_domain_name: str | None = None, domain_id: str | None = None, domain_name: str | None = None, system_scope: str | None = None, trust_id: str | None = None, default_domain_id: str | None = None, default_domain_name: str | None = None, reauthenticate: bool = True)

Bases: BaseGenericPlugin

Generic token auth plugin.

Parameters:

token (string) – Token for authentication.

__abstractmethods__ = frozenset({})
__annotations__ = {'MIN_TOKEN_LIFE_SECONDS': 'int', '_discovery_cache': 'dict[str, discover.Discover]', '_plugin': 'ty.Union[v2.Auth, v3.Auth, None]', 'auth_ref': 'ty.Optional[access.AccessInfo]', 'auth_url': 'str', 'reauthenticate': 'bool'}
__doc__ = 'Generic token auth plugin.\n\n:param string token: Token for authentication.\n'
__firstlineno__ = 22
__init__(auth_url: str, token: str, *, tenant_id: str | None = None, tenant_name: str | None = None, project_id: str | None = None, project_name: str | None = None, project_domain_id: str | None = None, project_domain_name: str | None = None, domain_id: str | None = None, domain_name: str | None = None, system_scope: str | None = None, trust_id: str | None = None, default_domain_id: str | None = None, default_domain_name: str | None = None, reauthenticate: bool = True)
__module__ = 'keystoneauth1.identity.generic.token'
__static_attributes__ = ('_token',)
_abc_impl = <_abc._abc_data object>
create_plugin(session: Session, version: tuple[int | float, ...], url: str, raw_status: str | None = None) → None | Token | Token

Create a plugin from the given parameters.

This function will be called multiple times with the version and url of a potential endpoint. If a plugin can be constructed that fits the params then it should return it. If not return None and then another call will be made with other available URLs.

Parameters:

  • session (keystoneauth1.session.Session) – A session object.

  • version (tuple) – A tuple of the API version at the URL.

  • url (str) – The base URL for this version.

  • raw_status (str) – The status that was in the discovery field.

Returns:

A plugin that can match the parameters or None if nothing.

get_cache_id_elements() → dict[str, str | None]

Get the elements for this auth plugin that make it unique.

As part of the get_cache_id requirement we need to determine what aspects of this plugin and its values that make up the unique elements.

This should be overridden by plugins that wish to allow caching.

Returns:

The unique attributes and values of this plugin.

Return type:

A flat dict with a str key and str or None value. This is required as we feed these values into a hash. Pairs where the value is None are ignored in the hashed id.

keystoneauth1.identity.V2Password

See keystoneauth1.identity.v2.Password

keystoneauth1.identity.V2Token

See keystoneauth1.identity.v2.Token

keystoneauth1.identity.V3ApplicationCredential

See keystoneauth1.identity.v3.ApplicationCredential

keystoneauth1.identity.V3MultiFactor

See keystoneauth1.identity.v3.MultiFactor

keystoneauth1.identity.V3OAuth2ClientCredential

See keystoneauth1.identity.v3.OAuth2ClientCredential

keystoneauth1.identity.V3OAuth2mTlsClientCredential

See keystoneauth1.identity.v3.OAuth2mTlsClientCredential

keystoneauth1.identity.V3OidcAccessToken

See keystoneauth1.identity.v3.oidc.OidcAccessToken

keystoneauth1.identity.V3OidcAuthorizationCode

See keystoneauth1.identity.v3.oidc.OidcAuthorizationCode

keystoneauth1.identity.V3OidcClientCredentials

See keystoneauth1.identity.v3.oidc.OidcClientCredentials

keystoneauth1.identity.V3OidcDeviceAuthorization

See keystoneauth1.identity.v3.oidc.OidcDeviceAuthorization

keystoneauth1.identity.V3OidcPassword

See keystoneauth1.identity.v3.oidc.OidcPassword

keystoneauth1.identity.V3Password

See keystoneauth1.identity.v3.Password

keystoneauth1.identity.V3TOTP

See keystoneauth1.identity.v3.TOTP

keystoneauth1.identity.V3Token

See keystoneauth1.identity.v3.Token

keystoneauth1.identity.V3TokenlessAuth

See keystoneauth1.identity.v3.TokenlessAuth