3 import getpass as _getpass
4 import hashlib as _hashlib
7 import subprocess as _subprocess
8 import struct as _struct
10 import Crypto.Cipher.AES as _crypto_cipher_aes
11 import Crypto.Cipher.Blowfish as _crypto_cipher_blowfish
12 import Crypto.Cipher.CAST as _crypto_cipher_cast
13 import Crypto.Cipher.DES3 as _crypto_cipher_des3
16 def _get_stdout(args, stdin=None):
19 stdin_pipe = _subprocess.PIPE
20 p = _subprocess.Popen(args, stdin=stdin_pipe, stdout=_subprocess.PIPE)
21 stdout, stderr = p.communicate(stdin)
24 raise RuntimeError(status)
28 class PGPPacket (dict):
29 # http://tools.ietf.org/search/rfc4880
30 _old_format_packet_length_type = { # type: (bytes, struct type)
31 0: (1, 'B'), # 1-byte unsigned integer
32 1: (2, 'H'), # 2-byte unsigned integer
33 2: (4, 'I'), # 4-byte unsigned integer
39 1: 'public-key encrypted session key packet',
40 2: 'signature packet',
41 3: 'symmetric-key encrypted session key packet',
42 4: 'one-pass signature packet',
43 5: 'secret-key packet',
44 6: 'public-key packet',
45 7: 'secret-subkey packet',
46 8: 'compressed data packet',
47 9: 'symmetrically encrypted data packet',
49 11: 'literal data packet',
52 14: 'public-subkey packet',
53 17: 'user attribute packet',
54 18: 'sym. encrypted and integrity protected data packet',
55 19: 'modification detection code packet',
62 _public_key_algorithms = {
63 1: 'rsa (encrypt or sign)',
64 2: 'rsa encrypt-only',
66 16: 'elgamal (encrypt-only)',
67 17: 'dsa (digital signature algorithm)',
68 18: 'reserved for elliptic curve',
69 19: 'reserved for ecdsa',
70 20: 'reserved (formerly elgamal encrypt or sign)',
71 21: 'reserved for diffie-hellman',
85 _symmetric_key_algorithms = {
86 0: 'plaintext or unencrypted data',
93 7: 'aes with 128-bit key',
94 8: 'aes with 192-bit key',
95 9: 'aes with 256-bit key',
110 _cipher_block_size = { # in bits
111 'aes with 128-bit key': 128,
112 'aes with 192-bit key': 128,
113 'aes with 256-bit key': 128,
119 'aes with 128-bit key': _crypto_cipher_aes,
120 'aes with 192-bit key': _crypto_cipher_aes,
121 'aes with 256-bit key': _crypto_cipher_aes,
122 'blowfish': _crypto_cipher_blowfish,
123 'cast5': _crypto_cipher_cast,
124 'tripledes': _crypto_cipher_des3,
127 _key_size = { # in bits
128 'aes with 128-bit key': 128,
129 'aes with 192-bit key': 192,
130 'aes with 256-bit key': 256,
134 _compression_algorithms = {
177 _hashlib_name = { # map OpenPGP-based names to hashlib names
180 'ripe-md/160': 'ripemd160',
187 _string_to_key_types = {
191 3: 'iterated and salted',
205 _string_to_key_expbias = 6
208 0x00: 'binary document',
209 0x01: 'canonical text document',
211 0x10: 'generic user id and public-key packet',
212 0x11: 'persona user id and public-key packet',
213 0x12: 'casual user id and public-key packet',
214 0x13: 'postitive user id and public-key packet',
215 0x18: 'subkey binding',
216 0x19: 'primary key binding',
218 0x20: 'key revocation',
219 0x28: 'subkey revocation',
220 0x30: 'certification revocation',
222 0x50: 'third-party confirmation',
225 _signature_subpacket_types = {
228 2: 'signature creation time',
229 3: 'signature expiration time',
230 4: 'exportable certification',
231 5: 'trust signature',
232 6: 'regular expression',
235 9: 'key expiration time',
236 10: 'placeholder for backward compatibility',
237 11: 'preferred symmetric algorithms',
238 12: 'revocation key',
247 21: 'preferred hash algorithms',
248 22: 'preferred compression algorithms',
249 23: 'key server preferences',
250 24: 'preferred key server',
251 25: 'primary user id',
254 28: 'signer user id',
255 29: 'reason for revocation',
257 31: 'signature target',
258 32: 'embedded signature',
272 _clean_type_regex = _re.compile('\W+')
274 def __init__(self, key=None):
275 super(PGPPacket, self).__init__()
278 def _clean_type(self, type=None):
281 return self._clean_type_regex.sub('_', type)
284 def _reverse(dict, value):
285 """Reverse lookups in dictionaries
287 >>> PGPPacket._reverse(PGPPacket._packet_types, 'public-key packet')
290 return [k for k,v in dict.items() if v == value][0]
293 method_name = '_str_{}'.format(self._clean_type())
294 method = getattr(self, method_name, None)
298 return '{}: {}'.format(self['type'], details)
300 def _str_public_key_packet(self):
301 return self._str_generic_key_packet()
303 def _str_public_subkey_packet(self):
304 return self._str_generic_key_packet()
306 def _str_generic_key_packet(self):
307 return self['fingerprint'][-8:].upper()
309 def _str_secret_key_packet(self):
310 return self._str_generic_secret_key_packet()
312 def _str_secret_subkey_packet(self):
313 return self._str_generic_secret_key_packet()
315 def _str_generic_secret_key_packet(self):
316 lines = [self._str_generic_key_packet()]
318 ('symmetric encryption',
319 'symmetric-encryption-algorithm'),
320 ('s2k hash', 'string-to-key-hash-algorithm'),
321 ('s2k count', 'string-to-key-count'),
322 ('s2k salt', 'string-to-key-salt'),
323 ('IV', 'initial-vector'),
327 if isinstance(value, bytes):
328 value = ' '.join('{:02x}'.format(byte) for byte in value)
329 lines.append(' {}: {}'.format(label, value))
330 return '\n'.join(lines)
332 def _str_signature_packet(self):
333 lines = [self['signature-type']]
334 if self['hashed-subpackets']:
335 lines.append(' hashed subpackets:')
336 lines.extend(self._str_signature_subpackets(
337 self['hashed-subpackets'], prefix=' '))
338 if self['unhashed-subpackets']:
339 lines.append(' unhashed subpackets:')
340 lines.extend(self._str_signature_subpackets(
341 self['unhashed-subpackets'], prefix=' '))
342 return '\n'.join(lines)
344 def _str_signature_subpackets(self, subpackets, prefix):
346 for subpacket in subpackets:
347 method_name = '_str_{}_signature_subpacket'.format(
348 self._clean_type(type=subpacket['type']))
349 method = getattr(self, method_name, None)
351 lines.append(' {}: {}'.format(
353 method(subpacket=subpacket)))
355 lines.append(' {}'.format(subpacket['type']))
358 def _str_signature_creation_time_signature_subpacket(self, subpacket):
359 return str(subpacket['signature-creation-time'])
361 def _str_issuer_signature_subpacket(self, subpacket):
362 return subpacket['issuer'][-8:].upper()
364 def _str_key_expiration_time_signature_subpacket(self, subpacket):
365 return str(subpacket['key-expiration-time'])
367 def _str_preferred_symmetric_algorithms_signature_subpacket(
370 algo for algo in subpacket['preferred-symmetric-algorithms'])
372 def _str_preferred_hash_algorithms_signature_subpacket(
375 algo for algo in subpacket['preferred-hash-algorithms'])
377 def _str_preferred_compression_algorithms_signature_subpacket(
380 algo for algo in subpacket['preferred-compression-algorithms'])
382 def _str_key_server_preferences_signature_subpacket(self, subpacket):
384 x for x in sorted(subpacket['key-server-preferences']))
386 def _str_primary_user_id_signature_subpacket(self, subpacket):
387 return str(subpacket['primary-user-id'])
389 def _str_key_flags_signature_subpacket(self, subpacket):
390 return ', '.join(x for x in sorted(subpacket['key-flags']))
392 def _str_features_signature_subpacket(self, subpacket):
393 return ', '.join(x for x in sorted(subpacket['features']))
395 def _str_embedded_signature_signature_subpacket(self, subpacket):
396 return subpacket['embedded']['signature-type']
398 def _str_user_id_packet(self):
401 def from_bytes(self, data):
402 offset = self._parse_header(data=data)
403 packet = data[offset:offset + self['length']]
404 if len(packet) < self['length']:
405 raise ValueError('packet too short ({} < {})'.format(
406 len(packet), self['length']))
407 offset += self['length']
408 method_name = '_parse_{}'.format(self._clean_type())
409 method = getattr(self, method_name, None)
411 raise NotImplementedError(
412 'cannot parse packet type {!r}'.format(self['type']))
416 def _parse_header(self, data):
419 always_one = packet_tag & 1 << 7
421 raise ValueError('most significant packet tag bit not set')
422 self['new-format'] = packet_tag & 1 << 6
423 if self['new-format']:
424 type_code = packet_tag & 0b111111
425 raise NotImplementedError('new-format packet length')
427 type_code = packet_tag >> 2 & 0b1111
428 self['length-type'] = packet_tag & 0b11
429 length_bytes, length_type = self._old_format_packet_length_type[
432 raise NotImplementedError(
433 'old-format packet of indeterminate length')
434 length_format = '>{}'.format(length_type)
435 length_data = data[offset: offset + length_bytes]
436 offset += length_bytes
437 self['length'] = _struct.unpack(length_format, length_data)[0]
438 self['type'] = self._packet_types[type_code]
442 def _parse_multiprecision_integer(data):
443 r"""Parse RFC 4880's multiprecision integers
445 >>> PGPPacket._parse_multiprecision_integer(b'\x00\x01\x01')
447 >>> PGPPacket._parse_multiprecision_integer(b'\x00\x09\x01\xff')
450 bits = _struct.unpack('>H', data[:2])[0]
452 length = (bits + 7) // 8
454 for i in range(length):
455 value += data[offset + i] * 1 << (8 * (length - i - 1))
457 return (offset, value)
460 def _decode_string_to_key_count(cls, data):
461 r"""Decode RFC 4880's string-to-key count
463 >>> PGPPacket._decode_string_to_key_count(b'\x97'[0])
466 return (16 + (data & 15)) << ((data >> 4) + cls._string_to_key_expbias)
468 def _parse_string_to_key_specifier(self, data):
469 self['string-to-key-type'] = self._string_to_key_types[data[0]]
471 if self['string-to-key-type'] == 'simple':
472 self['string-to-key-hash-algorithm'] = self._hash_algorithms[
475 elif self['string-to-key-type'] == 'salted':
476 self['string-to-key-hash-algorithm'] = self._hash_algorithms[
479 self['string-to-key-salt'] = data[offset: offset + 8]
481 elif self['string-to-key-type'] == 'iterated and salted':
482 self['string-to-key-hash-algorithm'] = self._hash_algorithms[
485 self['string-to-key-salt'] = data[offset: offset + 8]
487 self['string-to-key-count'] = self._decode_string_to_key_count(
491 raise NotImplementedError(
492 'string-to-key type {}'.format(self['string-to-key-type']))
495 def _parse_public_key_packet(self, data):
496 self._parse_generic_public_key_packet(data=data)
498 def _parse_public_subkey_packet(self, data):
499 self._parse_generic_public_key_packet(data=data)
501 def _parse_generic_public_key_packet(self, data):
502 self['key-version'] = data[0]
504 if self['key-version'] != 4:
505 raise NotImplementedError(
506 'public (sub)key packet version {}'.format(
507 self['key-version']))
509 self['creation-time'], algorithm = _struct.unpack(
510 '>IB', data[offset: offset + length])
512 self['public-key-algorithm'] = self._public_key_algorithms[algorithm]
513 if self['public-key-algorithm'].startswith('rsa '):
514 o, self['public-modulus'] = self._parse_multiprecision_integer(
517 o, self['public-exponent'] = self._parse_multiprecision_integer(
520 elif self['public-key-algorithm'].startswith('dsa '):
521 o, self['prime'] = self._parse_multiprecision_integer(
524 o, self['group-order'] = self._parse_multiprecision_integer(
527 o, self['group-generator'] = self._parse_multiprecision_integer(
530 o, self['public-key'] = self._parse_multiprecision_integer(
533 elif self['public-key-algorithm'].startswith('elgamal '):
534 o, self['prime'] = self._parse_multiprecision_integer(
537 o, self['group-generator'] = self._parse_multiprecision_integer(
540 o, self['public-key'] = self._parse_multiprecision_integer(
544 raise NotImplementedError(
545 'algorithm-specific key fields for {}'.format(
546 self['public-key-algorithm']))
547 fingerprint = _hashlib.sha1()
548 fingerprint.update(b'\x99')
549 fingerprint.update(_struct.pack('>H', len(data)))
550 fingerprint.update(data)
551 self['fingerprint'] = fingerprint.hexdigest()
554 def _parse_secret_key_packet(self, data):
555 self._parse_generic_secret_key_packet(data=data)
557 def _parse_secret_subkey_packet(self, data):
558 self._parse_generic_secret_key_packet(data=data)
560 def _parse_generic_secret_key_packet(self, data):
561 offset = self._parse_generic_public_key_packet(data=data)
562 string_to_key_usage = data[offset]
564 if string_to_key_usage in [255, 254]:
565 self['symmetric-encryption-algorithm'] = (
566 self._symmetric_key_algorithms[data[offset]])
568 offset += self._parse_string_to_key_specifier(data=data[offset:])
570 self['symmetric-encryption-algorithm'] = (
571 self._symmetric_key_algorithms[string_to_key_usage])
572 if string_to_key_usage:
573 block_size_bits = self._cipher_block_size.get(
574 self['symmetric-encryption-algorithm'], None)
575 if block_size_bits % 8:
576 raise NotImplementedError(
577 ('{}-bit block size for {} is not an integer number of bytes'
579 block_size_bits, self['symmetric-encryption-algorithm']))
580 block_size = block_size_bits // 8
582 raise NotImplementedError(
583 'unknown block size for {}'.format(
584 self['symmetric-encryption-algorithm']))
585 self['initial-vector'] = data[offset: offset + block_size]
587 ciphertext = data[offset:]
588 offset += len(ciphertext)
589 decrypted_data = self.decrypt_symmetric_encryption(data=ciphertext)
591 decrypted_data = data[offset:key_end]
592 if string_to_key_usage in [0, 255]:
594 elif string_to_key_usage == 254:
598 secret_key = decrypted_data[:key_end]
600 secret_key_checksum = decrypted_data[key_end:]
602 calculated_checksum = sum(secret_key) % 65536
604 checksum_hash = _hashlib.sha1()
605 checksum_hash.update(secret_key)
606 calculated_checksum = checksum_hash.digest()
607 if secret_key_checksum != calculated_checksum:
609 'corrupt secret key (checksum {} != expected {})'.format(
610 secret_key_checksum, calculated_checksum))
611 self['secret-key'] = secret_key
613 def _parse_signature_subpackets(self, data):
615 while offset < len(data):
616 o, subpacket = self._parse_signature_subpacket(data=data[offset:])
620 def _parse_signature_subpacket(self, data):
626 elif first >= 192 and first < 255:
627 second = data[offset]
629 length = ((first - 192) << 8) + second + 192
631 length = _struct.unpack(
632 '>I', data[offset: offset + 4])[0]
634 subpacket['type'] = self._signature_subpacket_types[data[offset]]
636 subpacket_data = data[offset: offset + length - 1]
637 offset += len(subpacket_data)
638 method_name = '_parse_{}_signature_subpacket'.format(
639 self._clean_type(type=subpacket['type']))
640 method = getattr(self, method_name, None)
642 raise NotImplementedError(
643 'cannot parse signature subpacket type {!r}'.format(
645 method(data=subpacket_data, subpacket=subpacket)
646 return (offset, subpacket)
648 def _parse_signature_packet(self, data):
649 self['signature-version'] = data[0]
651 if self['signature-version'] != 4:
652 raise NotImplementedError(
653 'signature packet version {}'.format(
654 self['signature-version']))
655 self['signature-type'] = self._signature_types[data[offset]]
657 self['public-key-algorithm'] = self._public_key_algorithms[
660 self['hash-algorithm'] = self._hash_algorithms[data[offset]]
662 hashed_count = _struct.unpack('>H', data[offset: offset + 2])[0]
664 self['hashed-subpackets'] = list(self._parse_signature_subpackets(
665 data[offset: offset + hashed_count]))
666 offset += hashed_count
667 unhashed_count = _struct.unpack('>H', data[offset: offset + 2])[0]
669 self['unhashed-subpackets'] = list(self._parse_signature_subpackets(
670 data=data[offset: offset + unhashed_count]))
671 offset += unhashed_count
672 self['signed-hash-word'] = data[offset: offset + 2]
674 self['signature'] = data[offset:]
676 def _parse_signature_creation_time_signature_subpacket(
677 self, data, subpacket):
678 subpacket['signature-creation-time'] = _struct.unpack('>I', data)[0]
680 def _parse_issuer_signature_subpacket(self, data, subpacket):
681 subpacket['issuer'] = ''.join('{:02x}'.format(byte) for byte in data)
683 def _parse_key_expiration_time_signature_subpacket(
684 self, data, subpacket):
685 subpacket['key-expiration-time'] = _struct.unpack('>I', data)[0]
687 def _parse_preferred_symmetric_algorithms_signature_subpacket(
688 self, data, subpacket):
689 subpacket['preferred-symmetric-algorithms'] = [
690 self._symmetric_key_algorithms[d] for d in data]
692 def _parse_preferred_hash_algorithms_signature_subpacket(
693 self, data, subpacket):
694 subpacket['preferred-hash-algorithms'] = [
695 self._hash_algorithms[d] for d in data]
697 def _parse_preferred_compression_algorithms_signature_subpacket(
698 self, data, subpacket):
699 subpacket['preferred-compression-algorithms'] = [
700 self._compression_algorithms[d] for d in data]
702 def _parse_key_server_preferences_signature_subpacket(
703 self, data, subpacket):
704 subpacket['key-server-preferences'] = set()
706 subpacket['key-server-preferences'].add('no-modify')
708 def _parse_primary_user_id_signature_subpacket(self, data, subpacket):
709 subpacket['primary-user-id'] = bool(data[0])
711 def _parse_key_flags_signature_subpacket(self, data, subpacket):
712 subpacket['key-flags'] = set()
714 subpacket['key-flags'].add('can certify')
716 subpacket['key-flags'].add('can sign')
718 subpacket['key-flags'].add('can encrypt communications')
720 subpacket['key-flags'].add('can encrypt storage')
722 subpacket['key-flags'].add('private split')
724 subpacket['key-flags'].add('can authenticate')
726 subpacket['key-flags'].add('private shared')
728 def _parse_features_signature_subpacket(self, data, subpacket):
729 subpacket['features'] = set()
731 subpacket['features'].add('modification detection')
733 def _parse_embedded_signature_signature_subpacket(self, data, subpacket):
734 subpacket['embedded'] = PGPPacket(key=self.key)
735 subpacket['embedded']._parse_signature_packet(data=data)
737 def _parse_user_id_packet(self, data):
738 self['user'] = str(data, 'utf-8')
741 method_name = '_serialize_{}'.format(self._clean_type())
742 method = getattr(self, method_name, None)
744 raise NotImplementedError(
745 'cannot serialize packet type {!r}'.format(self['type']))
747 self['length'] = len(body)
749 self._serialize_header(),
753 def _serialize_header(self):
756 type_code = self._reverse(self._packet_types, self['type'])
758 always_one * (1 << 7) |
759 new_format * (1 << 6) |
760 type_code * (1 << 2) |
763 length_bytes, length_type = self._old_format_packet_length_type[
765 length_format = '>{}'.format(length_type)
766 length_data = _struct.pack(length_format, self['length'])
773 def _serialize_multiprecision_integer(integer):
774 r"""Serialize RFC 4880's multipricision integers
776 >>> PGPPacket._serialize_multiprecision_integer(1)
778 >>> PGPPacket._serialize_multiprecision_integer(511)
781 bit_length = int(_math.log(integer, 2)) + 1
783 _struct.pack('>H', bit_length),
786 chunks.insert(1, bytes([integer & 0xff]))
787 integer = integer >> 8
788 return b''.join(chunks)
791 def _encode_string_to_key_count(cls, count):
792 r"""Encode RFC 4880's string-to-key count
794 >>> PGPPacket._encode_string_to_key_count(753664)
798 count = count >> cls._string_to_key_expbias
801 coded_count += 1 << 4
802 coded_count += count & 15
803 return bytes([coded_count])
805 def _serialize_string_to_key_specifier(self):
806 string_to_key_type = bytes([
808 self._string_to_key_types, self['string-to-key-type']),
810 chunks = [string_to_key_type]
811 if self['string-to-key-type'] == 'simple':
812 chunks.append(bytes([self._reverse(
813 self._hash_algorithms, self['string-to-key-hash-algorithm'])]))
814 elif self['string-to-key-type'] == 'salted':
815 chunks.append(bytes([self._reverse(
816 self._hash_algorithms, self['string-to-key-hash-algorithm'])]))
817 chunks.append(self['string-to-key-salt'])
818 elif self['string-to-key-type'] == 'iterated and salted':
819 chunks.append(bytes([self._reverse(
820 self._hash_algorithms, self['string-to-key-hash-algorithm'])]))
821 chunks.append(self['string-to-key-salt'])
822 chunks.append(self._encode_string_to_key_count(
823 count=self['string-to-key-count']))
825 raise NotImplementedError(
826 'string-to-key type {}'.format(self['string-to-key-type']))
828 return b''.join(chunks)
830 def _serialize_public_key_packet(self):
831 return self._serialize_generic_public_key_packet()
833 def _serialize_public_subkey_packet(self):
834 return self._serialize_generic_public_key_packet()
836 def _serialize_generic_public_key_packet(self):
837 key_version = bytes([self['key-version']])
838 chunks = [key_version]
839 if self['key-version'] != 4:
840 raise NotImplementedError(
841 'public (sub)key packet version {}'.format(
842 self['key-version']))
843 chunks.append(_struct.pack('>I', self['creation-time']))
844 chunks.append(bytes([self._reverse(
845 self._public_key_algorithms, self['public-key-algorithm'])]))
846 if self['public-key-algorithm'].startswith('rsa '):
847 chunks.append(self._serialize_multiprecision_integer(
848 self['public-modulus']))
849 chunks.append(self._serialize_multiprecision_integer(
850 self['public-exponent']))
851 elif self['public-key-algorithm'].startswith('dsa '):
852 chunks.append(self._serialize_multiprecision_integer(
854 chunks.append(self._serialize_multiprecision_integer(
855 self['group-order']))
856 chunks.append(self._serialize_multiprecision_integer(
857 self['group-generator']))
858 chunks.append(self._serialize_multiprecision_integer(
860 elif self['public-key-algorithm'].startswith('elgamal '):
861 chunks.append(self._serialize_multiprecision_integer(
863 chunks.append(self._serialize_multiprecision_integer(
864 self['group-generator']))
865 chunks.append(self._serialize_multiprecision_integer(
868 raise NotImplementedError(
869 'algorithm-specific key fields for {}'.format(
870 self['public-key-algorithm']))
871 return b''.join(chunks)
873 def _string_to_key(self, string, key_size):
876 '{}-bit key is not an integer number of bytes'.format(
878 key_size_bytes = key_size // 8
879 hash_name = self._hashlib_name[
880 self['string-to-key-hash-algorithm']]
881 string_hash = _hashlib.new(hash_name)
882 hashes = _math.ceil(key_size_bytes / string_hash.digest_size)
884 if self['string-to-key-type'] == 'simple':
885 update_bytes = string
886 elif self['string-to-key-type'] in [
888 'iterated and salted',
890 update_bytes = self['string-to-key-salt'] + string
891 if self['string-to-key-type'] == 'iterated and salted':
892 count = self['string-to-key-count']
893 if count < len(update_bytes):
894 count = len(update_bytes)
896 raise NotImplementedError(
897 'key calculation for string-to-key type {}'.format(
898 self['string-to-key-type']))
899 for padding in range(hashes):
900 string_hash = _hashlib.new(hash_name)
901 string_hash.update(padding * b'\x00')
902 if self['string-to-key-type'] in [
906 string_hash.update(update_bytes)
907 elif self['string-to-key-type'] == 'iterated and salted':
910 string_hash.update(update_bytes[:remaining])
911 remaining -= len(update_bytes)
912 key += string_hash.digest()
913 key = key[:key_size_bytes]
916 def decrypt_symmetric_encryption(self, data):
917 """Decrypt OpenPGP's Cipher Feedback mode"""
918 algorithm = self['symmetric-encryption-algorithm']
919 module = self._crypto_module[algorithm]
920 key_size = self._key_size[algorithm]
921 segment_size_bits = self._cipher_block_size[algorithm]
922 if segment_size_bits % 8:
923 raise NotImplementedError(
924 ('{}-bit segment size for {} is not an integer number of bytes'
925 ).format(segment_size_bits, algorithm))
926 segment_size_bytes = segment_size_bits // 8
927 padding = segment_size_bytes - len(data) % segment_size_bytes
929 data += b'\x00' * padding
930 if self.key and self.key._cache_passphrase and self.key._passphrase:
931 passphrase = self.key._passphrase
933 passphrase = _getpass.getpass(
934 'passphrase for {}: '.format(self['fingerprint'][-8:]))
935 passphrase = passphrase.encode('ascii')
936 if self.key and self.key._cache_passphrase:
937 self.key._passphrase = passphrase
938 key = self._string_to_key(string=passphrase, key_size=key_size)
941 mode=module.MODE_CFB,
942 IV=self['initial-vector'],
943 segment_size=segment_size_bits)
944 plaintext = cipher.decrypt(data)
946 plaintext = plaintext[:-padding]
950 class PGPKey (object):
951 """An OpenPGP key with public and private parts.
955 OpenPGP users may transfer public keys. The essential elements
956 of a transferable public key are as follows:
958 - One Public-Key packet
959 - Zero or more revocation signatures
960 - One or more User ID packets
961 - After each User ID packet, zero or more Signature packets
963 - Zero or more User Attribute packets
964 - After each User Attribute packet, zero or more Signature
965 packets (certifications)
966 - Zero or more Subkey packets
967 - After each Subkey packet, one Signature packet, plus
968 optionally a revocation
970 Secret keys have a similar packet stream [2]:
972 OpenPGP users may transfer secret keys. The format of a
973 transferable secret key is the same as a transferable public key
974 except that secret-key and secret-subkey packets are used
975 instead of the public key and public-subkey packets.
976 Implementations SHOULD include self-signatures on any user IDs
977 and subkeys, as this allows for a complete public key to be
978 automatically extracted from the transferable secret key.
979 Implementations MAY choose to omit the self-signatures,
980 especially if a transferable public key accompanies the
981 transferable secret key.
983 [1]: http://tools.ietf.org/search/rfc4880#section-11.1
984 [2]: http://tools.ietf.org/search/rfc4880#section-11.2
986 def __init__(self, fingerprint, cache_passphrase=False):
987 self.fingerprint = fingerprint
988 self._cache_passphrase = cache_passphrase
989 self._passphrase = None
990 self.public_packets = None
991 self.secret_packets = None
994 lines = ['key: {}'.format(self.fingerprint)]
995 if self.public_packets:
996 lines.append(' public:')
997 for packet in self.public_packets:
998 lines.extend(self._str_packet(packet=packet, prefix=' '))
999 if self.secret_packets:
1000 lines.append(' secret:')
1001 for packet in self.secret_packets:
1002 lines.extend(self._str_packet(packet=packet, prefix=' '))
1003 return '\n'.join(lines)
1005 def _str_packet(self, packet, prefix):
1006 lines = str(packet).split('\n')
1007 return [prefix + line for line in lines]
1009 def import_from_gpg(self):
1010 key_export = _get_stdout(
1011 ['gpg', '--export', self.fingerprint])
1012 self.public_packets = list(
1013 self._packets_from_bytes(data=key_export))
1014 if self.public_packets[0]['type'] != 'public-key packet':
1016 '{} does not start with a public-key packet'.format(
1018 key_secret_export = _get_stdout(
1019 ['gpg', '--export-secret-keys', self.fingerprint])
1020 self.secret_packets = list(
1021 self._packets_from_bytes(data=key_secret_export))
1022 if self.secret_packets[0]['type'] != 'secret-key packet':
1024 '{} does not start with a secret-key packet'.format(
1027 def _packets_from_bytes(self, data):
1029 while offset < len(data):
1030 packet = PGPPacket(key=self)
1031 offset += packet.from_bytes(data=data[offset:])
1034 def export_to_gpg(self):
1035 raise NotImplemetedError('export to gpg')
1037 def import_from_key(self, key):
1038 """Migrate the (sub)keys into this key"""
1042 def migrate(old_key, new_key, cache_passphrase=False):
1043 """Add the old key and sub-keys to the new key
1045 For example, to upgrade your master key, while preserving old
1046 signatures you'd made. You will lose signature *on* your old key
1047 though, since sub-keys can't be signed (I don't think).
1049 old_key = PGPKey(fingerprint=old_key, cache_passphrase=cache_passphrase)
1050 old_key.import_from_gpg()
1051 new_key = PGPKey(fingerprint=new_key, cache_passphrase=cache_passphrase)
1052 new_key.import_from_gpg()
1053 new_key.import_from_key(key=old_key)
1059 if __name__ == '__main__':
1062 old_key, new_key = _sys.argv[1:3]
1063 migrate(old_key=old_key, new_key=new_key, cache_passphrase=True)