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):
 239         return self._clean_type_regex.sub('_', self['type'])
 240
 241     def __str__(self):
 242         method_name = '_str_{}'.format(self._clean_type())
 243         method = getattr(self, method_name, None)
 244         if not method:
 245             return self['type']
 246         details = method()
 247         return '{}: {}'.format(self['type'], details)
 248
 249     def _str_public_key_packet(self):
 250         return self._str_generic_key_packet()
 251
 252     def _str_public_subkey_packet(self):
 253         return self._str_generic_key_packet()
 254
 255     def _str_secret_key_packet(self):
 256         return self._str_generic_key_packet()
 257
 258     def _str_secret_subkey_packet(self):
 259         return self._str_generic_key_packet()
 260
 261     def _str_generic_key_packet(self):
 262         return self['fingerprint'][-8:].upper()
 263
 264     def _str_signature_packet(self):
 265         lines = [self['signature-type']]
 266         if self['unhashed-subpackets']:
 267             lines.append('  unhashed subpackets:')
 268             for subpacket in self['unhashed-subpackets']:
 269                 lines.append('    {}'.format(subpacket['type']))
 270         return '\n'.join(lines)
 271
 272     def _str_user_id_packet(self):
 273         return self['user']
 274
 275     def from_bytes(self, data):
 276         offset = self._parse_header(data=data)
 277         packet = data[offset:offset + self['length']]
 278         if len(packet) < self['length']:
 279             raise ValueError('packet too short ({} < {})'.format(
 280                 len(packet), self['length']))
 281         offset += self['length']
 282         method_name = '_parse_{}'.format(self._clean_type())
 283         method = getattr(self, method_name, None)
 284         if not method:
 285             raise NotImplementedError(
 286                 'cannot parse packet type {!r}'.format(self['type']))
 287         method(data=packet)
 288         return offset
 289
 290     def _parse_header(self, data):
 291         packet_tag = data[0]
 292         offset = 1
 293         always_one = packet_tag & 1 << 7
 294         if not always_one:
 295             raise ValueError('most significant packet tag bit not set')
 296         self['new-format'] = packet_tag & 1 << 6
 297         if self['new-format']:
 298             type_code = packet_tag & 0b111111
 299             raise NotImplementedError('new-format packet length')
 300         else:
 301             type_code = packet_tag >> 2 & 0b1111
 302             self['length-type'] = packet_tag & 0b11
 303             length_bytes, length_type = self._old_format_packet_length_type[
 304                 self['length-type']]
 305             if not length_bytes:
 306                 raise NotImplementedError(
 307                     'old-format packet of indeterminate length')
 308             length_format = '>{}'.format(length_type)
 309             length_data = data[offset: offset + length_bytes]
 310             offset += length_bytes
 311             self['length'] = _struct.unpack(length_format, length_data)[0]
 312         self['type'] = self._packet_types[type_code]
 313         return offset
 314
 315     @staticmethod
 316     def _parse_multiprecision_integer(data):
 317         r"""Parse RFC 4880's multiprecision integers
 318
 319         >>> PGPPacket._parse_multiprecision_integer(b'\x00\x01\x01')
 320         (3, 1)
 321         >>> PGPPacket._parse_multiprecision_integer(b'\x00\x09\x01\xff')
 322         (4, 511)
 323         """
 324         bits = _struct.unpack('>H', data[:2])[0]
 325         offset = 2
 326         length = (bits + 7) // 8
 327         value = 0
 328         for i in range(length):
 329             value += data[offset + i] * 1 << (8 * (length - i - 1))
 330         offset += length
 331         return (offset, value)
 332
 333     def _parse_string_to_key_specifier(self, data):
 334         self['string-to-key-type'] = self._string_to_key_types[data[0]]
 335         offset = 1
 336         if self['string-to-key-type'] == 'simple':
 337             self['string-to-key-hash-algorithm'] = self._hash_algorithms[
 338                 data[offset]]
 339             offset += 1
 340         elif self['string-to-key-type'] == 'salted':
 341             self['string-to-key-hash-algorithm'] = self._hash_algorithms[
 342                 data[offset]]
 343             offset += 1
 344             self['string-to-key-salt'] = data[offset: offset + 8]
 345             offset += 8
 346         elif self['string-to-key-type'] == 'iterated and salted':
 347             self['string-to-key-hash-algorithm'] = self._hash_algorithms[
 348                 data[offset]]
 349             offset += 1
 350             self['string-to-key-salt'] = data[offset: offset + 8]
 351             offset += 8
 352             self['string-to-key-coded-count'] = data[offset]
 353             offset += 1
 354         else:
 355             raise NotImplementedError(
 356                 'string-to-key type {}'.format(self['string-to-key-type']))
 357         return offset
 358
 359     def _parse_public_key_packet(self, data):
 360         self._parse_generic_public_key_packet(data=data)
 361
 362     def _parse_public_subkey_packet(self, data):
 363         self._parse_generic_public_key_packet(data=data)
 364
 365     def _parse_generic_public_key_packet(self, data):
 366         self['key-version'] = data[0]
 367         offset = 1
 368         if self['key-version'] != 4:
 369             raise NotImplementedError(
 370                 'public (sub)key packet version {}'.format(
 371                     self['key-version']))
 372         length = 5
 373         self['creation-time'], algorithm = _struct.unpack(
 374             '>IB', data[offset: offset + length])
 375         offset += length
 376         self['public-key-algorithm'] = self._public_key_algorithms[algorithm]
 377         if self['public-key-algorithm'].startswith('rsa '):
 378             o, self['public-modulus'] = self._parse_multiprecision_integer(
 379                 data[offset:])
 380             offset += o
 381             o, self['public-exponent'] = self._parse_multiprecision_integer(
 382                 data[offset:])
 383             offset += o
 384         elif self['public-key-algorithm'].startswith('dsa '):
 385             o, self['prime'] = self._parse_multiprecision_integer(
 386                 data[offset:])
 387             offset += o
 388             o, self['group-order'] = self._parse_multiprecision_integer(
 389                 data[offset:])
 390             offset += o
 391             o, self['group-generator'] = self._parse_multiprecision_integer(
 392                 data[offset:])
 393             offset += o
 394             o, self['public-key'] = self._parse_multiprecision_integer(
 395                 data[offset:])
 396             offset += o
 397         elif self['public-key-algorithm'].startswith('elgamal '):
 398             o, self['prime'] = self._parse_multiprecision_integer(
 399                 data[offset:])
 400             offset += o
 401             o, self['group-generator'] = self._parse_multiprecision_integer(
 402                 data[offset:])
 403             offset += o
 404             o, self['public-key'] = self._parse_multiprecision_integer(
 405                 data[offset:])
 406             offset += o
 407         else:
 408             raise NotImplementedError(
 409                 'algorithm-specific key fields for {}'.format(
 410                     self['public-key-algorithm']))
 411         fingerprint = _hashlib.sha1()
 412         fingerprint.update(b'\x99')
 413         fingerprint.update(_struct.pack('>H', len(data)))
 414         fingerprint.update(data)
 415         self['fingerprint'] = fingerprint.hexdigest()
 416         return offset
 417
 418     def _parse_secret_key_packet(self, data):
 419         self._parse_generic_secret_key_packet(data=data)
 420
 421     def _parse_secret_subkey_packet(self, data):
 422         self._parse_generic_secret_key_packet(data=data)
 423
 424     def _parse_generic_secret_key_packet(self, data):
 425         offset = self._parse_generic_public_key_packet(data=data)
 426         string_to_key_usage = data[offset]
 427         offset += 1
 428         if string_to_key_usage in [255, 254]:
 429             self['symmetric-encryption-algorithm'] = (
 430                 self._symmetric_key_algorithms[data[offset]])
 431             offset += 1
 432             offset += self._parse_string_to_key_specifier(data=data[offset:])
 433         else:
 434             self['symmetric-encryption-algorithm'] = (
 435                 self._symmetric_key_algorithms[string_to_key_usage])
 436         if string_to_key_usage:
 437             block_size_bits = self._cipher_block_size.get(
 438                 self['symmetric-encryption-algorithm'], None)
 439             if block_size_bits % 8:
 440                 raise NotImplementedError(
 441                     ('{}-bit block size for {} is not an integer number of bytes'
 442                      ).format(
 443                          block_size_bits, self['symmetric-encryption-algorithm']))
 444             block_size = block_size_bits // 8
 445             if not block_size:
 446                 raise NotImplementedError(
 447                     'unknown block size for {}'.format(
 448                         self['symmetric-encryption-algorithm']))
 449             self['initial-vector'] = data[offset: offset + block_size]
 450             offset += block_size
 451         if string_to_key_usage in [0, 255]:
 452             key_end = -2
 453         else:
 454             key_end = 0
 455         self['secret-key'] = data[offset:key_end]
 456         if key_end:
 457             self['secret-key-checksum'] = data[key_end:]
 458
 459     def _parse_signature_subpackets(self, data):
 460         offset = 0
 461         while offset < len(data):
 462             o, subpacket = self._parse_signature_subpacket(data=data[offset:])
 463             offset += o
 464             yield subpacket
 465
 466     def _parse_signature_subpacket(self, data):
 467         subpacket = {}
 468         first = data[0]
 469         offset = 1
 470         if first < 192:
 471             length = first
 472         elif first >= 192 and first < 255:
 473             second = data[offset]
 474             offset += 1
 475             length = ((first - 192) << 8) + second + 192
 476         else:
 477             length = _struct.unpack(
 478                 '>I', data[offset: offset + 4])[0]
 479             offset += 4
 480         subpacket['type'] = self._signature_subpacket_types[data[offset]]
 481         offset += 1
 482         subpacket['data'] = data[offset: offset + length - 1]
 483         offset += len(subpacket['data'])
 484         return (offset, subpacket)
 485
 486     def _parse_signature_packet(self, data):
 487         self['signature-version'] = data[0]
 488         offset = 1
 489         if self['signature-version'] != 4:
 490             raise NotImplementedError(
 491                 'signature packet version {}'.format(
 492                     self['signature-version']))
 493         self['signature-type'] = self._signature_types[data[offset]]
 494         offset += 1
 495         self['public-key-algorithm'] = self._public_key_algorithms[
 496             data[offset]]
 497         offset += 1
 498         self['hash-algorithm'] = self._hash_algorithms[data[offset]]
 499         offset += 1
 500         hashed_count = _struct.unpack('>H', data[offset: offset + 2])[0]
 501         offset += 2
 502         self['hashed-subpackets'] = data[offset: offset + hashed_count]
 503         offset += hashed_count
 504         unhashed_count = _struct.unpack('>H', data[offset: offset + 2])[0]
 505         offset += 2
 506         self['unhashed-subpackets'] = list(self._parse_signature_subpackets(
 507             data=data[offset: offset + unhashed_count]))
 508         offset += unhashed_count
 509         self['signed-hash-word'] = data[offset: offset + 2]
 510         offset += 2
 511         self['signature'] = data[offset:]
 512
 513     def _parse_user_id_packet(self, data):
 514         self['user'] = str(data, 'utf-8')
 515
 516     def to_bytes(self):
 517         pass
 518
 519
 520 def packets_from_bytes(data):
 521     offset = 0
 522     while offset < len(data):
 523         packet = PGPPacket()
 524         offset += packet.from_bytes(data=data[offset:])
 525         yield packet
 526
 527
 528 class PGPKey (object):
 529     def __init__(self, fingerprint):
 530         self.fingerprint = fingerprint
 531         self.public_packets = None
 532         self.secret_packets = None
 533
 534     def __str__(self):
 535         lines = ['key: {}'.format(self.fingerprint)]
 536         if self.public_packets:
 537             lines.append('  public:')
 538             for packet in self.public_packets:
 539                 lines.extend(self._str_packet(packet=packet, prefix='    '))
 540         if self.secret_packets:
 541             lines.append('  secret:')
 542             for packet in self.secret_packets:
 543                 lines.extend(self._str_packet(packet=packet, prefix='    '))
 544         return '\n'.join(lines)
 545
 546     def _str_packet(self, packet, prefix):
 547         lines = str(packet).split('\n')
 548         return [prefix + line for line in lines]
 549
 550     def import_from_gpg(self):
 551         key_export = _get_stdout(
 552             ['gpg', '--export', self.fingerprint])
 553         self.public_packets = list(
 554             packets_from_bytes(data=key_export))
 555         if self.public_packets[0]['type'] != 'public-key packet':
 556             raise ValueError(
 557                 '{} does not start with a public-key packet'.format(
 558                     self.fingerprint))
 559         key_secret_export = _get_stdout(
 560             ['gpg', '--export-secret-keys', self.fingerprint])
 561         self.secret_packets = list(
 562             packets_from_bytes(data=key_secret_export))
 563
 564     def export_to_gpg(self):
 565         raise NotImplemetedError('export to gpg')
 566
 567     def import_from_key(self, key):
 568         """Migrate the (sub)keys into this key"""
 569         pass
 570
 571
 572 def migrate(old_key, new_key):
 573     """Add the old key and sub-keys to the new key
 574
 575     For example, to upgrade your master key, while preserving old
 576     signatures you'd made.  You will lose signature *on* your old key
 577     though, since sub-keys can't be signed (I don't think).
 578     """
 579     old_key = PGPKey(fingerprint=old_key)
 580     old_key.import_from_gpg()
 581     new_key = PGPKey(fingerprint=new_key)
 582     new_key.import_from_gpg()
 583     new_key.import_from_key(key=old_key)
 584
 585     print(old_key)
 586     print(new_key)
 587
 588
 589 if __name__ == '__main__':
 590     import sys as _sys
 591
 592     old_key, new_key = _sys.argv[1:3]
 593     migrate(old_key=old_key, new_key=new_key)