File: //snap/google-cloud-cli/396/lib/googlecloudsdk/core/credentials/creds_context_managers.py
# -*- coding: utf-8 -*- #
# Copyright 2020 Google LLC. All Rights Reserved.
#
# 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.
"""Context managers related to credentials and authentication.
Context managers allow use of "with" syntax for managing credentials.
Example:
with CredentialProvidersManager():
# Task requiring credentials.
"""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.iamcredentials import util as iamcred_util
from googlecloudsdk.core.credentials import store
class CredentialProvidersManager(object):
"""Context manager for handling credential provider registration."""
def __init__(self, credential_providers=None):
"""Initializes context manager with optional credential providers.
Args:
credential_providers (list[object]): List of provider classes like those
defined in core.credentials.store.py.
"""
self._credential_providers = credential_providers
def __enter__(self):
"""Registers sources for credentials and project for use by commands."""
self._credential_providers = self._credential_providers or [
store.GceCredentialProvider(),
]
for provider in self._credential_providers:
provider.Register()
# Register support for service account impersonation.
store.IMPERSONATION_TOKEN_PROVIDER = (
iamcred_util.ImpersonationAccessTokenProvider())
return self
def __exit__(self, exc_type, exc_value, exc_traceback):
"""Cleans up credential providers."""
del [exc_type, exc_value, exc_traceback]
for provider in self._credential_providers:
provider.UnRegister()
store.IMPERSONATION_TOKEN_PROVIDER = None