1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
#!/usr/bin/env python
# Copyright 2016 Tobias Mueller <muelli@cryptobitch.de>
#
# This file is part of GNOME Keysign.
#
# GNOME Keysign is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# GNOME Keysign is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNOME Keysign. If not, see <http://www.gnu.org/licenses/>.
from __future__ import unicode_literals
from collections import namedtuple
from datetime import datetime
import logging
import warnings
log = logging.getLogger(__name__)
def to_valid_utf8_string(s, errors='replace', replacement='?'):
"""Takes a string and returns a valid utf8 encodable string
Not every Python string is utf-8 encodable.
This function replaces undecodable characters with a '?'
"""
try:
safe = s.encode('utf-8', errors=errors).decode('utf-8', errors=errors)
except UnicodeDecodeError:
# This is the Python 2 way...
safe = s.decode('utf-8', errors=errors).replace(u"\uFFFD", replacement)
return safe
def parse_uid(uid, errors='replace'):
"""Parses a GnuPG UID into it's name, comment, and email component
It converts them to strings with the errors paramenter controlling
how to deal with encoding problems.
"""
# remove the comment from UID (if it exists)
com_start = uid.find(b'(')
if com_start != -1:
com_end = uid.find(b')')
uid = uid[:com_start].strip() + uid[com_end+1:].strip()
# FIXME: Actually parse the comment...
comment = b""
comment = comment.decode('utf-8', errors)
# split into user's name and email
tokens = uid.split(b'<')
name = tokens[0].strip()
name = name.decode('utf-8', errors)
email = b'unknown'
if len(tokens) > 1:
log.debug("Parsing tokens: %r", tokens)
email = tokens[1].replace(b'>',b'').strip()
email = email.decode('utf-8', errors)
log.debug("Parsed %r to name (%d): %r", uid, len(name), name)
return (name, comment, email)
def parse_expiry(value):
"""Takes either a string, an epoch, or a datetime and converts
it to a datetime.
If the string is empty (or otherwise evaluates to False)
then this function returns None, meaning that no expiry has been set.
An edge case is the epoch value "0".
"""
if not value:
expiry = None
else:
try:
expiry = datetime.fromtimestamp(int(value))
except TypeError:
expiry = value
return expiry
class Key(namedtuple("Key", ["expiry", "fingerprint", "uidslist"])):
"Represents an OpenPGP Key to extent we care about"
log = logging.getLogger(__name__)
def __new__(cls, expiry, fingerprint, uidslist,
*args, **kwargs):
exp_date = parse_expiry(expiry)
self = super(Key, cls).__new__(cls, exp_date, fingerprint, uidslist)
return self
def __format__(self, arg):
s = "{fingerprint}\r\n"
s += '\r\n'.join((" {}".format(uid) for uid in self.uidslist))
# This is what original output looks like:
# pub [unknown] 3072R/1BF98D6D 1336669781 [expiry: 2017-05-09 19:09:41]
# Fingerprint = FF52 DA33 C025 B1E0 B910 92FC 1C34 19BF 1BF9 8D6D
# uid 1 [unknown] Tobias Mueller <tobias.mueller2@mail.dcu.ie>
# uid 2 [unknown] Tobias Mueller <4tmuelle@informatik.uni-hamburg.de>
# sub 3072R/3B76E8B3 1336669781 [expiry: 2017-05-09 19:09:41]
return s.format(**self._asdict())
@property
def fpr(self):
"Legacy compatibility, use fingerprint instead"
warnings.warn("Legacy fpr, use the fingerprint property",
DeprecationWarning)
return self.fingerprint
@classmethod
def from_monkeysign(cls, key):
"Creates a new Key from an existing monkeysign key"
log.debug("From mks: %r", key)
uids = [UID.from_monkeysign(uid) for uid in key.uidslist]
expiry = parse_expiry(key.expiry)
fingerprint = key.fpr
return cls(expiry, fingerprint, uids)
@classmethod
def from_gpgme(cls, key):
"Creates a new Key from an existing gpgme key"
uids = [UID.from_gpgme(uid) for uid in key.uids]
expiry = parse_expiry(key.subkeys[0].expires)
fingerprint = key.fpr
return cls(expiry, fingerprint, uids)
class UID(namedtuple("UID", "expiry uid name comment email")):
"Represents an OpenPGP UID - at least to the extent we care about it"
@classmethod
def from_monkeysign(cls, uid):
"Creates a new UID from a monkeysign key"
# We expect to get raw bytes.
# While RFC4880 demands UTF-8 encoded data,
# real-life has produced non UTF-8 keys...
rawuid = to_valid_utf8_string(uid.uid).encode('utf-8')
log.debug("UidStr (%d): %r", len(rawuid), rawuid)
name, comment, email = parse_uid(rawuid)
expiry = parse_expiry(uid.expire)
return cls(expiry, rawuid.decode('utf-8'),
name, comment, email)
@classmethod
def from_gpgme(cls, uid):
"Creates a new UID from a gpgme UID"
# Weird. I would expect the uid to be raw bytes,
# because how would gpgme know what encoding to apply?
# Also, you can have invalid encodings.
# Turns out, that Python strings can be encoded according to PEP 383
# which basically encodes invalid bytes as 0xDC80 + byte.
# That's the "surrogateescape" error handler available in Python 3.
# Here, we don't care about that, though. We are in the user facing
# abstraction for a UID. As such, we ensure that it can be rendered.
# So we take the string we get from gpgme and try to convert it to
# to utf-8 bytes.
log.debug("UID from gpgme: %r", uid.uid)
rawuid = to_valid_utf8_string(uid.uid)
name = to_valid_utf8_string(uid.name)
comment = '' # FIXME: uid.comment
email = to_valid_utf8_string(uid.email)
expiry = None # FIXME: Maybe UIDs don't expire themselves but via the binding signature
return cls(expiry, rawuid, name, comment, email)
|
