oidc.py 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  1. import calendar
  2. import json
  3. import time
  4. import aiofiles
  5. from alibabacloud_credentials.provider.refreshable import Credentials, RefreshResult, RefreshCachedSupplier
  6. from alibabacloud_credentials.http import HttpOptions
  7. from Tea.core import TeaCore
  8. from alibabacloud_credentials_api import ICredentialsProvider
  9. from alibabacloud_credentials.utils import auth_util as au
  10. from alibabacloud_credentials.utils import parameter_helper as ph
  11. from alibabacloud_credentials.exceptions import CredentialException
  12. async def _get_token_async(file_path: str) -> str:
  13. async with aiofiles.open(file_path, mode='r') as file:
  14. token = await file.read()
  15. return token
  16. def _get_token(file_path: str) -> str:
  17. with open(file_path, mode='r') as file:
  18. token = file.read()
  19. return token
  20. def _get_stale_time(expiration: int) -> int:
  21. if expiration < 0:
  22. return int(time.mktime(time.localtime())) + 60 * 60
  23. return expiration - 15 * 60
  24. class OIDCRoleArnCredentialsProvider(ICredentialsProvider):
  25. DEFAULT_DURATION_SECONDS = 3600
  26. DEFAULT_CONNECT_TIMEOUT = 5000
  27. DEFAULT_READ_TIMEOUT = 10000
  28. def __init__(self, *,
  29. role_arn: str = None,
  30. oidc_provider_arn: str = None,
  31. oidc_token_file_path: str = None,
  32. role_session_name: str = None,
  33. duration_seconds: int = DEFAULT_DURATION_SECONDS,
  34. policy: str = None,
  35. sts_region_id: str = None,
  36. sts_endpoint: str = None,
  37. enable_vpc: bool = None,
  38. http_options: HttpOptions = None):
  39. self._role_arn = role_arn or au.environment_role_arn
  40. self._oidc_provider_arn = oidc_provider_arn or au.environment_oidc_provider_arn
  41. self._oidc_token_file_path = oidc_token_file_path or au.environment_oidc_token_file
  42. self._role_session_name = role_session_name or au.environment_role_session_name
  43. self._duration_seconds = duration_seconds
  44. self._policy = policy
  45. if self._role_session_name is None or self._role_session_name == '':
  46. self._role_session_name = f'credentials-python-{str(int(time.mktime(time.localtime())))}'
  47. if self._duration_seconds is None:
  48. self._duration_seconds = self.DEFAULT_DURATION_SECONDS
  49. if self._duration_seconds < 900:
  50. raise ValueError('session duration should be in the range of 900s - max session duration')
  51. if self._role_arn is None or self._role_arn == '':
  52. raise ValueError('role_arn or environment variable ALIBABA_CLOUD_ROLE_ARN cannot be empty')
  53. if self._oidc_provider_arn is None or self._oidc_provider_arn == '':
  54. raise ValueError(
  55. 'oidc_provider_arn or environment variable ALIBABA_CLOUD_OIDC_PROVIDER_ARN cannot be empty')
  56. if self._oidc_token_file_path is None or self._oidc_token_file_path == '':
  57. raise ValueError(
  58. 'oidc_token_file_path or environment variable ALIBABA_CLOUD_OIDC_TOKEN_FILE cannot be empty')
  59. if sts_endpoint is not None and sts_endpoint != '':
  60. self._sts_endpoint = sts_endpoint
  61. else:
  62. if enable_vpc is not None:
  63. prefix = 'sts-vpc' if enable_vpc else 'sts'
  64. else:
  65. prefix = 'sts-vpc' if au.environment_enable_vpc.lower() == 'true' else 'sts'
  66. if sts_region_id is not None and sts_region_id != '':
  67. self._sts_endpoint = f'{prefix}.{sts_region_id}.aliyuncs.com'
  68. elif au.environment_sts_region is not None and au.environment_sts_region != '':
  69. self._sts_endpoint = f'{prefix}.{au.environment_sts_region}.aliyuncs.com'
  70. else:
  71. self._sts_endpoint = 'sts.aliyuncs.com'
  72. self._http_options = http_options if http_options is not None else HttpOptions()
  73. self._runtime_options = {
  74. 'connectTimeout': self._http_options.connect_timeout if self._http_options.connect_timeout is not None else OIDCRoleArnCredentialsProvider.DEFAULT_CONNECT_TIMEOUT,
  75. 'readTimeout': self._http_options.read_timeout if self._http_options.read_timeout is not None else OIDCRoleArnCredentialsProvider.DEFAULT_READ_TIMEOUT,
  76. 'httpsProxy': self._http_options.proxy
  77. }
  78. self._credentials_cache = RefreshCachedSupplier(
  79. refresh_callable=self._refresh_credentials,
  80. refresh_callable_async=self._refresh_credentials_async,
  81. )
  82. def get_credentials(self) -> Credentials:
  83. return self._credentials_cache._sync_call()
  84. async def get_credentials_async(self) -> Credentials:
  85. return await self._credentials_cache._async_call()
  86. def _refresh_credentials(self) -> RefreshResult[Credentials]:
  87. token = _get_token(self._oidc_token_file_path)
  88. tea_request = ph.get_new_request()
  89. tea_request.query = {
  90. 'Action': 'AssumeRoleWithOIDC',
  91. 'Format': 'JSON',
  92. 'Version': '2015-04-01',
  93. 'DurationSeconds': str(self._duration_seconds),
  94. 'RoleArn': self._role_arn,
  95. 'OIDCProviderArn': self._oidc_provider_arn,
  96. 'OIDCToken': token,
  97. 'RoleSessionName': self._role_session_name,
  98. 'Timestamp': ph.get_iso_8061_date()
  99. }
  100. if self._policy is not None and self._policy != '':
  101. tea_request.query['Policy'] = self._policy
  102. tea_request.protocol = 'https'
  103. tea_request.headers['host'] = self._sts_endpoint
  104. response = TeaCore.do_action(tea_request, self._runtime_options)
  105. if response.status_code != 200:
  106. raise CredentialException(
  107. f'error refreshing credentials from oidc_role_arn, http_code: {response.status_code}, result: {response.body.decode("utf-8")}')
  108. dic = json.loads(response.body.decode('utf-8'))
  109. if 'Credentials' not in dic:
  110. raise CredentialException(
  111. f'error retrieving credentials from oidc_role_arn result: {response.body.decode("utf-8")}')
  112. cre = dic.get('Credentials')
  113. if 'AccessKeyId' not in cre or 'AccessKeySecret' not in cre or 'SecurityToken' not in cre:
  114. raise CredentialException(
  115. f'error retrieving credentials from oidc_role_arn result: {response.body.decode("utf-8")}')
  116. # 先转换为时间数组
  117. time_array = time.strptime(cre.get('Expiration'), '%Y-%m-%dT%H:%M:%SZ')
  118. # 转换为时间戳
  119. expiration = calendar.timegm(time_array)
  120. credentials = Credentials(
  121. access_key_id=cre.get('AccessKeyId'),
  122. access_key_secret=cre.get('AccessKeySecret'),
  123. security_token=cre.get('SecurityToken'),
  124. expiration=expiration,
  125. provider_name=self.get_provider_name()
  126. )
  127. return RefreshResult(value=credentials,
  128. stale_time=_get_stale_time(expiration))
  129. async def _refresh_credentials_async(self) -> RefreshResult[Credentials]:
  130. token = await _get_token_async(self._oidc_token_file_path)
  131. tea_request = ph.get_new_request()
  132. tea_request.query = {
  133. 'Action': 'AssumeRoleWithOIDC',
  134. 'Format': 'JSON',
  135. 'Version': '2015-04-01',
  136. 'DurationSeconds': str(self._duration_seconds),
  137. 'RoleArn': self._role_arn,
  138. 'OIDCProviderArn': self._oidc_provider_arn,
  139. 'OIDCToken': token,
  140. 'RoleSessionName': self._role_session_name,
  141. 'Timestamp': ph.get_iso_8061_date()
  142. }
  143. if self._policy is not None and self._policy != '':
  144. tea_request.query['Policy'] = self._policy
  145. tea_request.protocol = 'https'
  146. tea_request.headers['host'] = self._sts_endpoint
  147. response = await TeaCore.async_do_action(tea_request, self._runtime_options)
  148. if response.status_code != 200:
  149. raise CredentialException(
  150. f'error refreshing credentials from oidc_role_arn, http_code: {response.status_code}, result: {response.body.decode("utf-8")}')
  151. dic = json.loads(response.body.decode('utf-8'))
  152. if 'Credentials' not in dic:
  153. raise CredentialException(
  154. f'error retrieving credentials from oidc_role_arn result: {response.body.decode("utf-8")}')
  155. cre = dic.get('Credentials')
  156. if 'AccessKeyId' not in cre or 'AccessKeySecret' not in cre or 'SecurityToken' not in cre:
  157. raise CredentialException(
  158. f'error retrieving credentials from oidc_role_arn result: {response.body.decode("utf-8")}')
  159. # 先转换为时间数组
  160. time_array = time.strptime(cre.get('Expiration'), '%Y-%m-%dT%H:%M:%SZ')
  161. # 转换为时间戳
  162. expiration = calendar.timegm(time_array)
  163. credentials = Credentials(
  164. access_key_id=cre.get('AccessKeyId'),
  165. access_key_secret=cre.get('AccessKeySecret'),
  166. security_token=cre.get('SecurityToken'),
  167. expiration=expiration,
  168. provider_name=self.get_provider_name()
  169. )
  170. return RefreshResult(value=credentials,
  171. stale_time=_get_stale_time(expiration))
  172. def get_provider_name(self) -> str:
  173. return 'oidc_role_arn'