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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
|
#!/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
import hashlib
import hmac
import json
import logging
import mailbox
import os
import shutil
from subprocess import call
from string import Template
from tempfile import NamedTemporaryFile
from xml.etree import ElementTree
try:
from urllib.parse import urlparse, parse_qs
from urllib.parse import ParseResult
from urllib.parse import quote
except ImportError:
from urlparse import urlparse, parse_qs
from urlparse import ParseResult
from urllib2 import quote
import requests
import dbus
from wormhole._wordlist import PGPWordList
from _dbus_bindings import BUS_DAEMON_NAME, BUS_DAEMON_PATH, BUS_DAEMON_IFACE
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk, Gdk, GLib
from .errors import NoBluezDbus, UnpoweredAdapter, NoAdapter
from .gpgmeh import fingerprint_from_keydata
from .gpgmeh import sign_keydata_and_encrypt
from .i18n import _
log = logging.getLogger(__name__)
def mac_generate(key, data):
mac = hmac.new(key, data, hashlib.sha256).hexdigest().upper()
log.info("MAC of %r is %r", data[:20], mac[:20])
# Arbitrary truncation to avoid a QR code size increase
return mac[:20]
def mac_verify(key, data, mac):
computed_mac = mac_generate(key, data)
result = hmac.compare_digest(mac.upper(), computed_mac.upper())
log.info("MAC of %r seems to be %r. Expected %r (%r)",
data[:20], computed_mac[:20], mac[:20], result)
return result
def _email_portal(to, subject=None, body=None, files=None):
# The following checks are to ensure Python 2 compatibility
if not hasattr(os, 'O_PATH'):
os.O_PATH = 2097152
if not hasattr(os, 'O_CLOEXEC'):
os.O_CLOEXEC = 524288
name = "org.freedesktop.portal.Desktop"
path = "/org/freedesktop/portal/desktop"
bus = dbus.SessionBus()
try:
proxy = bus.get_object(name, path)
except dbus.exceptions.DBusException:
log.debug("Desktop portal is not available")
return None
iface = "org.freedesktop.portal.Email"
email = dbus.Interface(proxy, iface)
# Apparently we are unable to get the parent window XID from the receive class.
# Until this is sorted out, we leave the parent window empty.
parent_window = ""
attrs = []
# Even if we don't close the file descriptor it should not be a problem because
# eventually at runtime it will be automatically closed.
# Designing this class we took the recipes one as reference
# https://gitlab.gnome.org/GNOME/recipes/blob/4afc9df6/src/gr-mail.c#L293
if files:
for file in files:
fd = os.open(file, os.O_PATH | os.O_CLOEXEC)
attrs.append(dbus.types.UnixFd(fd))
opts = {"subject": subject, "address": to, "body": body, "attachment_fds": attrs}
try:
ret = email.ComposeEmail(parent_window, opts)
return ret
except TypeError:
log.debug("Email portal is not available")
return None
def _email_mailto(to, subject=None, body=None, files=None):
url = "mailto:"
url += "\"{0}\"".format(to)
# Apparently we don't need to use urllib.parse.quote_plus
if subject:
url += "?subject={0}".format(subject)
if body:
if "?" in url:
url += "&body={0}".format(quote(body))
else:
url += "?body={0}".format(quote(body))
for file in files:
if "?" in url:
url += "&attach={0}".format(file)
else:
url += "?attach={0}".format(file)
try:
Gtk.show_uri(None, url, Gdk.CURRENT_TIME)
return True
except GLib.GError as e:
log.debug("mailto URI is probably not available: %s", e.message)
return None
def _email_file(to, from_=None, subject=None,
body=None,
ccs=None, bccs=None,
files=None, utf8=True):
"""Calls xdg-email with the appropriate options"""
cmd = ['xdg-email']
if utf8:
cmd += ['--utf8']
if subject:
cmd += ['--subject', subject]
if body:
cmd += ['--body', body]
for cc in ccs or []:
cmd += ['--cc', cc]
for bcc in bccs or []:
cmd += ['--bcc', bcc]
for file_ in files or []:
cmd += ['--attach', file_]
if not to:
log.error("email_file: We are seeing an empty 'to': %r", to)
cmd += [to]
log.info("Running %s", cmd)
retval = call(cmd)
return retval
def _using_flatpak():
"""Check if we are inside flatpak"""
return os.path.exists("/.flatpak-info")
def _fix_path_flatpak(files):
"""In Flatpak the only special path visible also from outside is /var/tmp/
To be able to use the files from the host we change the path to the absolute one.
This fix in the future may not be necessary because the portals should be able
to automatically handle it."""
part_1 = os.path.expanduser("~/.var/app/")
app_id = "org.gnome.Keysign"
part_2 = "cache/tmp/"
flatpak_path = os.path.join(part_1, app_id, part_2)
fixed_files = []
if files:
for file in files:
base = os.path.basename(file)
new_path = os.path.join(flatpak_path, base)
shutil.move(file, new_path)
fixed_files.append(new_path)
return fixed_files
def send_email(to, subject=None, body=None, files=None):
"""Tries to send the email using firstly the portal, then the xdg-email
and as a last attempt the mailto uri"""
if _using_flatpak():
files = _fix_path_flatpak(files)
if _email_portal(to, subject, body, files):
return
try:
_email_file(to=to, subject=subject, body=body, files=files)
return
except FileNotFoundError:
log.debug("xdg-email is not available")
if _email_mailto(to, subject, body, files):
return
log.error("An error occurred trying to compose the email")
SUBJECT = 'Your signed key $fingerprint'
BODY = '''Hi $uid,
I have just signed your key
$fingerprint
The certification is in an attachment encrypted to your key.
You can either drag the attachment into GNOME Keysign or
decrypt and import the attachment manually, e.g.
gpg --decrypt | gpg --import
Thanks for letting me sign your key!
And, if you can, send me copy of your key with the new certifications.
--
GNOME Keysign
'''
DIVIDER = '\n--------\nTranslated version below\n--------\n'
BODY_TRANSLATED = _('''Hi $uid,
I have just signed your key
$fingerprint
Thanks for letting me sign your key!
--
GNOME Keysign
''')
def sign_keydata_and_send(keydata, error_cb=None):
"""Creates, encrypts, and send signatures for each UID on the key
You are supposed to give OpenPGP data which will be passed
onto sign_keydata_and_encrypt.
For the resulting signatures, emails are created and
sent via send_email.
Return value: A tuple of a
NamedTemporaryFiles used for saving the signatures and the plaintext which got encrypted.
If you let the TemporaryFiles go out of scope they should get deleted.
But don't delete too early as the MUA needs to pick them up.
"""
log = logging.getLogger(__name__ + ':sign_keydata')
fingerprint = fingerprint_from_keydata(keydata)
# FIXME: We should rather use whatever GnuPG tells us
keyid = fingerprint[-8:]
# We list() the signatures, because we believe that it's more
# acceptable if all key operations are done before we go ahead
# and spawn an email client.
log.info("About to create signatures for key with fpr %r", fingerprint)
try:
keydata = keydata.encode()
except AttributeError:
log.debug("keydata is probably already a bytes type")
for uid, encrypted_key, plaintext in list(sign_keydata_and_encrypt(keydata, error_cb)):
log.info("Using UID: %r", uid)
# We expect uid.uid to be a consumable string
uid_str = uid.uid
ctx = {
'uid' : uid_str,
'fingerprint': fingerprint,
'keyid': keyid,
}
tmpfile = NamedTemporaryFile(prefix='gnome-keysign-',
suffix='.asc',
delete=True)
filename = tmpfile.name
log.info('Writing keydata to %s', filename)
tmpfile.write(encrypted_key)
# Interesting, sometimes it would not write the
# whole thing out, so we better flush here
tmpfile.flush()
# If we close the actual file descriptor to free
# resources. Calling tmpfile.close would get the file deleted.
tmpfile.file.close()
body = BODY
# If the primary language is not English we append the translation
if BODY != BODY_TRANSLATED:
body += DIVIDER + BODY_TRANSLATED
subject = Template(SUBJECT).safe_substitute(ctx)
body = Template(body).safe_substitute(ctx)
send_email(uid.email, subject, body, [filename])
yield tmpfile, plaintext
def format_fingerprint(fpr):
"""Formats a given fingerprint (160bit, so 20 characters) in the
GnuPG typical way
"""
s = ''
for i in range(10):
# output 4 chars
s += ''.join(fpr[4*i:4*i+4])
# add extra space between the block
if i == 4: s += '\n'
# except at the end
elif i < 9: s += ' '
return s
def parse_barcode(barcode_string):
"""Parses information contained in a barcode
It returns a dict with the parsed attributes.
We expect the dict to contain at least a 'fingerprint'
entry. Others might be added in the future.
"""
# The string, currently, is of the form
# openpgp4fpr:foobar?baz=qux#frag=val
# Which urlparse handles perfectly fine.
p = urlparse(barcode_string)
log.debug("Parsed %r into %r", barcode_string, p)
fpr = p.path
query = parse_qs(p.query)
fragments = parse_qs(p.fragment)
rest = {}
rest.update(query)
rest.update(fragments)
# We should probably ensure that we have only one
# item for each parameter and flatten them accordingly.
rest['fingerprint'] = fpr
log.debug('Parsed barcode into %r', rest)
return rest
FPR_PREFIX = "OPENPGP4FPR:"
def strip_fingerprint(input_string):
'''Strips a fingerprint of any whitespaces and returns
a clean version. It also drops the "OPENPGP4FPR:" prefix
from the scanned QR-encoded fingerprints'''
# The split removes the whitespaces in the string
cleaned = ''.join(input_string.split())
if cleaned.upper().startswith(FPR_PREFIX.upper()):
cleaned = cleaned[len(FPR_PREFIX):]
log.warning('Cleaned fingerprint to %s', cleaned)
return cleaned
def download_key_http(address, port):
netloc = "[%s]:%d" if ':' in address else "%s:%d"
url = ParseResult(
scheme='http',
# This seems to work well enough with both IPv6 and IPv4
netloc=netloc % (address, port),
path='/',
params='',
query='',
fragment='')
u = url.geturl()
log.debug("Starting HTTP request for %s", u)
data = requests.get(u, timeout=5).content
log.debug("finished downloading %d bytes", len(data))
return data
def encode_message(message):
"""Serialize a string to json object and encode it in utf-8"""
return json.dumps(message).encode("utf-8")
def decode_message(message):
"""deserialize a json returning a string"""
return json.loads(message.decode("utf-8"))
def is_code_complete(code, length=2):
if code[:1].isdigit():
wl = PGPWordList()
gc = wl.get_completions
words = code.split("-", 1)[-1]
return words in gc(words, length)
else:
return False
def fix_infobar(infobar):
# Work around https://bugzilla.gnome.org/show_bug.cgi?id=710888
# Taken from here https://phabricator.freedesktop.org/D1103#34aa2703
def make_sure_revealer_does_nothing(widget):
if not isinstance(widget, Gtk.Revealer):
return
widget.set_transition_type(Gtk.RevealerTransitionType.NONE)
infobar.forall(make_sure_revealer_does_nothing)
def get_local_bt_address():
"""Check if there is a powered on Bluetooth device and return his address.
This is a blocking method"""
available = False
bus_name = "org.bluez"
timeout = 2 # 2 seconds seems to be enough to start a bus service
bus = dbus.SystemBus()
try:
_start_bus(bus_name, timeout)
except dbus.exceptions.DBusException as e:
raise NoBluezDbus(e)
else:
available_bt = _get_available_bt()
for bt in available_bt:
adapter = dbus.Interface(bus.get_object("org.bluez", bt), "org.freedesktop.DBus.Properties")
power = adapter.Get("org.bluez.Adapter1", "Powered")
if power:
available = adapter.Get("org.bluez.Adapter1", "Address")
break
if len(available_bt) == 0:
# Not a single BT adapter available in the system
raise NoAdapter
elif not available:
# Every BT adapters are powered off
raise UnpoweredAdapter
return available
def _start_bus(bus_name, timeout, flags=0):
"""Manually start the bus, so we can set a custom timeout"""
bus = dbus.SystemBus()
bus.call_blocking(BUS_DAEMON_NAME, BUS_DAEMON_PATH,
BUS_DAEMON_IFACE,
'StartServiceByName',
'su', (bus_name, flags), timeout=timeout)
def _get_available_bt():
"""Returns the list of available Bluetooth"""
available_bt = []
bus_name = "org.bluez"
object_path = "/org/bluez"
bus = dbus.SystemBus()
obj = bus.get_object(bus_name, object_path)
iface = dbus.Interface(obj, 'org.freedesktop.DBus.Introspectable')
xml_string = iface.Introspect()
for child in ElementTree.fromstring(xml_string):
if child.tag == 'node':
bt = '/'.join((object_path, child.attrib['name']))
available_bt.append(bt)
return available_bt
def get_attachments(filename):
mbox = mailbox.mbox(filename)
attachments = []
for message in mbox:
# Check if there are attachments
if message.is_multipart():
for attach in message.get_payload()[1:]:
attachments.append(attach.get_payload(decode=True))
return attachments
|