6055eb105020b88528ce07b113151590aa95ec2e
[gpg-migrate.git] / gpg-migrate.py
1 #!/usr/bin/python
2
3 import hashlib as _hashlib
4 import re as _re
5 import subprocess as _subprocess
6 import struct as _struct
7
8
9 def _get_stdout(args, stdin=None):
10     stdin_pipe = None
11     if stdin is not None:
12         stdin_pipe = _subprocess.PIPE
13     p = _subprocess.Popen(args, stdin=stdin_pipe, stdout=_subprocess.PIPE)
14     stdout, stderr = p.communicate(stdin)
15     status = p.wait()
16     if status != 0:
17         raise RuntimeError(status)
18     return stdout
19
20
21 class PGPPacket (dict):
22     # http://tools.ietf.org/search/rfc4880
23     _old_format_packet_length_type = {  # type: (bytes, struct type)
24         0: (1, 'B'),  # 1-byte unsigned integer
25         1: (2, 'H'),  # 2-byte unsigned integer
26         2: (4, 'I'),  # 4-byte unsigned integer
27         3: (None, None),
28         }
29
30     _packet_types = {
31         0: 'reserved',
32         1: 'public-key encrypted session key packet',
33         2: 'signature packet',
34         3: 'symmetric-key encrypted session key packet',
35         4: 'one-pass signature packet',
36         5: 'secret-key packet',
37         6: 'public-key packet',
38         7: 'secret-subkey packet',
39         8: 'compressed data packet',
40         9: 'symmetrically encrypted data packet',
41         10: 'marker packet',
42         11: 'literal data packet',
43         12: 'trust packet',
44         13: 'user id packet',
45         14: 'public-subkey packet',
46         17: 'user attribute packet',
47         18: 'sym. encrypted and integrity protected data packet',
48         19: 'modification detection code packet',
49         60: 'private',
50         61: 'private',
51         62: 'private',
52         63: 'private',
53         }
54
55     _public_key_algorithms = {
56         1: 'rsa (encrypt or sign)',
57         2: 'rsa encrypt-only',
58         3: 'rsa sign-only',
59         16: 'elgamal (encrypt-only)',
60         17: 'dsa (digital signature algorithm)',
61         18: 'reserved for elliptic curve',
62         19: 'reserved for ecdsa',
63         20: 'reserved (formerly elgamal encrypt or sign)',
64         21: 'reserved for diffie-hellman',
65         100: 'private',
66         101: 'private',
67         102: 'private',
68         103: 'private',
69         104: 'private',
70         105: 'private',
71         106: 'private',
72         107: 'private',
73         108: 'private',
74         109: 'private',
75         110: 'private',
76         }
77
78     _symmetric_key_algorithms = {
79         0: 'plaintext or unencrypted data',
80         1: 'idea',
81         2: 'tripledes',
82         3: 'cast5',
83         4: 'blowfish',
84         5: 'reserved',
85         6: 'reserved',
86         7: 'aes with 128-bit key',
87         8: 'aes with 192-bit key',
88         9: 'aes with 256-bit key',
89         10: 'twofish',
90         100: 'private',
91         101: 'private',
92         102: 'private',
93         103: 'private',
94         104: 'private',
95         105: 'private',
96         106: 'private',
97         107: 'private',
98         108: 'private',
99         109: 'private',
100         110: 'private',
101         }
102
103     _cipher_block_size = {  # in bits
104         'aes with 128-bit key': 128,
105         'aes with 192-bit key': 128,
106         'aes with 256-bit key': 128,
107         'cast5': 64,
108         }
109
110     _compression_algorithms = {
111         0: 'uncompressed',
112         1: 'zip',
113         2: 'zlib',
114         3: 'bzip2',
115         100: 'private',
116         101: 'private',
117         102: 'private',
118         103: 'private',
119         104: 'private',
120         105: 'private',
121         106: 'private',
122         107: 'private',
123         108: 'private',
124         109: 'private',
125         110: 'private',
126         }
127
128     _hash_algorithms = {
129         1: 'md5',
130         2: 'sha-1',
131         3: 'ripe-md/160',
132         4: 'reserved',
133         5: 'reserved',
134         6: 'reserved',
135         7: 'reserved',
136         8: 'sha256',
137         9: 'sha384',
138         10: 'sha512',
139         11: 'sha224',
140         100: 'private',
141         101: 'private',
142         102: 'private',
143         103: 'private',
144         104: 'private',
145         105: 'private',
146         106: 'private',
147         107: 'private',
148         108: 'private',
149         109: 'private',
150         110: 'private',
151         }
152
153     _string_to_key_types = {
154         0: 'simple',
155         1: 'salted',
156         2: 'reserved',
157         3: 'iterated and salted',
158         100: 'private',
159         101: 'private',
160         102: 'private',
161         103: 'private',
162         104: 'private',
163         105: 'private',
164         106: 'private',
165         107: 'private',
166         108: 'private',
167         109: 'private',
168         110: 'private',
169         }
170
171     _signature_types = {
172         0x00: 'binary document',
173         0x01: 'canonical text document',
174         0x02: 'standalone',
175         0x10: 'generic user id and public-key packet',
176         0x11: 'persona user id and public-key packet',
177         0x12: 'casual user id and public-key packet',
178         0x13: 'postitive user id and public-key packet',
179         0x18: 'subkey binding',
180         0x19: 'primary key binding',
181         0x1F: 'direct key',
182         0x20: 'key revocation',
183         0x28: 'subkey revocation',
184         0x30: 'certification revocation',
185         0x40: 'timestamp',
186         0x50: 'third-party confirmation',
187         }
188
189     _signature_subpacket_types = {
190         0: 'reserved',
191         1: 'reserved',
192         2: 'signature creation time',
193         3: 'signature expiration time',
194         4: 'exportable certification',
195         5: 'trust signature',
196         6: 'regular expression',
197         7: 'revocable',
198         8: 'reserved',
199         9: 'key expiration time',
200         10: 'placeholder for backward compatibility',
201         11: 'preferred symmetric algorithms',
202         12: 'revocation key',
203         13: 'reserved',
204         14: 'reserved',
205         15: 'reserved',
206         16: 'issuer',
207         17: 'reserved',
208         18: 'reserved',
209         19: 'reserved',
210         20: 'notation data',
211         21: 'preferred hash algorithms',
212         22: 'preferred compression algorithms',
213         23: 'key server preferences',
214         24: 'preferred key server',
215         25: 'primary user id',
216         26: 'policy uri',
217         27: 'key flags',
218         28: 'signer user id',
219         29: 'reason for revocation',
220         30: 'features',
221         31: 'signature target',
222         32: 'embedded signature',
223         100: 'private',
224         101: 'private',
225         102: 'private',
226         103: 'private',
227         104: 'private',
228         105: 'private',
229         106: 'private',
230         107: 'private',
231         108: 'private',
232         109: 'private',
233         110: 'private',
234         }
235
236     _clean_type_regex = _re.compile('\W+')
237
238     def _clean_type(self, type=None):
239         if type is None:
240             type = self['type']
241         return self._clean_type_regex.sub('_', type)
242
243     def __str__(self):
244         method_name = '_str_{}'.format(self._clean_type())
245         method = getattr(self, method_name, None)
246         if not method:
247             return self['type']
248         details = method()
249         return '{}: {}'.format(self['type'], details)
250
251     def _str_public_key_packet(self):
252         return self._str_generic_key_packet()
253
254     def _str_public_subkey_packet(self):
255         return self._str_generic_key_packet()
256
257     def _str_secret_key_packet(self):
258         return self._str_generic_key_packet()
259
260     def _str_secret_subkey_packet(self):
261         return self._str_generic_key_packet()
262
263     def _str_generic_key_packet(self):
264         return self['fingerprint'][-8:].upper()
265
266     def _str_signature_packet(self):
267         lines = [self['signature-type']]
268         if self['hashed-subpackets']:
269             lines.append('  hashed subpackets:')
270             lines.extend(self._str_signature_subpackets(
271                 self['hashed-subpackets'], prefix='    '))
272         if self['unhashed-subpackets']:
273             lines.append('  unhashed subpackets:')
274             lines.extend(self._str_signature_subpackets(
275                 self['unhashed-subpackets'], prefix='    '))
276         return '\n'.join(lines)
277
278     def _str_signature_subpackets(self, subpackets, prefix):
279         lines = []
280         for subpacket in subpackets:
281             method_name = '_str_{}_signature_subpacket'.format(
282                 self._clean_type(type=subpacket['type']))
283             method = getattr(self, method_name, None)
284             if method:
285                 lines.append('    {}: {}'.format(
286                     subpacket['type'],
287                     method(subpacket=subpacket)))
288             else:
289                 lines.append('    {}'.format(subpacket['type']))
290         return lines
291
292     def _str_issuer_signature_subpacket(self, subpacket):
293         return subpacket['issuer'][-8:].upper()
294
295     def _str_preferred_symmetric_algorithms_signature_subpacket(
296             self, subpacket):
297         return ', '.join(
298             algo for algo in subpacket['preferred-symmetric-algorithms'])
299
300     def _str_preferred_hash_algorithms_signature_subpacket(
301             self, subpacket):
302         return ', '.join(
303             algo for algo in subpacket['preferred-hash-algorithms'])
304
305     def _str_preferred_compression_algorithms_signature_subpacket(
306             self, subpacket):
307         return ', '.join(
308             algo for algo in subpacket['preferred-compression-algorithms'])
309
310     def _str_key_flags_signature_subpacket(self, subpacket):
311         return ', '.join(x for x in sorted(subpacket['key-flags']))
312
313     def _str_features_signature_subpacket(self, subpacket):
314         return ', '.join(x for x in sorted(subpacket['features']))
315
316     def _str_embedded_signature_signature_subpacket(self, subpacket):
317         return subpacket['embedded']['signature-type']
318
319     def _str_user_id_packet(self):
320         return self['user']
321
322     def from_bytes(self, data):
323         offset = self._parse_header(data=data)
324         packet = data[offset:offset + self['length']]
325         if len(packet) < self['length']:
326             raise ValueError('packet too short ({} < {})'.format(
327                 len(packet), self['length']))
328         offset += self['length']
329         method_name = '_parse_{}'.format(self._clean_type())
330         method = getattr(self, method_name, None)
331         if not method:
332             raise NotImplementedError(
333                 'cannot parse packet type {!r}'.format(self['type']))
334         method(data=packet)
335         return offset
336
337     def _parse_header(self, data):
338         packet_tag = data[0]
339         offset = 1
340         always_one = packet_tag & 1 << 7
341         if not always_one:
342             raise ValueError('most significant packet tag bit not set')
343         self['new-format'] = packet_tag & 1 << 6
344         if self['new-format']:
345             type_code = packet_tag & 0b111111
346             raise NotImplementedError('new-format packet length')
347         else:
348             type_code = packet_tag >> 2 & 0b1111
349             self['length-type'] = packet_tag & 0b11
350             length_bytes, length_type = self._old_format_packet_length_type[
351                 self['length-type']]
352             if not length_bytes:
353                 raise NotImplementedError(
354                     'old-format packet of indeterminate length')
355             length_format = '>{}'.format(length_type)
356             length_data = data[offset: offset + length_bytes]
357             offset += length_bytes
358             self['length'] = _struct.unpack(length_format, length_data)[0]
359         self['type'] = self._packet_types[type_code]
360         return offset
361
362     @staticmethod
363     def _parse_multiprecision_integer(data):
364         r"""Parse RFC 4880's multiprecision integers
365
366         >>> PGPPacket._parse_multiprecision_integer(b'\x00\x01\x01')
367         (3, 1)
368         >>> PGPPacket._parse_multiprecision_integer(b'\x00\x09\x01\xff')
369         (4, 511)
370         """
371         bits = _struct.unpack('>H', data[:2])[0]
372         offset = 2
373         length = (bits + 7) // 8
374         value = 0
375         for i in range(length):
376             value += data[offset + i] * 1 << (8 * (length - i - 1))
377         offset += length
378         return (offset, value)
379
380     def _parse_string_to_key_specifier(self, data):
381         self['string-to-key-type'] = self._string_to_key_types[data[0]]
382         offset = 1
383         if self['string-to-key-type'] == 'simple':
384             self['string-to-key-hash-algorithm'] = self._hash_algorithms[
385                 data[offset]]
386             offset += 1
387         elif self['string-to-key-type'] == 'salted':
388             self['string-to-key-hash-algorithm'] = self._hash_algorithms[
389                 data[offset]]
390             offset += 1
391             self['string-to-key-salt'] = data[offset: offset + 8]
392             offset += 8
393         elif self['string-to-key-type'] == 'iterated and salted':
394             self['string-to-key-hash-algorithm'] = self._hash_algorithms[
395                 data[offset]]
396             offset += 1
397             self['string-to-key-salt'] = data[offset: offset + 8]
398             offset += 8
399             self['string-to-key-coded-count'] = data[offset]
400             offset += 1
401         else:
402             raise NotImplementedError(
403                 'string-to-key type {}'.format(self['string-to-key-type']))
404         return offset
405
406     def _parse_public_key_packet(self, data):
407         self._parse_generic_public_key_packet(data=data)
408
409     def _parse_public_subkey_packet(self, data):
410         self._parse_generic_public_key_packet(data=data)
411
412     def _parse_generic_public_key_packet(self, data):
413         self['key-version'] = data[0]
414         offset = 1
415         if self['key-version'] != 4:
416             raise NotImplementedError(
417                 'public (sub)key packet version {}'.format(
418                     self['key-version']))
419         length = 5
420         self['creation-time'], algorithm = _struct.unpack(
421             '>IB', data[offset: offset + length])
422         offset += length
423         self['public-key-algorithm'] = self._public_key_algorithms[algorithm]
424         if self['public-key-algorithm'].startswith('rsa '):
425             o, self['public-modulus'] = self._parse_multiprecision_integer(
426                 data[offset:])
427             offset += o
428             o, self['public-exponent'] = self._parse_multiprecision_integer(
429                 data[offset:])
430             offset += o
431         elif self['public-key-algorithm'].startswith('dsa '):
432             o, self['prime'] = self._parse_multiprecision_integer(
433                 data[offset:])
434             offset += o
435             o, self['group-order'] = self._parse_multiprecision_integer(
436                 data[offset:])
437             offset += o
438             o, self['group-generator'] = self._parse_multiprecision_integer(
439                 data[offset:])
440             offset += o
441             o, self['public-key'] = self._parse_multiprecision_integer(
442                 data[offset:])
443             offset += o
444         elif self['public-key-algorithm'].startswith('elgamal '):
445             o, self['prime'] = self._parse_multiprecision_integer(
446                 data[offset:])
447             offset += o
448             o, self['group-generator'] = self._parse_multiprecision_integer(
449                 data[offset:])
450             offset += o
451             o, self['public-key'] = self._parse_multiprecision_integer(
452                 data[offset:])
453             offset += o
454         else:
455             raise NotImplementedError(
456                 'algorithm-specific key fields for {}'.format(
457                     self['public-key-algorithm']))
458         fingerprint = _hashlib.sha1()
459         fingerprint.update(b'\x99')
460         fingerprint.update(_struct.pack('>H', len(data)))
461         fingerprint.update(data)
462         self['fingerprint'] = fingerprint.hexdigest()
463         return offset
464
465     def _parse_secret_key_packet(self, data):
466         self._parse_generic_secret_key_packet(data=data)
467
468     def _parse_secret_subkey_packet(self, data):
469         self._parse_generic_secret_key_packet(data=data)
470
471     def _parse_generic_secret_key_packet(self, data):
472         offset = self._parse_generic_public_key_packet(data=data)
473         string_to_key_usage = data[offset]
474         offset += 1
475         if string_to_key_usage in [255, 254]:
476             self['symmetric-encryption-algorithm'] = (
477                 self._symmetric_key_algorithms[data[offset]])
478             offset += 1
479             offset += self._parse_string_to_key_specifier(data=data[offset:])
480         else:
481             self['symmetric-encryption-algorithm'] = (
482                 self._symmetric_key_algorithms[string_to_key_usage])
483         if string_to_key_usage:
484             block_size_bits = self._cipher_block_size.get(
485                 self['symmetric-encryption-algorithm'], None)
486             if block_size_bits % 8:
487                 raise NotImplementedError(
488                     ('{}-bit block size for {} is not an integer number of bytes'
489                      ).format(
490                          block_size_bits, self['symmetric-encryption-algorithm']))
491             block_size = block_size_bits // 8
492             if not block_size:
493                 raise NotImplementedError(
494                     'unknown block size for {}'.format(
495                         self['symmetric-encryption-algorithm']))
496             self['initial-vector'] = data[offset: offset + block_size]
497             offset += block_size
498         if string_to_key_usage in [0, 255]:
499             key_end = -2
500         else:
501             key_end = 0
502         self['secret-key'] = data[offset:key_end]
503         if key_end:
504             self['secret-key-checksum'] = data[key_end:]
505
506     def _parse_signature_subpackets(self, data):
507         offset = 0
508         while offset < len(data):
509             o, subpacket = self._parse_signature_subpacket(data=data[offset:])
510             offset += o
511             yield subpacket
512
513     def _parse_signature_subpacket(self, data):
514         subpacket = {}
515         first = data[0]
516         offset = 1
517         if first < 192:
518             length = first
519         elif first >= 192 and first < 255:
520             second = data[offset]
521             offset += 1
522             length = ((first - 192) << 8) + second + 192
523         else:
524             length = _struct.unpack(
525                 '>I', data[offset: offset + 4])[0]
526             offset += 4
527         subpacket['type'] = self._signature_subpacket_types[data[offset]]
528         offset += 1
529         subpacket_data = data[offset: offset + length - 1]
530         offset += len(subpacket_data)
531         method_name = '_parse_{}_signature_subpacket'.format(
532             self._clean_type(type=subpacket['type']))
533         method = getattr(self, method_name, None)
534         if not method:
535             raise NotImplementedError(
536                 'cannot parse signature subpacket type {!r}'.format(
537                     subpacket['type']))
538         method(data=subpacket_data, subpacket=subpacket)
539         return (offset, subpacket)
540
541     def _parse_signature_packet(self, data):
542         self['signature-version'] = data[0]
543         offset = 1
544         if self['signature-version'] != 4:
545             raise NotImplementedError(
546                 'signature packet version {}'.format(
547                     self['signature-version']))
548         self['signature-type'] = self._signature_types[data[offset]]
549         offset += 1
550         self['public-key-algorithm'] = self._public_key_algorithms[
551             data[offset]]
552         offset += 1
553         self['hash-algorithm'] = self._hash_algorithms[data[offset]]
554         offset += 1
555         hashed_count = _struct.unpack('>H', data[offset: offset + 2])[0]
556         offset += 2
557         self['hashed-subpackets'] = list(self._parse_signature_subpackets(
558             data[offset: offset + hashed_count]))
559         offset += hashed_count
560         unhashed_count = _struct.unpack('>H', data[offset: offset + 2])[0]
561         offset += 2
562         self['unhashed-subpackets'] = list(self._parse_signature_subpackets(
563             data=data[offset: offset + unhashed_count]))
564         offset += unhashed_count
565         self['signed-hash-word'] = data[offset: offset + 2]
566         offset += 2
567         self['signature'] = data[offset:]
568
569     def _parse_issuer_signature_subpacket(self, data, subpacket):
570         subpacket['issuer'] = ''.join('{:02x}'.format(byte) for byte in data)
571
572     def _parse_preferred_symmetric_algorithms_signature_subpacket(
573             self, data, subpacket):
574         subpacket['preferred-symmetric-algorithms'] = [
575             self._symmetric_key_algorithms[d] for d in data]
576
577     def _parse_preferred_hash_algorithms_signature_subpacket(
578             self, data, subpacket):
579         subpacket['preferred-hash-algorithms'] = [
580             self._hash_algorithms[d] for d in data]
581
582     def _parse_preferred_compression_algorithms_signature_subpacket(
583             self, data, subpacket):
584         subpacket['preferred-compression-algorithms'] = [
585             self._compression_algorithms[d] for d in data]
586
587     def _parse_key_flags_signature_subpacket(self, data, subpacket):
588         subpacket['key-flags'] = set()
589         if data[0] & 0x1:
590             subpacket['key-flags'].add('can certify')
591         if data[0] & 0x2:
592             subpacket['key-flags'].add('can sign')
593         if data[0] & 0x4:
594             subpacket['key-flags'].add('can encrypt communications')
595         if data[0] & 0x8:
596             subpacket['key-flags'].add('can encrypt storage')
597         if data[0] & 0x10:
598             subpacket['key-flags'].add('private split')
599         if data[0] & 0x20:
600             subpacket['key-flags'].add('can authenticate')
601         if data[0] & 0x80:
602             subpacket['key-flags'].add('private shared')
603
604     def _parse_features_signature_subpacket(self, data, subpacket):
605         subpacket['features'] = set()
606         if data[0] & 0x1:
607             subpacket['features'].add('modification detection')
608
609     def _parse_embedded_signature_signature_subpacket(self, data, subpacket):
610         subpacket['embedded'] = PGPPacket()
611         subpacket['embedded']._parse_signature_packet(data=data)
612
613     def _parse_user_id_packet(self, data):
614         self['user'] = str(data, 'utf-8')
615
616     def to_bytes(self):
617         pass
618
619
620 def packets_from_bytes(data):
621     offset = 0
622     while offset < len(data):
623         packet = PGPPacket()
624         offset += packet.from_bytes(data=data[offset:])
625         yield packet
626
627
628 class PGPKey (object):
629     def __init__(self, fingerprint):
630         self.fingerprint = fingerprint
631         self.public_packets = None
632         self.secret_packets = None
633
634     def __str__(self):
635         lines = ['key: {}'.format(self.fingerprint)]
636         if self.public_packets:
637             lines.append('  public:')
638             for packet in self.public_packets:
639                 lines.extend(self._str_packet(packet=packet, prefix='    '))
640         if self.secret_packets:
641             lines.append('  secret:')
642             for packet in self.secret_packets:
643                 lines.extend(self._str_packet(packet=packet, prefix='    '))
644         return '\n'.join(lines)
645
646     def _str_packet(self, packet, prefix):
647         lines = str(packet).split('\n')
648         return [prefix + line for line in lines]
649
650     def import_from_gpg(self):
651         key_export = _get_stdout(
652             ['gpg', '--export', self.fingerprint])
653         self.public_packets = list(
654             packets_from_bytes(data=key_export))
655         if self.public_packets[0]['type'] != 'public-key packet':
656             raise ValueError(
657                 '{} does not start with a public-key packet'.format(
658                     self.fingerprint))
659         key_secret_export = _get_stdout(
660             ['gpg', '--export-secret-keys', self.fingerprint])
661         self.secret_packets = list(
662             packets_from_bytes(data=key_secret_export))
663
664     def export_to_gpg(self):
665         raise NotImplemetedError('export to gpg')
666
667     def import_from_key(self, key):
668         """Migrate the (sub)keys into this key"""
669         pass
670
671
672 def migrate(old_key, new_key):
673     """Add the old key and sub-keys to the new key
674
675     For example, to upgrade your master key, while preserving old
676     signatures you'd made.  You will lose signature *on* your old key
677     though, since sub-keys can't be signed (I don't think).
678     """
679     old_key = PGPKey(fingerprint=old_key)
680     old_key.import_from_gpg()
681     new_key = PGPKey(fingerprint=new_key)
682     new_key.import_from_gpg()
683     new_key.import_from_key(key=old_key)
684
685     print(old_key)
686     print(new_key)
687
688
689 if __name__ == '__main__':
690     import sys as _sys
691
692     old_key, new_key = _sys.argv[1:3]
693     migrate(old_key=old_key, new_key=new_key)