fernet.py 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  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. import base64
  5. import binascii
  6. import os
  7. import struct
  8. import time
  9. import typing
  10. from cryptography import utils
  11. from cryptography.exceptions import InvalidSignature
  12. from cryptography.hazmat.backends import _get_backend
  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. class Fernet(object):
  20. def __init__(self, key: bytes, backend=None):
  21. backend = _get_backend(backend)
  22. key = base64.urlsafe_b64decode(key)
  23. if len(key) != 32:
  24. raise ValueError(
  25. "Fernet key must be 32 url-safe base64-encoded bytes."
  26. )
  27. self._signing_key = key[:16]
  28. self._encryption_key = key[16:]
  29. self._backend = backend
  30. @classmethod
  31. def generate_key(cls) -> bytes:
  32. return base64.urlsafe_b64encode(os.urandom(32))
  33. def encrypt(self, data: bytes) -> bytes:
  34. return self.encrypt_at_time(data, int(time.time()))
  35. def encrypt_at_time(self, data: bytes, current_time: int) -> bytes:
  36. iv = os.urandom(16)
  37. return self._encrypt_from_parts(data, current_time, iv)
  38. def _encrypt_from_parts(
  39. self, data: bytes, current_time: int, iv: bytes
  40. ) -> bytes:
  41. utils._check_bytes("data", data)
  42. padder = padding.PKCS7(algorithms.AES.block_size).padder()
  43. padded_data = padder.update(data) + padder.finalize()
  44. encryptor = Cipher(
  45. algorithms.AES(self._encryption_key), modes.CBC(iv), self._backend
  46. ).encryptor()
  47. ciphertext = encryptor.update(padded_data) + encryptor.finalize()
  48. basic_parts = (
  49. b"\x80" + struct.pack(">Q", current_time) + iv + ciphertext
  50. )
  51. h = HMAC(self._signing_key, hashes.SHA256(), backend=self._backend)
  52. h.update(basic_parts)
  53. hmac = h.finalize()
  54. return base64.urlsafe_b64encode(basic_parts + hmac)
  55. def decrypt(self, token: bytes, ttl: typing.Optional[int] = None) -> bytes:
  56. timestamp, data = Fernet._get_unverified_token_data(token)
  57. if ttl is None:
  58. time_info = None
  59. else:
  60. time_info = (ttl, int(time.time()))
  61. return self._decrypt_data(data, timestamp, time_info)
  62. def decrypt_at_time(
  63. self, token: bytes, ttl: int, current_time: int
  64. ) -> bytes:
  65. if ttl is None:
  66. raise ValueError(
  67. "decrypt_at_time() can only be used with a non-None ttl"
  68. )
  69. timestamp, data = Fernet._get_unverified_token_data(token)
  70. return self._decrypt_data(data, timestamp, (ttl, current_time))
  71. def extract_timestamp(self, token: bytes) -> int:
  72. timestamp, data = Fernet._get_unverified_token_data(token)
  73. # Verify the token was not tampered with.
  74. self._verify_signature(data)
  75. return timestamp
  76. @staticmethod
  77. def _get_unverified_token_data(token: bytes) -> typing.Tuple[int, bytes]:
  78. utils._check_bytes("token", token)
  79. try:
  80. data = base64.urlsafe_b64decode(token)
  81. except (TypeError, binascii.Error):
  82. raise InvalidToken
  83. if not data or data[0] != 0x80:
  84. raise InvalidToken
  85. try:
  86. (timestamp,) = struct.unpack(">Q", data[1:9])
  87. except struct.error:
  88. raise InvalidToken
  89. return timestamp, data
  90. def _verify_signature(self, data: bytes) -> None:
  91. h = HMAC(self._signing_key, hashes.SHA256(), backend=self._backend)
  92. h.update(data[:-32])
  93. try:
  94. h.verify(data[-32:])
  95. except InvalidSignature:
  96. raise InvalidToken
  97. def _decrypt_data(
  98. self,
  99. data: bytes,
  100. timestamp: int,
  101. time_info: typing.Optional[typing.Tuple[int, int]],
  102. ) -> bytes:
  103. if time_info is not None:
  104. ttl, current_time = time_info
  105. if timestamp + ttl < current_time:
  106. raise InvalidToken
  107. if current_time + _MAX_CLOCK_SKEW < timestamp:
  108. raise InvalidToken
  109. self._verify_signature(data)
  110. iv = data[9:25]
  111. ciphertext = data[25:-32]
  112. decryptor = Cipher(
  113. algorithms.AES(self._encryption_key), modes.CBC(iv), self._backend
  114. ).decryptor()
  115. plaintext_padded = decryptor.update(ciphertext)
  116. try:
  117. plaintext_padded += decryptor.finalize()
  118. except ValueError:
  119. raise InvalidToken
  120. unpadder = padding.PKCS7(algorithms.AES.block_size).unpadder()
  121. unpadded = unpadder.update(plaintext_padded)
  122. try:
  123. unpadded += unpadder.finalize()
  124. except ValueError:
  125. raise InvalidToken
  126. return unpadded
  127. class MultiFernet(object):
  128. def __init__(self, fernets: typing.Iterable[Fernet]):
  129. fernets = list(fernets)
  130. if not fernets:
  131. raise ValueError(
  132. "MultiFernet requires at least one Fernet instance"
  133. )
  134. self._fernets = fernets
  135. def encrypt(self, msg: bytes) -> bytes:
  136. return self.encrypt_at_time(msg, int(time.time()))
  137. def encrypt_at_time(self, msg: bytes, current_time: int) -> bytes:
  138. return self._fernets[0].encrypt_at_time(msg, current_time)
  139. def rotate(self, msg: bytes) -> bytes:
  140. timestamp, data = Fernet._get_unverified_token_data(msg)
  141. for f in self._fernets:
  142. try:
  143. p = f._decrypt_data(data, timestamp, None)
  144. break
  145. except InvalidToken:
  146. pass
  147. else:
  148. raise InvalidToken
  149. iv = os.urandom(16)
  150. return self._fernets[0]._encrypt_from_parts(p, timestamp, iv)
  151. def decrypt(self, msg: bytes, ttl: typing.Optional[int] = None) -> bytes:
  152. for f in self._fernets:
  153. try:
  154. return f.decrypt(msg, ttl)
  155. except InvalidToken:
  156. pass
  157. raise InvalidToken
  158. def decrypt_at_time(
  159. self, msg: bytes, ttl: int, current_time: int
  160. ) -> bytes:
  161. for f in self._fernets:
  162. try:
  163. return f.decrypt_at_time(msg, ttl, current_time)
  164. except InvalidToken:
  165. pass
  166. raise InvalidToken