keystoneauth1.http_basic 模块

class keystoneauth1.http_basic.HTTPBasicAuth(endpoint: str | None = None, username: str | None = None, password: str | None = None)

基类: FixedEndpointPlugin

一个提供者,它将始终使用 HTTP Basic 身份验证。

这对于统一可能以独立模式部署的服务的会话/适配器加载非常有用。

__annotations__ = {}
__doc__ = '一个 提供者 ,它将始终使用 HTTP Basic 身份验证。\n\n    这对于统一可能以独立模式部署的服务的会话/适配器加载非常有用。\n    '
__init__(endpoint: str | None = None, username: str | None = None, password: str | None = None)
__module__ = 'keystoneauth1.http_basic'
get_headers(session: ks_session.Session) dict[str, str] | None

获取消息的身份验证头。

这是旧的 get_token 的更通用的替代方案,允许插件指定与 OpenStack 标准“X-Auth-Token”头不同的或额外的身份验证头。

如何获取身份验证头由插件决定。如果头仍然有效,则可以重用、从缓存中检索,或者插件可以调用对服务器的身份验证请求。

get_headers 的默认实现调用 get_token 方法,以使旧式插件能够继续正常运行。子类可以自由地完全覆盖此函数以提供他们想要的头。

返回 None 将指示无法检索到 token,并且授权失败。可以通过返回一个空字典来实现不添加任何身份验证数据。

参数:

session (keystoneauth1.session.Session) – 该认证插件所属的会话对象。

返回值:

用于验证消息的头,或者失败的 None。请注意,空字典是一个有效的、非失败的响应。

返回类型:

dict

get_token(session: ks_session.Session) str | None

获取令牌。

令牌的获取方式由插件决定。如果它仍然有效,则可以重用、从缓存中检索或调用服务器上的身份验证请求。

返回 None 将指示无法检索到令牌。

此函数放置不当,因为它仅应需要使用“X-Auth-Token”标头的身份验证插件。但是,由于插件的演变方式,此方法是必需的,并且通常被调用以触发新插件上的身份验证请求。

在实现新插件时,建议您实现此方法,但是,如果您不需要“X-Auth-Token”标头,请改写 get_headers 方法。

参数:

session (keystoneauth1.session.Session) – 一个会话对象,以便插件可以进行 HTTP 调用。

返回值:

要使用的令牌。

返回类型:

字符串