Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/jwt/jwks_client.py: 27%

1from __future__ import annotations 

2 

3import json 

4import urllib.request 

5from functools import lru_cache 

6from ssl import SSLContext 

7from typing import Any, Dict, List, Optional 

8from urllib.error import URLError 

9 

10from .api_jwk import PyJWK, PyJWKSet 

11from .api_jwt import decode_complete as decode_token 

12from .exceptions import PyJWKClientConnectionError, PyJWKClientError 

13from .jwk_set_cache import JWKSetCache 

14 

15 

16class PyJWKClient: 

17 def __init__( 

18 self, 

19 uri: str, 

20 cache_keys: bool = False, 

21 max_cached_keys: int = 16, 

22 cache_jwk_set: bool = True, 

23 lifespan: float = 300, 

24 headers: Optional[Dict[str, Any]] = None, 

25 timeout: float = 30, 

26 ssl_context: Optional[SSLContext] = None, 

27 ): 

28 if headers is None: 

29 headers = {} 

30 self.uri = uri 

31 self.jwk_set_cache: Optional[JWKSetCache] = None 

32 self.headers = headers 

33 self.timeout = timeout 

34 self.ssl_context = ssl_context 

35 

36 if cache_jwk_set: 

37 # Init jwt set cache with default or given lifespan. 

38 # Default lifespan is 300 seconds (5 minutes). 

39 if lifespan <= 0: 

40 raise PyJWKClientError( 

41 f'Lifespan must be greater than 0, the input is "{lifespan}"' 

42 ) 

43 self.jwk_set_cache = JWKSetCache(lifespan) 

44 else: 

45 self.jwk_set_cache = None 

46 

47 if cache_keys: 

48 # Cache signing keys 

49 # Ignore mypy (https://github.com/python/mypy/issues/2427) 

50 self.get_signing_key = lru_cache(maxsize=max_cached_keys)( 

51 self.get_signing_key 

52 ) # type: ignore 

53 

54 def fetch_data(self) -> Any: 

55 jwk_set: Any = None 

56 try: 

57 r = urllib.request.Request(url=self.uri, headers=self.headers) 

58 with urllib.request.urlopen( 

59 r, timeout=self.timeout, context=self.ssl_context 

60 ) as response: 

61 jwk_set = json.load(response) 

62 except (URLError, TimeoutError) as e: 

63 raise PyJWKClientConnectionError( 

64 f'Fail to fetch data from the url, err: "{e}"' 

65 ) from e 

66 else: 

67 return jwk_set 

68 finally: 

69 if self.jwk_set_cache is not None: 

70 self.jwk_set_cache.put(jwk_set) 

71 

72 def get_jwk_set(self, refresh: bool = False) -> PyJWKSet: 

73 data = None 

74 if self.jwk_set_cache is not None and not refresh: 

75 data = self.jwk_set_cache.get() 

76 

77 if data is None: 

78 data = self.fetch_data() 

79 

80 if not isinstance(data, dict): 

81 raise PyJWKClientError("The JWKS endpoint did not return a JSON object") 

82 

83 return PyJWKSet.from_dict(data) 

84 

85 def get_signing_keys(self, refresh: bool = False) -> List[PyJWK]: 

86 jwk_set = self.get_jwk_set(refresh) 

87 signing_keys = [ 

88 jwk_set_key 

89 for jwk_set_key in jwk_set.keys 

90 if jwk_set_key.public_key_use in ["sig", None] and jwk_set_key.key_id 

91 ] 

92 

93 if not signing_keys: 

94 raise PyJWKClientError("The JWKS endpoint did not contain any signing keys") 

95 

96 return signing_keys 

97 

98 def get_signing_key(self, kid: str) -> PyJWK: 

99 signing_keys = self.get_signing_keys() 

100 signing_key = self.match_kid(signing_keys, kid) 

101 

102 if not signing_key: 

103 # If no matching signing key from the jwk set, refresh the jwk set and try again. 

104 signing_keys = self.get_signing_keys(refresh=True) 

105 signing_key = self.match_kid(signing_keys, kid) 

106 

107 if not signing_key: 

108 raise PyJWKClientError( 

109 f'Unable to find a signing key that matches: "{kid}"' 

110 ) 

111 

112 return signing_key 

113 

114 def get_signing_key_from_jwt(self, token: str | bytes) -> PyJWK: 

115 unverified = decode_token(token, options={"verify_signature": False}) 

116 header = unverified["header"] 

117 return self.get_signing_key(header.get("kid")) 

118 

119 @staticmethod 

120 def match_kid(signing_keys: List[PyJWK], kid: str) -> Optional[PyJWK]: 

121 signing_key = None 

122 

123 for key in signing_keys: 

124 if key.key_id == kid: 

125 signing_key = key 

126 break 

127 

128 return signing_key