jwks_client.py 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. import json
  2. import urllib.request
  3. from functools import lru_cache
  4. from ssl import SSLContext
  5. from typing import Any, Dict, List, Optional
  6. from urllib.error import URLError
  7. from .api_jwk import PyJWK, PyJWKSet
  8. from .api_jwt import decode_complete as decode_token
  9. from .exceptions import PyJWKClientConnectionError, PyJWKClientError
  10. from .jwk_set_cache import JWKSetCache
  11. class PyJWKClient:
  12. def __init__(
  13. self,
  14. uri: str,
  15. cache_keys: bool = False,
  16. max_cached_keys: int = 16,
  17. cache_jwk_set: bool = True,
  18. lifespan: int = 300,
  19. headers: Optional[Dict[str, Any]] = None,
  20. timeout: int = 30,
  21. ssl_context: Optional[SSLContext] = None,
  22. ):
  23. if headers is None:
  24. headers = {}
  25. self.uri = uri
  26. self.jwk_set_cache: Optional[JWKSetCache] = None
  27. self.headers = headers
  28. self.timeout = timeout
  29. self.ssl_context = ssl_context
  30. if cache_jwk_set:
  31. # Init jwt set cache with default or given lifespan.
  32. # Default lifespan is 300 seconds (5 minutes).
  33. if lifespan <= 0:
  34. raise PyJWKClientError(
  35. f'Lifespan must be greater than 0, the input is "{lifespan}"'
  36. )
  37. self.jwk_set_cache = JWKSetCache(lifespan)
  38. else:
  39. self.jwk_set_cache = None
  40. if cache_keys:
  41. # Cache signing keys
  42. # Ignore mypy (https://github.com/python/mypy/issues/2427)
  43. self.get_signing_key = lru_cache(maxsize=max_cached_keys)(
  44. self.get_signing_key
  45. ) # type: ignore
  46. def fetch_data(self) -> Any:
  47. jwk_set: Any = None
  48. try:
  49. r = urllib.request.Request(url=self.uri, headers=self.headers)
  50. with urllib.request.urlopen(
  51. r, timeout=self.timeout, context=self.ssl_context
  52. ) as response:
  53. jwk_set = json.load(response)
  54. except (URLError, TimeoutError) as e:
  55. raise PyJWKClientConnectionError(
  56. f'Fail to fetch data from the url, err: "{e}"'
  57. ) from e
  58. else:
  59. return jwk_set
  60. finally:
  61. if self.jwk_set_cache is not None:
  62. self.jwk_set_cache.put(jwk_set)
  63. def get_jwk_set(self, refresh: bool = False) -> PyJWKSet:
  64. data = None
  65. if self.jwk_set_cache is not None and not refresh:
  66. data = self.jwk_set_cache.get()
  67. if data is None:
  68. data = self.fetch_data()
  69. if not isinstance(data, dict):
  70. raise PyJWKClientError("The JWKS endpoint did not return a JSON object")
  71. return PyJWKSet.from_dict(data)
  72. def get_signing_keys(self, refresh: bool = False) -> List[PyJWK]:
  73. jwk_set = self.get_jwk_set(refresh)
  74. signing_keys = [
  75. jwk_set_key
  76. for jwk_set_key in jwk_set.keys
  77. if jwk_set_key.public_key_use in ["sig", None] and jwk_set_key.key_id
  78. ]
  79. if not signing_keys:
  80. raise PyJWKClientError("The JWKS endpoint did not contain any signing keys")
  81. return signing_keys
  82. def get_signing_key(self, kid: str) -> PyJWK:
  83. signing_keys = self.get_signing_keys()
  84. signing_key = self.match_kid(signing_keys, kid)
  85. if not signing_key:
  86. # If no matching signing key from the jwk set, refresh the jwk set and try again.
  87. signing_keys = self.get_signing_keys(refresh=True)
  88. signing_key = self.match_kid(signing_keys, kid)
  89. if not signing_key:
  90. raise PyJWKClientError(
  91. f'Unable to find a signing key that matches: "{kid}"'
  92. )
  93. return signing_key
  94. def get_signing_key_from_jwt(self, token: str) -> PyJWK:
  95. unverified = decode_token(token, options={"verify_signature": False})
  96. header = unverified["header"]
  97. return self.get_signing_key(header.get("kid"))
  98. @staticmethod
  99. def match_kid(signing_keys: List[PyJWK], kid: str) -> Optional[PyJWK]:
  100. signing_key = None
  101. for key in signing_keys:
  102. if key.key_id == kid:
  103. signing_key = key
  104. break
  105. return signing_key