key.py 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776
  1. from binascii import hexlify, a2b_base64, b2a_base64
  2. from getpass import getpass
  3. import os
  4. import msgpack
  5. import textwrap
  6. from collections import namedtuple
  7. import hmac
  8. from hashlib import sha256, sha512
  9. import zlib
  10. try:
  11. import lzma # python >= 3.3
  12. except ImportError:
  13. try:
  14. from backports import lzma # backports.lzma from pypi
  15. except ImportError:
  16. lzma = None
  17. from attic.crypto import pbkdf2_sha256, get_random_bytes, AES, AES_CTR_MODE, AES_GCM_MODE, \
  18. bytes_to_long, long_to_bytes, bytes_to_int, num_aes_blocks
  19. from attic.helpers import IntegrityError, get_keys_dir, Error
  20. # we do not store the full IV on disk, as the upper 8 bytes are expected to be
  21. # zero anyway as the full IV is a 128bit counter. PREFIX are the upper 8 bytes,
  22. # stored_iv are the lower 8 Bytes.
  23. PREFIX = b'\0' * 8
  24. Meta = namedtuple('Meta', 'compr_type, key_type, mac_type, cipher_type, iv, legacy')
  25. class UnsupportedPayloadError(Error):
  26. """Unsupported payload type {}. A newer version is required to access this repository.
  27. """
  28. class sha512_256(object): # note: can't subclass sha512
  29. """sha512, but digest truncated to 256bit - faster than sha256 on 64bit platforms"""
  30. digestsize = digest_size = 32
  31. block_size = 64
  32. def __init__(self, data=None):
  33. self.name = 'sha512-256'
  34. self._h = sha512()
  35. if data:
  36. self.update(data)
  37. def update(self, data):
  38. self._h.update(data)
  39. def digest(self):
  40. return self._h.digest()[:self.digest_size]
  41. def hexdigest(self):
  42. return self._h.hexdigest()[:self.digest_size * 2]
  43. def copy(self):
  44. new = sha512_256.__new__(sha512_256)
  45. new._h = self._h.copy()
  46. return new
  47. class HMAC(hmac.HMAC):
  48. """Workaround a bug in Python < 3.4 Where HMAC does not accept memoryviews
  49. """
  50. def update(self, msg):
  51. self.inner.update(msg)
  52. # HASH / MAC stuff below all has a mac-like interface, so it can be used in the same way.
  53. # special case: hashes do not use keys (and thus, do not sign/authenticate)
  54. class SHA256(object): # note: can't subclass sha256
  55. TYPE = 0
  56. def __init__(self, key, data=b''):
  57. # signature is like for a MAC, we ignore the key as this is a simple hash
  58. if key is not None:
  59. raise Exception("use a HMAC if you have a key")
  60. self.h = sha256(data)
  61. def update(self, data):
  62. self.h.update(data)
  63. def digest(self):
  64. return self.h.digest()
  65. def hexdigest(self):
  66. return self.h.hexdigest()
  67. class SHA512_256(sha512_256):
  68. """sha512, but digest truncated to 256bit - faster than sha256 on 64bit platforms"""
  69. TYPE = 1
  70. def __init__(self, key, data):
  71. # signature is like for a MAC, we ignore the key as this is a simple hash
  72. if key is not None:
  73. raise Exception("use a HMAC if you have a key")
  74. super().__init__(data)
  75. class GHASH:
  76. TYPE = 2
  77. def __init__(self, key, data):
  78. # signature is like for a MAC, we ignore the key as this is a simple hash
  79. if key is not None:
  80. raise Exception("use a MAC if you have a key")
  81. self.key = b'\0' * 32
  82. self.data = data
  83. def digest(self):
  84. mac_cipher = AES(mode=AES_GCM_MODE, is_encrypt=True, key=self.key, iv=b'\0' * 16)
  85. # GMAC = aes-gcm with all data as AAD, no data as to-be-encrypted data
  86. mac_cipher.add(bytes(self.data))
  87. hash, _ = mac_cipher.compute_mac_and_encrypt(b'')
  88. return hash + b'\0'*16 # XXX hashindex code wants 32 bytes (256 bit)
  89. class HMAC_SHA256(HMAC):
  90. TYPE = 10
  91. def __init__(self, key, data):
  92. if key is None:
  93. raise Exception("do not use HMAC if you don't have a key")
  94. super().__init__(key, data, sha256)
  95. class HMAC_SHA512_256(HMAC):
  96. TYPE = 11
  97. def __init__(self, key, data):
  98. if key is None:
  99. raise Exception("do not use HMAC if you don't have a key")
  100. super().__init__(key, data, sha512_256)
  101. class GMAC(GHASH):
  102. TYPE = 20
  103. def __init__(self, key, data):
  104. super().__init__(None, data)
  105. if key is None:
  106. raise Exception("do not use GMAC if you don't have a key")
  107. self.key = key
  108. # defaults are optimized for speed on modern CPUs with AES hw support
  109. HASH_DEFAULT = GHASH.TYPE
  110. MAC_DEFAULT = GMAC.TYPE
  111. # compressor classes, all same interface
  112. # special case: zlib level 0 is "no compression"
  113. class NullCompressor(object): # uses 0 in the mapping
  114. TYPE = 0
  115. def compress(self, data):
  116. return bytes(data)
  117. def decompress(self, data):
  118. return bytes(data)
  119. class ZlibCompressor(object): # uses 1..9 in the mapping
  120. TYPE = 0
  121. LEVELS = range(10)
  122. def compress(self, data):
  123. level = self.TYPE - ZlibCompressor.TYPE
  124. return zlib.compress(data, level)
  125. def decompress(self, data):
  126. return zlib.decompress(data)
  127. class LzmaCompressor(object): # uses 10..19 in the mapping
  128. TYPE = 10
  129. PRESETS = range(10)
  130. def __init__(self):
  131. if lzma is None:
  132. raise NotImplemented("lzma compression needs Python >= 3.3 or backports.lzma from PyPi")
  133. def compress(self, data):
  134. preset = self.TYPE - LzmaCompressor.TYPE
  135. return lzma.compress(data, preset=preset)
  136. def decompress(self, data):
  137. return lzma.decompress(data)
  138. # default is optimized for speed
  139. COMPR_DEFAULT = NullCompressor.TYPE # no compression
  140. # ciphers - AEAD (authenticated encryption with assoc. data) style interface
  141. # special case: PLAIN dummy does not encrypt / authenticate
  142. class PLAIN:
  143. TYPE = 0
  144. enc_iv = None # dummy
  145. def __init__(self, **kw):
  146. pass
  147. def compute_mac_and_encrypt(self, meta, data):
  148. return None, data
  149. def check_mac_and_decrypt(self, mac, meta, data):
  150. return data
  151. def increment_iv(iv, amount):
  152. """
  153. increment the given IV considering that <amount> bytes of data was
  154. encrypted based on it. In CTR / GCM mode, the IV is just a counter and
  155. must never repeat.
  156. :param iv: current IV, 16 bytes (128 bit)
  157. :param amount: amount of data (in bytes) that was encrypted
  158. :return: new IV, 16 bytes (128 bit)
  159. """
  160. # TODO: code assumes that the last 8 bytes are enough, the upper 8 always zero
  161. iv_last8 = iv[8:]
  162. current_iv = bytes_to_long(iv_last8)
  163. new_iv = current_iv + num_aes_blocks(amount)
  164. iv_last8 = long_to_bytes(new_iv)
  165. iv = PREFIX + iv_last8
  166. return iv
  167. def get_aad(meta):
  168. """get additional authenticated data for AEAD ciphers"""
  169. if meta.legacy:
  170. # legacy format computed the mac over (iv_last8 + data)
  171. return meta.iv[8:]
  172. else:
  173. return msgpack.packb(meta)
  174. class AES_CTR_HMAC:
  175. TYPE = 1
  176. def __init__(self, enc_key=b'\0' * 32, enc_iv=b'\0' * 16, enc_hmac_key=b'\0' * 32, **kw):
  177. self.hmac_key = enc_hmac_key
  178. self.enc_iv = enc_iv
  179. self.enc_cipher = AES(mode=AES_CTR_MODE, is_encrypt=True, key=enc_key, iv=enc_iv)
  180. self.dec_cipher = AES(mode=AES_CTR_MODE, is_encrypt=False, key=enc_key)
  181. def compute_mac_and_encrypt(self, meta, data):
  182. self.enc_cipher.reset(iv=meta.iv)
  183. _, data = self.enc_cipher.compute_mac_and_encrypt(data)
  184. self.enc_iv = increment_iv(meta.iv, len(data))
  185. aad = get_aad(meta)
  186. mac = HMAC(self.hmac_key, aad + data, sha256).digest() # XXX mac / hash flexibility
  187. return mac, data
  188. def check_mac_and_decrypt(self, mac, meta, data):
  189. aad = get_aad(meta)
  190. if HMAC(self.hmac_key, aad + data, sha256).digest() != mac:
  191. raise IntegrityError('Encryption envelope checksum mismatch')
  192. self.dec_cipher.reset(iv=meta.iv)
  193. data = self.dec_cipher.check_mac_and_decrypt(None, data)
  194. return data
  195. class AES_GCM:
  196. TYPE = 2
  197. def __init__(self, enc_key=b'\0' * 32, enc_iv=b'\0' * 16, **kw):
  198. # note: hmac_key is not used for aes-gcm, it does aes+gmac in 1 pass
  199. self.enc_iv = enc_iv
  200. self.enc_cipher = AES(mode=AES_GCM_MODE, is_encrypt=True, key=enc_key, iv=enc_iv)
  201. self.dec_cipher = AES(mode=AES_GCM_MODE, is_encrypt=False, key=enc_key)
  202. def compute_mac_and_encrypt(self, meta, data):
  203. self.enc_cipher.reset(iv=meta.iv)
  204. aad = get_aad(meta)
  205. self.enc_cipher.add(aad)
  206. mac, data = self.enc_cipher.compute_mac_and_encrypt(data)
  207. self.enc_iv = increment_iv(meta.iv, len(data))
  208. return mac, data
  209. def check_mac_and_decrypt(self, mac, meta, data):
  210. self.dec_cipher.reset(iv=meta.iv)
  211. aad = get_aad(meta)
  212. self.dec_cipher.add(aad)
  213. try:
  214. data = self.dec_cipher.check_mac_and_decrypt(mac, data)
  215. except Exception:
  216. raise IntegrityError('Encryption envelope checksum mismatch')
  217. return data
  218. # cipher default is optimized for speed on modern CPUs with AES hw support
  219. PLAIN_DEFAULT = PLAIN.TYPE
  220. CIPHER_DEFAULT = AES_GCM.TYPE
  221. # misc. types of keys
  222. # special case: no keys (thus: no encryption, no signing/authentication)
  223. class KeyBase(object):
  224. TYPE = 0x00 # override in derived classes
  225. def __init__(self, compressor_cls, maccer_cls, cipher_cls):
  226. self.compressor = compressor_cls()
  227. self.maccer_cls = maccer_cls # hasher/maccer used by id_hash
  228. self.cipher_cls = cipher_cls # plaintext dummy or AEAD cipher
  229. self.cipher = cipher_cls()
  230. self.id_key = None
  231. def id_hash(self, data):
  232. """Return a HASH (no id_key) or a MAC (using the "id_key" key)
  233. XXX do we need a cryptographic hash function here or is a keyed hash
  234. function like GMAC / GHASH good enough? See NIST SP 800-38D.
  235. IMPORTANT: in 1 repo, there should be only 1 kind of id_hash, otherwise
  236. data hashed/maced with one id_hash might result in same ID as already
  237. exists in the repo for other data created with another id_hash method.
  238. somehow unlikely considering 128 or 256bits, but still.
  239. """
  240. return self.maccer_cls(self.id_key, data).digest()
  241. def encrypt(self, data):
  242. data = self.compressor.compress(data)
  243. meta = Meta(compr_type=self.compressor.TYPE, key_type=self.TYPE,
  244. mac_type=self.maccer_cls.TYPE, cipher_type=self.cipher.TYPE,
  245. iv=self.cipher.enc_iv, legacy=False)
  246. mac, data = self.cipher.compute_mac_and_encrypt(meta, data)
  247. return generate(mac, meta, data)
  248. def decrypt(self, id, data):
  249. mac, meta, data = parser(data)
  250. compressor, keyer, maccer, cipher = get_implementations(meta)
  251. assert isinstance(self, keyer)
  252. assert self.maccer_cls is maccer
  253. assert self.cipher_cls is cipher
  254. data = self.cipher.check_mac_and_decrypt(mac, meta, data)
  255. data = self.compressor.decompress(data)
  256. if id and self.id_hash(data) != id:
  257. raise IntegrityError('Chunk id verification failed')
  258. return data
  259. class PlaintextKey(KeyBase):
  260. TYPE = 0x02
  261. chunk_seed = 0
  262. @classmethod
  263. def create(cls, repository, args):
  264. print('Encryption NOT enabled.\nUse the "--encryption=passphrase|keyfile" to enable encryption.')
  265. compressor = compressor_creator(args)
  266. maccer = maccer_creator(args, cls)
  267. cipher = cipher_creator(args, cls)
  268. return cls(compressor, maccer, cipher)
  269. @classmethod
  270. def detect(cls, repository, manifest_data):
  271. mac, meta, data = parser(manifest_data)
  272. compressor, keyer, maccer, cipher = get_implementations(meta)
  273. return cls(compressor, maccer, cipher)
  274. class AESKeyBase(KeyBase):
  275. """Common base class shared by KeyfileKey and PassphraseKey
  276. Chunks are encrypted using 256bit AES in CTR or GCM mode.
  277. Chunks are authenticated by a GCM GMAC or a HMAC.
  278. Payload layout: TYPE(1) + MAC(32) + NONCE(8) + CIPHERTEXT
  279. To reduce payload size only 8 bytes of the 16 bytes nonce is saved
  280. in the payload, the first 8 bytes are always zeros. This does not
  281. affect security but limits the maximum repository capacity to
  282. only 295 exabytes!
  283. """
  284. def extract_iv(self, payload):
  285. _, meta, _ = parser(payload)
  286. return meta.iv
  287. def init_from_random_data(self, data):
  288. self.enc_key = data[0:32]
  289. self.enc_hmac_key = data[32:64]
  290. self.id_key = data[64:96]
  291. self.chunk_seed = bytes_to_int(data[96:100])
  292. # Convert to signed int32
  293. if self.chunk_seed & 0x80000000:
  294. self.chunk_seed = self.chunk_seed - 0xffffffff - 1
  295. def init_ciphers(self, enc_iv=b'\0' * 16):
  296. self.cipher = self.cipher_cls(enc_key=self.enc_key, enc_iv=enc_iv,
  297. enc_hmac_key=self.enc_hmac_key)
  298. @property
  299. def enc_iv(self):
  300. return self.cipher.enc_iv
  301. class PassphraseKey(AESKeyBase):
  302. TYPE = 0x01
  303. iterations = 100000
  304. @classmethod
  305. def create(cls, repository, args):
  306. compressor = compressor_creator(args)
  307. maccer = maccer_creator(args, cls)
  308. cipher = cipher_creator(args, cls)
  309. key = cls(compressor, maccer, cipher)
  310. passphrase = os.environ.get('ATTIC_PASSPHRASE')
  311. if passphrase is not None:
  312. passphrase2 = passphrase
  313. else:
  314. passphrase, passphrase2 = 1, 2
  315. while passphrase != passphrase2:
  316. passphrase = getpass('Enter passphrase: ')
  317. if not passphrase:
  318. print('Passphrase must not be blank')
  319. continue
  320. passphrase2 = getpass('Enter same passphrase again: ')
  321. if passphrase != passphrase2:
  322. print('Passphrases do not match')
  323. key.init(repository, passphrase)
  324. if passphrase:
  325. print('Remember your passphrase. Your data will be inaccessible without it.')
  326. return key
  327. @classmethod
  328. def detect(cls, repository, manifest_data):
  329. prompt = 'Enter passphrase for %s: ' % repository._location.orig
  330. mac, meta, data = parser(manifest_data)
  331. compressor, keyer, maccer, cipher = get_implementations(meta)
  332. key = cls(compressor, maccer, cipher)
  333. passphrase = os.environ.get('ATTIC_PASSPHRASE')
  334. if passphrase is None:
  335. passphrase = getpass(prompt)
  336. while True:
  337. key.init(repository, passphrase)
  338. try:
  339. key.decrypt(None, manifest_data)
  340. key.init_ciphers(increment_iv(key.extract_iv(manifest_data), len(data)))
  341. return key
  342. except IntegrityError:
  343. passphrase = getpass(prompt)
  344. def change_passphrase(self):
  345. class ImmutablePassphraseError(Error):
  346. """The passphrase for this encryption key type can't be changed."""
  347. raise ImmutablePassphraseError
  348. def init(self, repository, passphrase):
  349. self.init_from_random_data(pbkdf2_sha256(passphrase.encode('utf-8'), repository.id, self.iterations, 100))
  350. self.init_ciphers()
  351. class KeyfileKey(AESKeyBase):
  352. FILE_ID = 'ATTIC KEY'
  353. TYPE = 0x00
  354. @classmethod
  355. def detect(cls, repository, manifest_data):
  356. mac, meta, data = parser(manifest_data)
  357. compressor, keyer, maccer, cipher = get_implementations(meta)
  358. key = cls(compressor, maccer, cipher)
  359. path = cls.find_key_file(repository)
  360. prompt = 'Enter passphrase for key file %s: ' % path
  361. passphrase = os.environ.get('ATTIC_PASSPHRASE', '')
  362. while not key.load(path, passphrase):
  363. passphrase = getpass(prompt)
  364. key.init_ciphers(increment_iv(key.extract_iv(manifest_data), len(data)))
  365. return key
  366. @classmethod
  367. def find_key_file(cls, repository):
  368. id = hexlify(repository.id).decode('ascii')
  369. keys_dir = get_keys_dir()
  370. for name in os.listdir(keys_dir):
  371. filename = os.path.join(keys_dir, name)
  372. with open(filename, 'r') as fd:
  373. line = fd.readline().strip()
  374. if line and line.startswith(cls.FILE_ID) and line[10:] == id:
  375. return filename
  376. raise Exception('Key file for repository with ID %s not found' % id)
  377. def load(self, filename, passphrase):
  378. with open(filename, 'r') as fd:
  379. cdata = a2b_base64(''.join(fd.readlines()[1:]).encode('ascii')) # .encode needed for Python 3.[0-2]
  380. data = self.decrypt_key_file(cdata, passphrase)
  381. if data:
  382. key = msgpack.unpackb(data)
  383. if key[b'version'] != 1:
  384. raise IntegrityError('Invalid key file header')
  385. self.repository_id = key[b'repository_id']
  386. self.enc_key = key[b'enc_key']
  387. self.enc_hmac_key = key[b'enc_hmac_key']
  388. self.id_key = key[b'id_key']
  389. self.chunk_seed = key[b'chunk_seed']
  390. self.path = filename
  391. return True
  392. def decrypt_key_file(self, data, passphrase):
  393. d = msgpack.unpackb(data)
  394. assert d[b'version'] == 1
  395. assert d[b'algorithm'] == b'gmac'
  396. key = pbkdf2_sha256(passphrase.encode('utf-8'), d[b'salt'], d[b'iterations'], 32)
  397. try:
  398. cipher = AES(mode=AES_GCM_MODE, is_encrypt=False, key=key, iv=b'\0'*16)
  399. data = cipher.check_mac_and_decrypt(d[b'hash'], d[b'data'])
  400. return data
  401. except Exception:
  402. return None
  403. def encrypt_key_file(self, data, passphrase):
  404. salt = get_random_bytes(32)
  405. iterations = 100000
  406. key = pbkdf2_sha256(passphrase.encode('utf-8'), salt, iterations, 32)
  407. cipher = AES(mode=AES_GCM_MODE, is_encrypt=True, key=key, iv=b'\0'*16)
  408. mac, cdata = cipher.compute_mac_and_encrypt(data)
  409. d = {
  410. 'version': 1,
  411. 'salt': salt,
  412. 'iterations': iterations,
  413. 'algorithm': 'gmac',
  414. 'hash': mac,
  415. 'data': cdata,
  416. }
  417. return msgpack.packb(d)
  418. def save(self, path, passphrase):
  419. key = {
  420. 'version': 1,
  421. 'repository_id': self.repository_id,
  422. 'enc_key': self.enc_key,
  423. 'enc_hmac_key': self.enc_hmac_key,
  424. 'id_key': self.id_key,
  425. 'chunk_seed': self.chunk_seed,
  426. }
  427. data = self.encrypt_key_file(msgpack.packb(key), passphrase)
  428. with open(path, 'w') as fd:
  429. fd.write('%s %s\n' % (self.FILE_ID, hexlify(self.repository_id).decode('ascii')))
  430. fd.write('\n'.join(textwrap.wrap(b2a_base64(data).decode('ascii'))))
  431. fd.write('\n')
  432. self.path = path
  433. def change_passphrase(self):
  434. passphrase, passphrase2 = 1, 2
  435. while passphrase != passphrase2:
  436. passphrase = getpass('New passphrase: ')
  437. passphrase2 = getpass('Enter same passphrase again: ')
  438. if passphrase != passphrase2:
  439. print('Passphrases do not match')
  440. self.save(self.path, passphrase)
  441. print('Key file "%s" updated' % self.path)
  442. @classmethod
  443. def create(cls, repository, args):
  444. filename = args.repository.to_key_filename()
  445. path = filename
  446. i = 1
  447. while os.path.exists(path):
  448. i += 1
  449. path = filename + '.%d' % i
  450. passphrase = os.environ.get('ATTIC_PASSPHRASE')
  451. if passphrase is not None:
  452. passphrase2 = passphrase
  453. else:
  454. passphrase, passphrase2 = 1, 2
  455. while passphrase != passphrase2:
  456. passphrase = getpass('Enter passphrase (empty for no passphrase):')
  457. passphrase2 = getpass('Enter same passphrase again: ')
  458. if passphrase != passphrase2:
  459. print('Passphrases do not match')
  460. compressor = compressor_creator(args)
  461. maccer = maccer_creator(args, cls)
  462. cipher = cipher_creator(args, cls)
  463. key = cls(compressor, maccer, cipher)
  464. key.repository_id = repository.id
  465. key.init_from_random_data(get_random_bytes(100))
  466. key.init_ciphers()
  467. key.save(path, passphrase)
  468. print('Key file "%s" created.' % key.path)
  469. print('Keep this file safe. Your data will be inaccessible without it.')
  470. return key
  471. # note: key 0 nicely maps to a zlib compressor with level 0 which means "no compression"
  472. compressor_mapping = {}
  473. for level in ZlibCompressor.LEVELS:
  474. compressor_mapping[ZlibCompressor.TYPE + level] = \
  475. type('ZlibCompressorLevel%d' % level, (ZlibCompressor, ), dict(TYPE=ZlibCompressor.TYPE + level))
  476. for preset in LzmaCompressor.PRESETS:
  477. compressor_mapping[LzmaCompressor.TYPE + preset] = \
  478. type('LzmaCompressorPreset%d' % preset, (LzmaCompressor, ), dict(TYPE=LzmaCompressor.TYPE + preset))
  479. # overwrite 0 with NullCompressor
  480. compressor_mapping[NullCompressor.TYPE] = NullCompressor
  481. keyer_mapping = {
  482. KeyfileKey.TYPE: KeyfileKey,
  483. PassphraseKey.TYPE: PassphraseKey,
  484. PlaintextKey.TYPE: PlaintextKey,
  485. }
  486. maccer_mapping = {
  487. # simple hashes, not MACs (but MAC-like class __init__ method signature):
  488. SHA256.TYPE: SHA256,
  489. SHA512_256.TYPE: SHA512_256,
  490. GHASH.TYPE: GHASH,
  491. # MACs:
  492. HMAC_SHA256.TYPE: HMAC_SHA256,
  493. HMAC_SHA512_256.TYPE: HMAC_SHA512_256,
  494. GMAC.TYPE: GMAC,
  495. }
  496. cipher_mapping = {
  497. # no cipher (but cipher-like class __init__ method signature):
  498. PLAIN.TYPE: PLAIN,
  499. # AEAD cipher implementations
  500. AES_CTR_HMAC.TYPE: AES_CTR_HMAC,
  501. AES_GCM.TYPE: AES_GCM,
  502. }
  503. def get_implementations(meta):
  504. try:
  505. compressor = compressor_mapping[meta.compr_type]
  506. keyer = keyer_mapping[meta.key_type]
  507. maccer = maccer_mapping[meta.mac_type]
  508. cipher = cipher_mapping[meta.cipher_type]
  509. except KeyError:
  510. raise UnsupportedPayloadError("compr_type %x key_type %x mac_type %x cipher_type %x" % (
  511. meta.compr_type, meta.key_type, meta.mac_type, meta.cipher_type))
  512. return compressor, keyer, maccer, cipher
  513. def legacy_parser(all_data, key_type): # all rather hardcoded
  514. """
  515. Payload layout:
  516. no encryption: TYPE(1) + data
  517. with encryption: TYPE(1) + HMAC(32) + NONCE(8) + data
  518. data is compressed with zlib level 6 and (in the 2nd case) encrypted.
  519. To reduce payload size only 8 bytes of the 16 bytes nonce is saved
  520. in the payload, the first 8 bytes are always zeros. This does not
  521. affect security but limits the maximum repository capacity to
  522. only 295 exabytes!
  523. """
  524. offset = 1
  525. if key_type == PlaintextKey.TYPE:
  526. mac_type = SHA256.TYPE
  527. mac = None
  528. cipher_type = PLAIN.TYPE
  529. iv = None
  530. data = all_data[offset:]
  531. else:
  532. mac_type = HMAC_SHA256.TYPE
  533. mac = all_data[offset:offset+32]
  534. cipher_type = AES_CTR_HMAC.TYPE
  535. iv = PREFIX + all_data[offset+32:offset+40]
  536. data = all_data[offset+40:]
  537. meta = Meta(compr_type=6, key_type=key_type, mac_type=mac_type,
  538. cipher_type=cipher_type, iv=iv, legacy=True)
  539. return mac, meta, data
  540. def parser00(all_data):
  541. return legacy_parser(all_data, KeyfileKey.TYPE)
  542. def parser01(all_data):
  543. return legacy_parser(all_data, PassphraseKey.TYPE)
  544. def parser02(all_data):
  545. return legacy_parser(all_data, PlaintextKey.TYPE)
  546. def parser03(all_data): # new & flexible
  547. """
  548. Payload layout:
  549. always: TYPE(1) + MSGPACK((mac, meta, data))
  550. meta is a Meta namedtuple and contains all required information about data.
  551. data is maybe compressed (see meta) and maybe encrypted (see meta).
  552. """
  553. max_len = 10000000 # XXX formula?
  554. unpacker = msgpack.Unpacker(
  555. use_list=False,
  556. # avoid memory allocation issues causes by tampered input data.
  557. max_buffer_size=max_len, # does not work in 0.4.6 unpackb C implementation
  558. max_array_len=10, # meta_tuple
  559. max_bin_len=max_len, # data
  560. max_str_len=0, # not used yet
  561. max_map_len=0, # not used yet
  562. max_ext_len=0, # not used yet
  563. )
  564. unpacker.feed(all_data[1:])
  565. mac, meta_tuple, data = unpacker.unpack()
  566. meta = Meta(*meta_tuple)
  567. return mac, meta, data
  568. def parser(data):
  569. parser_mapping = {
  570. 0x00: parser00,
  571. 0x01: parser01,
  572. 0x02: parser02,
  573. 0x03: parser03,
  574. }
  575. header_type = data[0]
  576. parser_func = parser_mapping[header_type]
  577. return parser_func(data)
  578. def key_factory(repository, manifest_data):
  579. mac, meta, data = parser(manifest_data)
  580. compressor, keyer, maccer, cipher = get_implementations(meta)
  581. return keyer.detect(repository, manifest_data)
  582. def generate(mac, meta, data):
  583. # always create new-style 0x03 format
  584. return b'\x03' + msgpack.packb((mac, meta, data), use_bin_type=True)
  585. def compressor_creator(args):
  586. # args == None is used by unit tests
  587. compression = COMPR_DEFAULT if args is None else args.compression
  588. compressor = compressor_mapping.get(compression)
  589. if compressor is None:
  590. raise NotImplementedError("no compression %d" % args.compression)
  591. return compressor
  592. def key_creator(args):
  593. if args.encryption == 'keyfile':
  594. return KeyfileKey
  595. if args.encryption == 'passphrase':
  596. return PassphraseKey
  597. if args.encryption == 'none':
  598. return PlaintextKey
  599. raise NotImplemented("no encryption %s" % args.encryption)
  600. def maccer_creator(args, key_cls):
  601. # args == None is used by unit tests
  602. mac = None if args is None else args.mac
  603. if mac is None:
  604. if key_cls is PlaintextKey:
  605. mac = HASH_DEFAULT
  606. elif key_cls in (KeyfileKey, PassphraseKey):
  607. mac = MAC_DEFAULT
  608. else:
  609. raise NotImplementedError("unknown key class")
  610. maccer = maccer_mapping.get(mac)
  611. if maccer is None:
  612. raise NotImplementedError("no mac %d" % args.mac)
  613. return maccer
  614. def cipher_creator(args, key_cls):
  615. # args == None is used by unit tests
  616. cipher = None if args is None else args.cipher
  617. if cipher is None:
  618. if key_cls is PlaintextKey:
  619. cipher = PLAIN_DEFAULT
  620. elif key_cls in (KeyfileKey, PassphraseKey):
  621. cipher = CIPHER_DEFAULT
  622. else:
  623. raise NotImplementedError("unknown key class")
  624. cipher = cipher_mapping.get(cipher)
  625. if cipher is None:
  626. raise NotImplementedError("no cipher %d" % args.cipher)
  627. return cipher