providers.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691
  1. import calendar
  2. import configparser
  3. import json
  4. import os
  5. import time
  6. import requests
  7. from Tea.core import TeaCore
  8. from alibabacloud_credentials import credentials
  9. from alibabacloud_credentials.exceptions import CredentialException
  10. from alibabacloud_credentials.models import Config
  11. from alibabacloud_credentials.utils import auth_constant as ac
  12. from alibabacloud_credentials.utils import auth_util as au
  13. from alibabacloud_credentials.utils import parameter_helper as ph
  14. class AlibabaCloudCredentialsProvider:
  15. """BaseProvider class"""
  16. duration_seconds = 3600
  17. timeout = 3000
  18. def __init__(self, config=None):
  19. if isinstance(config, Config):
  20. self.type = config.type
  21. self.access_key_id = config.access_key_id
  22. self.access_key_secret = config.access_key_secret
  23. self.role_arn = config.role_arn
  24. self.role_session_name = config.role_session_name
  25. self.public_key_id = config.public_key_id
  26. self.role_name = config.role_name
  27. self.disable_imds_v1 = config.disable_imds_v1
  28. self.oidc_provider_arn = config.oidc_provider_arn
  29. self.oidc_token_file_path = config.oidc_token_file_path
  30. self.private_key_file = config.private_key_file
  31. self.bearer_token = config.bearer_token
  32. self.security_token = config.security_token
  33. self.host = config.host
  34. self.timeout = config.timeout or AlibabaCloudCredentialsProvider.timeout
  35. self.connect_timeout = config.connect_timeout or AlibabaCloudCredentialsProvider.timeout
  36. self.proxy = config.proxy
  37. self.sts_endpoint = config.sts_endpoint
  38. def _set_arg(self, key, value):
  39. if value is not None:
  40. setattr(self, key, value)
  41. val = getattr(self, key, None)
  42. if val is None:
  43. setattr(self, key, None)
  44. def _verify_empty_args(self, *args, config):
  45. if None in args and config is None:
  46. raise CredentialException(
  47. '"%s" needs to receive a "model.Config" object or other necessary args' % self.__class__
  48. )
  49. def get_credentials(self):
  50. raise NotImplementedError('get_credentials() must be overridden')
  51. class DefaultCredentialsProvider(AlibabaCloudCredentialsProvider):
  52. def __init__(self):
  53. super().__init__()
  54. self.user_configuration_providers = [
  55. EnvironmentVariableCredentialsProvider()
  56. ]
  57. if au.enable_oidc_credential:
  58. self.user_configuration_providers.append(OIDCRoleArnCredentialProvider(
  59. role_session_name=au.environment_role_session_name,
  60. role_arn=au.environment_role_arn,
  61. oidc_provider_arn=au.environment_oidc_provider_arn,
  62. oidc_token_file_path=au.environment_oidc_token_file
  63. ))
  64. self.user_configuration_providers.append(ProfileCredentialsProvider())
  65. role_name = au.environment_ECSMeta_data
  66. if role_name is not None:
  67. self.user_configuration_providers.append(EcsRamRoleCredentialProvider(role_name))
  68. self.user_configuration_providers.append(CredentialsUriProvider())
  69. def get_credentials(self):
  70. for provider in self.user_configuration_providers:
  71. credential = provider.get_credentials()
  72. if credential is not None:
  73. return credential
  74. raise CredentialException("not found credentials")
  75. def add_credentials_provider(self, p):
  76. self.user_configuration_providers.append(p)
  77. def remove_credentials_provider(self, p):
  78. self.user_configuration_providers.remove(p)
  79. def contains_credentials_provider(self, p):
  80. return self.user_configuration_providers.__contains__(p)
  81. def clear_credentials_provider(self):
  82. self.user_configuration_providers.clear()
  83. class EcsRamRoleCredentialProvider(AlibabaCloudCredentialsProvider):
  84. """EcsRamRoleCredentialProvider"""
  85. default_metadata_token_duration = 21600
  86. def __init__(self, role_name=None, config=None):
  87. self._verify_empty_args(role_name, config=config)
  88. super().__init__(config)
  89. self.__url_in_ecs_metadata = "/latest/meta-data/ram/security-credentials/"
  90. self.__url_in_ecs_metadata_token = "/latest/api/token"
  91. self.__ecs_metadata_fetch_error_msg = "Failed to get RAM session credentials from ECS metadata service."
  92. self.__ecs_metadata_token_fetch_error_msg = "Failed to get token from ECS Metadata Service."
  93. self.__metadata_service_host = "100.100.100.200"
  94. self._set_arg('role_name', role_name)
  95. self.disable_imds_v1 = au.environment_imds_v1_disabled and au.environment_imds_v1_disabled.lower() == 'true'
  96. if isinstance(config, Config):
  97. self.disable_imds_v1 = config.disable_imds_v1 is not None and config.disable_imds_v1 == True
  98. def _get_role_name(self, url=None):
  99. tea_request = ph.get_new_request()
  100. tea_request.headers['host'] = url if url else self.__metadata_service_host
  101. metadata_token = self._get_metadata_token(url)
  102. if metadata_token is not None:
  103. tea_request.headers['X-aliyun-ecs-metadata-token'] = metadata_token
  104. if not url:
  105. tea_request.pathname = self.__url_in_ecs_metadata
  106. response = TeaCore.do_action(tea_request)
  107. if response.status_code != 200:
  108. raise CredentialException(self.__ecs_metadata_fetch_error_msg + " HttpCode=" + str(response.status_code))
  109. self.role_name = response.body.decode('utf-8')
  110. async def _get_role_name_async(self, url=None):
  111. tea_request = ph.get_new_request()
  112. tea_request.headers['host'] = url if url else self.__metadata_service_host
  113. metadata_token = await self._get_metadata_token_async(url)
  114. if metadata_token is not None:
  115. tea_request.headers['X-aliyun-ecs-metadata-token'] = metadata_token
  116. if not url:
  117. tea_request.pathname = self.__url_in_ecs_metadata
  118. response = await TeaCore.async_do_action(tea_request)
  119. if response.status_code != 200:
  120. raise CredentialException(self.__ecs_metadata_fetch_error_msg + " HttpCode=" + str(response.status_code))
  121. self.role_name = response.body.decode('utf-8')
  122. def _get_metadata_token(self, url=None):
  123. tea_request = ph.get_new_request()
  124. tea_request.method = 'PUT'
  125. tea_request.headers['host'] = url if url else self.__metadata_service_host
  126. tea_request.headers['X-aliyun-ecs-metadata-token-ttl-seconds'] = str(self.default_metadata_token_duration)
  127. if not url:
  128. tea_request.pathname = self.__url_in_ecs_metadata_token
  129. try:
  130. response = TeaCore.do_action(tea_request)
  131. if response.status_code != 200:
  132. raise CredentialException(
  133. self.__ecs_metadata_token_fetch_error_msg + " HttpCode=" + str(response.status_code))
  134. return response.body.decode('utf-8')
  135. except Exception as e:
  136. if self.disable_imds_v1:
  137. raise e
  138. return None
  139. async def _get_metadata_token_async(self, url=None):
  140. tea_request = ph.get_new_request()
  141. tea_request.method = 'PUT'
  142. tea_request.headers['host'] = url if url else self.__metadata_service_host
  143. tea_request.headers['X-aliyun-ecs-metadata-token-ttl-seconds'] = str(self.default_metadata_token_duration)
  144. if not url:
  145. tea_request.pathname = self.__url_in_ecs_metadata_token
  146. try:
  147. response = await TeaCore.async_do_action(tea_request)
  148. if response.status_code != 200:
  149. raise CredentialException(
  150. self.__ecs_metadata_token_fetch_error_msg + " HttpCode=" + str(response.status_code))
  151. return response.body.decode('utf-8')
  152. except Exception as e:
  153. if self.disable_imds_v1:
  154. raise e
  155. return None
  156. def _create_credential(self, url=None):
  157. tea_request = ph.get_new_request()
  158. tea_request.headers['host'] = url if url else self.__metadata_service_host
  159. metadata_token = self._get_metadata_token(url)
  160. if metadata_token is not None:
  161. tea_request.headers['X-aliyun-ecs-metadata-token'] = metadata_token
  162. if not url:
  163. tea_request.pathname = self.__url_in_ecs_metadata + self.role_name
  164. # request
  165. response = TeaCore.do_action(tea_request)
  166. if response.status_code != 200:
  167. raise CredentialException(self.__ecs_metadata_fetch_error_msg + " HttpCode=" + str(response.status_code))
  168. dic = json.loads(response.body.decode('utf-8'))
  169. content_code = dic.get('Code')
  170. content_access_key_id = dic.get('AccessKeyId')
  171. content_access_key_secret = dic.get('AccessKeySecret')
  172. content_security_token = dic.get('SecurityToken')
  173. content_expiration = dic.get('Expiration')
  174. if content_code != "Success":
  175. raise CredentialException(self.__ecs_metadata_fetch_error_msg)
  176. # 先转换为时间数组
  177. time_array = time.strptime(content_expiration, "%Y-%m-%dT%H:%M:%SZ")
  178. # 转换为时间戳
  179. time_stamp = calendar.timegm(time_array)
  180. return credentials.EcsRamRoleCredential(content_access_key_id, content_access_key_secret,
  181. content_security_token, time_stamp, self)
  182. def get_credentials(self):
  183. if self.role_name == "":
  184. self._get_role_name()
  185. return self._create_credential()
  186. async def _create_credential_async(self, url=None):
  187. tea_request = ph.get_new_request()
  188. tea_request.headers['host'] = url if url else self.__metadata_service_host
  189. metadata_token = await self._get_metadata_token_async(url)
  190. if metadata_token is not None:
  191. tea_request.headers['X-aliyun-ecs-metadata-token'] = metadata_token
  192. if not url:
  193. tea_request.pathname = self.__url_in_ecs_metadata + self.role_name
  194. # request
  195. response = await TeaCore.async_do_action(tea_request)
  196. if response.status_code != 200:
  197. raise CredentialException(self.__ecs_metadata_fetch_error_msg + " HttpCode=" + str(response.status_code))
  198. dic = json.loads(response.body.decode('utf-8'))
  199. content_code = dic.get('Code')
  200. content_access_key_id = dic.get('AccessKeyId')
  201. content_access_key_secret = dic.get('AccessKeySecret')
  202. content_security_token = dic.get('SecurityToken')
  203. content_expiration = dic.get('Expiration')
  204. if content_code != "Success":
  205. raise CredentialException(self.__ecs_metadata_fetch_error_msg)
  206. # 先转换为时间数组
  207. time_array = time.strptime(content_expiration, "%Y-%m-%dT%H:%M:%SZ")
  208. # 转换为时间戳
  209. time_stamp = calendar.timegm(time_array)
  210. return credentials.EcsRamRoleCredential(content_access_key_id, content_access_key_secret,
  211. content_security_token, time_stamp, self)
  212. async def get_credentials_async(self):
  213. if self.role_name == "":
  214. await self._get_role_name_async()
  215. return await self._create_credential_async()
  216. class RamRoleArnCredentialProvider(AlibabaCloudCredentialsProvider):
  217. """RamRoleArnCredentialProvider"""
  218. def __init__(self, access_key_id=None, access_key_secret=None, role_session_name=None, role_arn=None,
  219. region_id=None,
  220. policy=None, config=None):
  221. self._verify_empty_args(access_key_id, access_key_secret, config=config)
  222. super().__init__(config)
  223. self._set_arg('role_arn', role_arn)
  224. self._set_arg('access_key_id', access_key_id)
  225. self._set_arg('access_key_secret', access_key_secret)
  226. self._set_arg('region_id', region_id)
  227. self._set_arg('role_session_name', role_session_name)
  228. self._set_arg('policy', policy)
  229. if region_id is None and au.environment_sts_region is not None:
  230. self._set_arg('region_id', au.environment_sts_region)
  231. if self.region_id is not None:
  232. self._set_arg('sts_endpoint', f'sts.{self.region_id}.aliyuncs.com')
  233. else:
  234. self._set_arg('sts_endpoint',
  235. 'sts.aliyuncs.com' if config is None or config.sts_endpoint is None else config.sts_endpoint)
  236. def get_credentials(self):
  237. return self._create_credentials()
  238. def _create_credentials(self):
  239. # 获取credential 先实现签名用工具类
  240. tea_request = ph.get_new_request()
  241. tea_request.query = {
  242. 'Action': 'AssumeRole',
  243. 'Format': 'JSON',
  244. 'Version': '2015-04-01',
  245. 'DurationSeconds': str(self.duration_seconds),
  246. 'RoleArn': self.role_arn,
  247. 'AccessKeyId': self.access_key_id,
  248. 'RoleSessionName': self.role_session_name,
  249. 'SignatureMethod': 'HMAC-SHA1',
  250. 'SignatureVersion': '1.0'
  251. }
  252. tea_request.query["Timestamp"] = ph.get_iso_8061_date()
  253. tea_request.query["SignatureNonce"] = ph.get_uuid()
  254. if self.policy is not None:
  255. tea_request.query["Policy"] = self.policy
  256. string_to_sign = ph.compose_string_to_sign("GET", tea_request.query)
  257. signature = ph.sign_string(string_to_sign, self.access_key_secret + "&")
  258. tea_request.query["Signature"] = signature
  259. tea_request.protocol = 'https'
  260. tea_request.headers['host'] = self.sts_endpoint
  261. # request
  262. response = TeaCore.do_action(tea_request)
  263. if response.status_code == 200:
  264. dic = json.loads(response.body.decode('utf-8'))
  265. if "Credentials" in dic:
  266. cre = dic.get("Credentials")
  267. # 先转换为时间数组
  268. time_array = time.strptime(cre.get("Expiration"), "%Y-%m-%dT%H:%M:%SZ")
  269. # 转换为时间戳
  270. expiration = calendar.timegm(time_array)
  271. return credentials.RamRoleArnCredential(cre.get("AccessKeyId"), cre.get("AccessKeySecret"),
  272. cre.get("SecurityToken"), expiration, self)
  273. raise CredentialException(response.body.decode('utf-8'))
  274. async def get_credentials_async(self):
  275. return await self._create_credentials_async()
  276. async def _create_credentials_async(self):
  277. # 获取credential 先实现签名用工具类
  278. tea_request = ph.get_new_request()
  279. tea_request.query = {
  280. 'Action': 'AssumeRole',
  281. 'Format': 'JSON',
  282. 'Version': '2015-04-01',
  283. 'DurationSeconds': str(self.duration_seconds),
  284. 'RoleArn': self.role_arn,
  285. 'AccessKeyId': self.access_key_id,
  286. 'RoleSessionName': self.role_session_name,
  287. 'SignatureMethod': 'HMAC-SHA1',
  288. 'SignatureVersion': '1.0'
  289. }
  290. tea_request.query["Timestamp"] = ph.get_iso_8061_date()
  291. tea_request.query["SignatureNonce"] = ph.get_uuid()
  292. if self.policy is not None:
  293. tea_request.query["Policy"] = self.policy
  294. string_to_sign = ph.compose_string_to_sign("GET", tea_request.query)
  295. signature = ph.sign_string(string_to_sign, self.access_key_secret + "&")
  296. tea_request.query["Signature"] = signature
  297. tea_request.protocol = 'https'
  298. tea_request.headers['host'] = self.sts_endpoint
  299. # request
  300. response = await TeaCore.async_do_action(tea_request)
  301. if response.status_code == 200:
  302. dic = json.loads(response.body.decode('utf-8'))
  303. if "Credentials" in dic:
  304. cre = dic.get("Credentials")
  305. # 先转换为时间数组
  306. time_array = time.strptime(cre.get("Expiration"), "%Y-%m-%dT%H:%M:%SZ")
  307. # 转换为时间戳
  308. expiration = calendar.timegm(time_array)
  309. return credentials.RamRoleArnCredential(cre.get("AccessKeyId"), cre.get("AccessKeySecret"),
  310. cre.get("SecurityToken"), expiration, self)
  311. raise CredentialException(response.body.decode('utf-8'))
  312. class OIDCRoleArnCredentialProvider(AlibabaCloudCredentialsProvider):
  313. """OIDCRoleArnCredentialProvider"""
  314. def __init__(self, role_session_name=None, role_arn=None,
  315. oidc_provider_arn=None,
  316. oidc_token_file_path=None,
  317. region_id=None,
  318. policy=None, config=None):
  319. self._verify_empty_args(role_arn, oidc_provider_arn, oidc_token_file_path, config=config)
  320. super().__init__(config)
  321. self._set_arg('role_arn', role_arn)
  322. self._set_arg('oidc_provider_arn', oidc_provider_arn)
  323. if oidc_token_file_path is not None:
  324. self._set_arg('oidc_token_file_path', oidc_token_file_path)
  325. elif config.oidc_token_file_path is not None:
  326. self._set_arg('oidc_token_file_path', oidc_token_file_path)
  327. elif au.environment_oidc_token_file is not None:
  328. self._set_arg('oidc_token_file_path', au.environment_oidc_token_file)
  329. else:
  330. raise CredentialException(
  331. 'The oidc_token_file_path does not exist and env ALIBABA_CLOUD_OIDC_TOKEN_FILE is none.')
  332. self._set_arg('region_id', region_id)
  333. self._set_arg('role_session_name', role_session_name)
  334. self._set_arg('policy', policy)
  335. if region_id is None and au.environment_sts_region is not None:
  336. self._set_arg('region_id', au.environment_sts_region)
  337. if self.region_id is not None:
  338. self._set_arg('sts_endpoint', f'sts.{self.region_id}.aliyuncs.com')
  339. else:
  340. self._set_arg('sts_endpoint',
  341. 'sts.aliyuncs.com' if config is None or config.sts_endpoint is None else config.sts_endpoint)
  342. def get_credentials(self):
  343. return self._create_credentials()
  344. def _create_credentials(self):
  345. # 获取credential 先实现签名用工具类
  346. oidc_token = au.get_private_key(self.oidc_token_file_path)
  347. tea_request = ph.get_new_request()
  348. tea_request.query = {
  349. 'Action': 'AssumeRoleWithOIDC',
  350. 'Format': 'JSON',
  351. 'Version': '2015-04-01',
  352. 'DurationSeconds': str(self.duration_seconds),
  353. 'RoleArn': self.role_arn,
  354. 'OIDCProviderArn': self.oidc_provider_arn,
  355. 'OIDCToken': oidc_token,
  356. 'RoleSessionName': self.role_session_name or 'defaultSessionName'
  357. }
  358. tea_request.query["Timestamp"] = ph.get_iso_8061_date()
  359. tea_request.query["SignatureNonce"] = ph.get_uuid()
  360. if self.policy is not None:
  361. tea_request.query["Policy"] = self.policy
  362. tea_request.protocol = 'https'
  363. tea_request.headers['host'] = self.sts_endpoint
  364. # request
  365. response = TeaCore.do_action(tea_request)
  366. if response.status_code == 200:
  367. dic = json.loads(response.body.decode('utf-8'))
  368. if "Credentials" in dic:
  369. cre = dic.get("Credentials")
  370. # 先转换为时间数组
  371. time_array = time.strptime(cre.get("Expiration"), "%Y-%m-%dT%H:%M:%SZ")
  372. # 转换为时间戳
  373. expiration = calendar.timegm(time_array)
  374. return credentials.OIDCRoleArnCredential(cre.get("AccessKeyId"), cre.get("AccessKeySecret"),
  375. cre.get("SecurityToken"), expiration, self)
  376. raise CredentialException(response.body.decode('utf-8'))
  377. async def get_credentials_async(self):
  378. return await self._create_credentials_async()
  379. async def _create_credentials_async(self):
  380. # 获取credential 先实现签名用工具类
  381. oidc_token = au.get_private_key(self.oidc_token_file_path)
  382. tea_request = ph.get_new_request()
  383. tea_request.query = {
  384. 'Action': 'AssumeRoleWithOIDC',
  385. 'Format': 'JSON',
  386. 'Version': '2015-04-01',
  387. 'DurationSeconds': str(self.duration_seconds),
  388. 'RoleArn': self.role_arn,
  389. 'OIDCProviderArn': self.oidc_provider_arn,
  390. 'OIDCToken': oidc_token,
  391. 'RoleSessionName': self.role_session_name or 'defaultSessionName'
  392. }
  393. tea_request.query["Timestamp"] = ph.get_iso_8061_date()
  394. tea_request.query["SignatureNonce"] = ph.get_uuid()
  395. if self.policy is not None:
  396. tea_request.query["Policy"] = self.policy
  397. tea_request.protocol = 'https'
  398. tea_request.headers['host'] = self.sts_endpoint
  399. # request
  400. response = await TeaCore.async_do_action(tea_request)
  401. if response.status_code == 200:
  402. dic = json.loads(response.body.decode('utf-8'))
  403. if "Credentials" in dic:
  404. cre = dic.get("Credentials")
  405. # 先转换为时间数组
  406. time_array = time.strptime(cre.get("Expiration"), "%Y-%m-%dT%H:%M:%SZ")
  407. # 转换为时间戳
  408. expiration = calendar.timegm(time_array)
  409. return credentials.OIDCRoleArnCredential(cre.get("AccessKeyId"), cre.get("AccessKeySecret"),
  410. cre.get("SecurityToken"), expiration, self)
  411. raise CredentialException(response.body.decode('utf-8'))
  412. class RsaKeyPairCredentialProvider(AlibabaCloudCredentialsProvider):
  413. def __init__(self, access_key_id=None, access_key_secret=None, region_id=None, config=None):
  414. self._verify_empty_args(access_key_id, access_key_secret, config=config)
  415. super().__init__(config)
  416. self._set_arg('access_key_id', access_key_id)
  417. self._set_arg('access_key_secret', access_key_secret)
  418. self._set_arg('region_id', region_id)
  419. async def get_credentials_async(self):
  420. return await self._create_credential_async()
  421. async def _create_credential_async(self, turl=None):
  422. tea_request = ph.get_new_request()
  423. tea_request.query = {
  424. 'Action': 'GenerateSessionAccessKey',
  425. 'Format': 'JSON',
  426. 'Version': '2015-04-01',
  427. 'DurationSeconds': str(self.duration_seconds),
  428. 'AccessKeyId': self.access_key_id,
  429. 'SignatureMethod': 'HMAC-SHA1',
  430. 'SignatureVersion': '1.0'
  431. }
  432. tea_request.query["Timestamp"] = ph.get_iso_8061_date()
  433. tea_request.query["SignatureNonce"] = ph.get_uuid()
  434. str_to_sign = ph.compose_string_to_sign('GET', tea_request.query)
  435. signature = ph.sign_string(str_to_sign, self.access_key_id + '&')
  436. tea_request.query['Signature'] = signature
  437. tea_request.protocol = 'https'
  438. tea_request.headers['host'] = turl if turl else 'sts.aliyuncs.com'
  439. # request
  440. response = await TeaCore.async_do_action(tea_request)
  441. if response.status_code == 200:
  442. dic = json.loads(response.body.decode('utf-8'))
  443. if "SessionAccessKey" in dic:
  444. cre = dic.get("SessionAccessKey")
  445. time_array = time.strptime(cre.get("Expiration"), "%Y-%m-%dT%H:%M:%SZ")
  446. expiration = calendar.timegm(time_array)
  447. return credentials.RsaKeyPairCredential(cre.get("SessionAccessKeyId"),
  448. cre.get("SessionAccessKeySecret"),
  449. expiration, self)
  450. raise CredentialException(response.body.decode('utf-8'))
  451. def get_credentials(self):
  452. return self._create_credential()
  453. def _create_credential(self, turl=None):
  454. tea_request = ph.get_new_request()
  455. tea_request.query = {
  456. 'Action': 'GenerateSessionAccessKey',
  457. 'Format': 'JSON',
  458. 'Version': '2015-04-01',
  459. 'DurationSeconds': str(self.duration_seconds),
  460. 'AccessKeyId': self.access_key_id,
  461. 'SignatureMethod': 'HMAC-SHA1',
  462. 'SignatureVersion': '1.0'
  463. }
  464. tea_request.query["Timestamp"] = ph.get_iso_8061_date()
  465. tea_request.query["SignatureNonce"] = ph.get_uuid()
  466. str_to_sign = ph.compose_string_to_sign('GET', tea_request.query)
  467. signature = ph.sign_string(str_to_sign, self.access_key_id + '&')
  468. tea_request.query['Signature'] = signature
  469. tea_request.protocol = 'https'
  470. tea_request.headers['host'] = turl if turl else 'sts.aliyuncs.com'
  471. # request
  472. response = TeaCore.do_action(tea_request)
  473. if response.status_code == 200:
  474. dic = json.loads(response.body.decode('utf-8'))
  475. if "SessionAccessKey" in dic:
  476. cre = dic.get("SessionAccessKey")
  477. time_array = time.strptime(cre.get("Expiration"), "%Y-%m-%dT%H:%M:%SZ")
  478. expiration = calendar.timegm(time_array)
  479. return credentials.RsaKeyPairCredential(cre.get("SessionAccessKeyId"),
  480. cre.get("SessionAccessKeySecret"),
  481. expiration, self)
  482. raise CredentialException(response.body.decode('utf-8'))
  483. class ProfileCredentialsProvider(AlibabaCloudCredentialsProvider):
  484. def __init__(self, path=None):
  485. super().__init__()
  486. self._set_arg('file_path', path)
  487. def parse_ini(self):
  488. file_path = self.file_path if self.file_path else au.environment_credentials_file
  489. if file_path is None:
  490. if not ac.HOME:
  491. return
  492. if os.path.exists(os.path.join(ac.HOME, "/.alibabacloud/credentials.ini")):
  493. # Support '/.alibabacloud/credentials.ini' is due to historical mistakes.
  494. # Please try to use '~/.alibabacloud/credentials.ini'.
  495. file_path = os.path.join(ac.HOME, "/.alibabacloud/credentials.ini")
  496. elif os.path.exists(os.path.join(ac.HOME, ".alibabacloud/credentials.ini")):
  497. file_path = os.path.join(ac.HOME, ".alibabacloud/credentials.ini")
  498. if file_path is None:
  499. return
  500. elif len(file_path) == 0:
  501. raise CredentialException("The specified credentials file is empty")
  502. # loads ini
  503. conf = configparser.ConfigParser()
  504. conf.read(file_path, encoding='utf-8')
  505. ini_map = dict(conf._sections)
  506. for k in dict(conf._sections):
  507. option = dict(ini_map[k])
  508. for key, value in dict(ini_map[k]).items():
  509. if '#' in value:
  510. option[key] = value.split('#')[0].strip()
  511. else:
  512. option[key] = value.strip()
  513. ini_map[k] = option
  514. client_config = ini_map.get(au.client_type)
  515. return client_config
  516. def get_credentials(self):
  517. client_config = self.parse_ini()
  518. if client_config is None:
  519. return
  520. return self._create_credential(client_config)
  521. def _create_credential(self, config):
  522. config_type = config.get(ac.INI_TYPE)
  523. if not config_type:
  524. raise CredentialException("The configured client type is empty")
  525. elif ac.INI_TYPE_ARN == config_type:
  526. return self._get_sts_assume_role_session_provider(config).get_credentials()
  527. elif ac.INI_TYPE_OIDC == config_type:
  528. return self._get_sts_oidc_role_session_provider(config).get_credentials()
  529. elif ac.INI_TYPE_KEY_PAIR == config_type:
  530. return self._get_sts_get_session_access_key_provider(config).get_credentials()
  531. elif ac.INI_TYPE_RAM == config_type:
  532. return self._get_instance_profile_provider(config).get_credentials()
  533. access_key_id = config.get(ac.INI_ACCESS_KEY_ID)
  534. access_key_secret = config.get(ac.INI_ACCESS_KEY_IDSECRET)
  535. if not access_key_id or not access_key_secret:
  536. return
  537. return credentials.AccessKeyCredential(access_key_id, access_key_secret)
  538. @staticmethod
  539. def _get_sts_assume_role_session_provider(config):
  540. access_key_id = config.get(ac.INI_ACCESS_KEY_ID)
  541. access_key_secret = config.get(ac.INI_ACCESS_KEY_IDSECRET)
  542. role_session_name = config.get(ac.INI_ROLE_SESSION_NAME)
  543. role_arn = config.get(ac.INI_ROLE_ARN)
  544. region_id = config.get(ac.DEFAULT_REGION)
  545. policy = config.get(ac.INI_POLICY)
  546. if not access_key_id or not access_key_secret:
  547. raise CredentialException("The configured access_key_id or access_key_secret is empty")
  548. if not role_session_name or not role_arn:
  549. raise CredentialException("The configured role_session_name or role_arn is empty")
  550. return RamRoleArnCredentialProvider(
  551. access_key_id, access_key_secret, role_session_name, role_arn, region_id, policy
  552. )
  553. @staticmethod
  554. def _get_sts_oidc_role_session_provider(config):
  555. role_session_name = config.get(ac.INI_ROLE_SESSION_NAME)
  556. role_arn = config.get(ac.INI_ROLE_ARN)
  557. oidc_provider_arn = config.get(ac.INI_OIDC_PROVIDER_ARN)
  558. oidc_token_file_path = config.get(ac.INI_OIDC_TOKEN_FILE_PATH)
  559. region_id = config.get(ac.DEFAULT_REGION)
  560. policy = config.get(ac.INI_POLICY)
  561. if not role_arn:
  562. raise CredentialException("The configured role_arn is empty")
  563. if not oidc_provider_arn:
  564. raise CredentialException("The configured oidc_provider_arn is empty")
  565. return OIDCRoleArnCredentialProvider(
  566. role_session_name, role_arn, oidc_provider_arn, oidc_token_file_path,
  567. region_id, policy
  568. )
  569. @staticmethod
  570. def _get_sts_get_session_access_key_provider(config):
  571. public_key_id = config.get(ac.INI_PUBLIC_KEY_ID)
  572. private_key_file = config.get(ac.INI_PRIVATE_KEY_FILE)
  573. if not private_key_file:
  574. raise CredentialException("The configured private_key_file is empty")
  575. private_key = au.get_private_key(private_key_file)
  576. if not public_key_id or not private_key:
  577. raise CredentialException("The configured public_key_id or private_key_file content is empty")
  578. return RsaKeyPairCredentialProvider(public_key_id, private_key)
  579. @staticmethod
  580. def _get_instance_profile_provider(config):
  581. role_name = config.get(ac.INI_ROLE_NAME)
  582. if not role_name:
  583. raise CredentialException("The configured role_name is empty")
  584. return EcsRamRoleCredentialProvider(role_name)
  585. class EnvironmentVariableCredentialsProvider(AlibabaCloudCredentialsProvider):
  586. def get_credentials(self):
  587. if 'default' != au.client_type:
  588. return
  589. access_key_id = au.environment_access_key_id
  590. access_key_secret = au.environment_access_key_secret
  591. security_token = au.environment_security_token
  592. if access_key_id is None or access_key_secret is None:
  593. return
  594. if len(access_key_id) == 0:
  595. raise CredentialException("Environment variable accessKeyId cannot be empty")
  596. if len(access_key_secret) == 0:
  597. raise CredentialException("Environment variable accessKeySecret cannot be empty")
  598. if security_token is not None and len(security_token) > 0:
  599. return credentials.StsCredential(access_key_id, access_key_secret, security_token)
  600. return credentials.AccessKeyCredential(access_key_id, access_key_secret)
  601. class CredentialsUriProvider(AlibabaCloudCredentialsProvider):
  602. def get_credentials(self):
  603. credentials_uri = os.environ.get('ALIBABA_CLOUD_CREDENTIALS_URI')
  604. if credentials_uri is None:
  605. return None
  606. return credentials.CredentialsURICredential(credentials_uri)