key.py 25 KB

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