fernet.py 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  1. # This file is dual licensed under the terms of the Apache License, Version
  2. # 2.0, and the BSD License. See the LICENSE file in the root of this repository
  3. # for complete details.
  4. from __future__ import annotations
  5. import base64
  6. import binascii
  7. import os
  8. import time
  9. import typing
  10. from collections.abc import Iterable
  11. from cryptography import utils
  12. from cryptography.exceptions import InvalidSignature
  13. from cryptography.hazmat.primitives import hashes, padding
  14. from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
  15. from cryptography.hazmat.primitives.hmac import HMAC
  16. class InvalidToken(Exception):
  17. pass
  18. _MAX_CLOCK_SKEW = 60
  19. # Hoisted to module level so each operation doesn't reconstruct them.
  20. _PKCS7_128 = padding.PKCS7(128)
  21. _SHA256 = hashes.SHA256()
  22. class Fernet:
  23. def __init__(
  24. self,
  25. key: bytes | str,
  26. backend: typing.Any = None,
  27. ) -> None:
  28. try:
  29. key = base64.urlsafe_b64decode(key)
  30. except binascii.Error as exc:
  31. raise ValueError(
  32. "Fernet key must be 32 url-safe base64-encoded bytes."
  33. ) from exc
  34. if len(key) != 32:
  35. raise ValueError(
  36. "Fernet key must be 32 url-safe base64-encoded bytes."
  37. )
  38. self._signing_key = key[:16]
  39. self._encryption_key = key[16:]
  40. self._aes = algorithms.AES(self._encryption_key)
  41. @classmethod
  42. def generate_key(cls) -> bytes:
  43. return base64.urlsafe_b64encode(os.urandom(32))
  44. def encrypt(self, data: bytes) -> bytes:
  45. return self.encrypt_at_time(data, int(time.time()))
  46. def encrypt_at_time(self, data: bytes, current_time: int) -> bytes:
  47. iv = os.urandom(16)
  48. return self._encrypt_from_parts(data, current_time, iv)
  49. def _encrypt_from_parts(
  50. self, data: bytes, current_time: int, iv: bytes
  51. ) -> bytes:
  52. utils._check_bytes("data", data)
  53. padder = _PKCS7_128.padder()
  54. padded_data = padder.update(data) + padder.finalize()
  55. encryptor = Cipher(self._aes, modes.CBC(iv)).encryptor()
  56. ciphertext = encryptor.update(padded_data) + encryptor.finalize()
  57. basic_parts = (
  58. b"\x80"
  59. + current_time.to_bytes(length=8, byteorder="big")
  60. + iv
  61. + ciphertext
  62. )
  63. h = HMAC(self._signing_key, _SHA256)
  64. h.update(basic_parts)
  65. hmac = h.finalize()
  66. return base64.urlsafe_b64encode(basic_parts + hmac)
  67. def decrypt(self, token: bytes | str, ttl: int | None = None) -> bytes:
  68. timestamp, data = Fernet._get_unverified_token_data(token)
  69. if ttl is None:
  70. time_info = None
  71. else:
  72. time_info = (ttl, int(time.time()))
  73. return self._decrypt_data(data, timestamp, time_info)
  74. def decrypt_at_time(
  75. self, token: bytes | str, ttl: int, current_time: int
  76. ) -> bytes:
  77. if ttl is None:
  78. raise ValueError(
  79. "decrypt_at_time() can only be used with a non-None ttl"
  80. )
  81. timestamp, data = Fernet._get_unverified_token_data(token)
  82. return self._decrypt_data(data, timestamp, (ttl, current_time))
  83. def extract_timestamp(self, token: bytes | str) -> int:
  84. timestamp, data = Fernet._get_unverified_token_data(token)
  85. # Verify the token was not tampered with.
  86. self._verify_signature(data)
  87. return timestamp
  88. @staticmethod
  89. def _get_unverified_token_data(token: bytes | str) -> tuple[int, bytes]:
  90. if not isinstance(token, (str, bytes)):
  91. raise TypeError("token must be bytes or str")
  92. try:
  93. data = base64.urlsafe_b64decode(token)
  94. except (TypeError, binascii.Error):
  95. raise InvalidToken
  96. if not data or data[0] != 0x80:
  97. raise InvalidToken
  98. if len(data) < 9:
  99. raise InvalidToken
  100. timestamp = int.from_bytes(data[1:9], byteorder="big")
  101. return timestamp, data
  102. def _verify_signature(self, data: bytes) -> None:
  103. h = HMAC(self._signing_key, _SHA256)
  104. h.update(memoryview(data)[:-32])
  105. try:
  106. h.verify(data[-32:])
  107. except InvalidSignature:
  108. raise InvalidToken
  109. def _decrypt_data(
  110. self,
  111. data: bytes,
  112. timestamp: int,
  113. time_info: tuple[int, int] | None,
  114. ) -> bytes:
  115. if time_info is not None:
  116. ttl, current_time = time_info
  117. if timestamp + ttl < current_time:
  118. raise InvalidToken
  119. if current_time + _MAX_CLOCK_SKEW < timestamp:
  120. raise InvalidToken
  121. self._verify_signature(data)
  122. mv = memoryview(data)
  123. iv = data[9:25]
  124. ciphertext = mv[25:-32]
  125. decryptor = Cipher(self._aes, modes.CBC(iv)).decryptor()
  126. plaintext_padded = decryptor.update(ciphertext)
  127. try:
  128. plaintext_padded += decryptor.finalize()
  129. except ValueError:
  130. raise InvalidToken
  131. unpadder = _PKCS7_128.unpadder()
  132. unpadded = unpadder.update(plaintext_padded)
  133. try:
  134. unpadded += unpadder.finalize()
  135. except ValueError:
  136. raise InvalidToken
  137. return unpadded
  138. class MultiFernet:
  139. def __init__(self, fernets: Iterable[Fernet]):
  140. fernets = list(fernets)
  141. if not fernets:
  142. raise ValueError(
  143. "MultiFernet requires at least one Fernet instance"
  144. )
  145. self._fernets = fernets
  146. def encrypt(self, msg: bytes) -> bytes:
  147. return self.encrypt_at_time(msg, int(time.time()))
  148. def encrypt_at_time(self, msg: bytes, current_time: int) -> bytes:
  149. return self._fernets[0].encrypt_at_time(msg, current_time)
  150. def rotate(self, msg: bytes | str) -> bytes:
  151. timestamp, data = Fernet._get_unverified_token_data(msg)
  152. for f in self._fernets:
  153. try:
  154. p = f._decrypt_data(data, timestamp, None)
  155. break
  156. except InvalidToken:
  157. pass
  158. else:
  159. raise InvalidToken
  160. iv = os.urandom(16)
  161. return self._fernets[0]._encrypt_from_parts(p, timestamp, iv)
  162. def decrypt(self, msg: bytes | str, ttl: int | None = None) -> bytes:
  163. if ttl is None:
  164. time_info = None
  165. else:
  166. time_info = (ttl, int(time.time()))
  167. # Parse the token once rather than once per key.
  168. timestamp, data = Fernet._get_unverified_token_data(msg)
  169. for f in self._fernets:
  170. try:
  171. return f._decrypt_data(data, timestamp, time_info)
  172. except InvalidToken:
  173. pass
  174. raise InvalidToken
  175. def decrypt_at_time(
  176. self, msg: bytes | str, ttl: int, current_time: int
  177. ) -> bytes:
  178. if ttl is None:
  179. raise ValueError(
  180. "decrypt_at_time() can only be used with a non-None ttl"
  181. )
  182. # Parse the token once rather than once per key.
  183. timestamp, data = Fernet._get_unverified_token_data(msg)
  184. for f in self._fernets:
  185. try:
  186. return f._decrypt_data(data, timestamp, (ttl, current_time))
  187. except InvalidToken:
  188. pass
  189. raise InvalidToken
  190. def extract_timestamp(self, msg: bytes | str) -> int:
  191. # Parse the token once rather than once per key.
  192. timestamp, data = Fernet._get_unverified_token_data(msg)
  193. for f in self._fernets:
  194. try:
  195. f._verify_signature(data)
  196. return timestamp
  197. except InvalidToken:
  198. pass
  199. raise InvalidToken