1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import typing as ty
from keystoneauth1.identity.v3 import base
from keystoneauth1 import session as ks_session
__all__ = ('ReceiptMethod',)
class ReceiptMethod(base.AuthMethod):
"""Construct an Auth plugin to continue authentication with a receipt.
:param string receipt: Receipt for authentication.
"""
receipt: str
def __init__(self, *, receipt: str) -> None:
self.receipt = receipt
def get_auth_data(
self,
session: ks_session.Session,
auth: base.Auth,
headers: dict[str, str],
request_kwargs: dict[str, object],
) -> tuple[None, None] | tuple[str, ty.Mapping[str, object]]:
"""Add the auth receipt to the headers.
We explicitly return None to avoid being added to the request
methods, or body.
"""
headers['Openstack-Auth-Receipt'] = self.receipt
return (None, None)
def get_cache_id_elements(self) -> dict[str, str | None]:
return {'receipt_receipt': self.receipt}
|