To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 678
- compare with another revision
- download diff
- download tarball
- view history from revision 678
- Committer: Teddy Hogeborn
- Date: 2014-03-28 22:32:21 UTC
- Revision ID: teddy@recompile.se-20140328223221-w579qlvlex5if3dn
Fix location and format of signing key file.
* debian/upstream/signing-key.asc: Added.
* debian/upstream-signing-key.pgp: Removed.
* debian/upstream/signing-key.asc: Added.
* debian/upstream-signing-key.pgp: Removed.
- files added:
- initramfs-tools-hook-conf
- files removed:
- bugs.xml
- debian/tests
- dracut-module
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python3 -bI
2
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
3
#
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8 -*-
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
#
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
#
12
#
13
13
# Everything else is
14
# Copyright © 2008-2019 Teddy Hogeborn
15
# Copyright © 2008-2019 Björn Påhlsson
16
#
17
# This file is part of Mandos.
18
#
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
16
#
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
23
21
#
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27
25
# GNU General Public License for more details.
28
#
26
#
29
27
# You should have received a copy of the GNU General Public License
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
31
#
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
#
32
31
# Contact the authors at <mandos@recompile.se>.
33
#
32
#
34
33
35
34
from __future__ import (division, absolute_import, print_function,
36
35
unicode_literals)
37
36
38
try:
39
from future_builtins import *
40
except ImportError:
41
pass
37
from future_builtins import *
42
38
43
try:
44
import SocketServer as socketserver
45
except ImportError:
46
import socketserver
39
import SocketServer as socketserver
47
40
import socket
48
41
import argparse
49
42
import datetime
50
43
import errno
51
try:
52
import ConfigParser as configparser
53
except ImportError:
54
import configparser
44
import gnutls.crypto
45
import gnutls.connection
46
import gnutls.errors
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
55
51
import sys
56
52
import re
57
53
import os
66
62
import struct
67
63
import fcntl
68
64
import functools
69
try:
70
import cPickle as pickle
71
except ImportError:
72
import pickle
65
import cPickle as pickle
73
66
import multiprocessing
74
67
import types
75
68
import binascii
76
69
import tempfile
77
70
import itertools
78
71
import collections
79
import codecs
80
import unittest
81
72
82
73
import dbus
83
74
import dbus.service
84
import gi
85
from gi.repository import GLib
75
import gobject
76
import avahi
86
77
from dbus.mainloop.glib import DBusGMainLoop
87
78
import ctypes
88
79
import ctypes.util
89
80
import xml.dom.minidom
90
81
import inspect
91
82
92
if sys.version_info.major == 2:
93
__metaclass__ = type
94
str = unicode
95
96
# Show warnings by default
97
if not sys.warnoptions:
98
import warnings
99
warnings.simplefilter("default")
100
101
# Try to find the value of SO_BINDTODEVICE:
102
83
try:
103
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
104
# newer, and it is also the most natural place for it:
105
84
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
106
85
except AttributeError:
107
86
try:
108
# This is where SO_BINDTODEVICE was up to and including Python
109
# 2.6, and also 3.2:
110
87
from IN import SO_BINDTODEVICE
111
88
except ImportError:
112
# In Python 2.7 it seems to have been removed entirely.
113
# Try running the C preprocessor:
114
try:
115
cc = subprocess.Popen(["cc", "--language=c", "-E",
116
"/dev/stdin"],
117
stdin=subprocess.PIPE,
118
stdout=subprocess.PIPE)
119
stdout = cc.communicate(
120
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
121
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
122
except (OSError, ValueError, IndexError):
123
# No value found
124
SO_BINDTODEVICE = None
125
126
if sys.version_info < (3, 2):
127
configparser.Configparser = configparser.SafeConfigParser
128
129
version = "1.8.9"
89
SO_BINDTODEVICE = None
90
91
version = "1.6.4"
130
92
stored_state_file = "clients.pickle"
131
93
132
94
logger = logging.getLogger()
133
logging.captureWarnings(True) # Show warnings via the logging system
134
95
syslogger = None
135
96
136
97
try:
137
if_nametoindex = ctypes.cdll.LoadLibrary(
138
ctypes.util.find_library("c")).if_nametoindex
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
100
.if_nametoindex)
139
101
except (OSError, AttributeError):
140
141
102
def if_nametoindex(interface):
142
103
"Get an interface index the hard way, i.e. using fcntl()"
143
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
144
105
with contextlib.closing(socket.socket()) as s:
145
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
146
struct.pack(b"16s16x", interface))
147
interface_index = struct.unpack("I", ifreq[16:20])[0]
107
struct.pack(str("16s16x"),
108
interface))
109
interface_index = struct.unpack(str("I"),
110
ifreq[16:20])[0]
148
111
return interface_index
149
112
150
113
151
def copy_function(func):
152
"""Make a copy of a function"""
153
if sys.version_info.major == 2:
154
return types.FunctionType(func.func_code,
155
func.func_globals,
156
func.func_name,
157
func.func_defaults,
158
func.func_closure)
159
else:
160
return types.FunctionType(func.__code__,
161
func.__globals__,
162
func.__name__,
163
func.__defaults__,
164
func.__closure__)
165
166
167
114
def initlogger(debug, level=logging.WARNING):
168
115
"""init logger and add loglevel"""
169
170
global syslogger
171
syslogger = (logging.handlers.SysLogHandler(
172
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
173
address="/dev/log"))
116
117
syslogger = (logging.handlers.SysLogHandler
118
(facility =
119
logging.handlers.SysLogHandler.LOG_DAEMON,
120
address = str("/dev/log")))
174
121
syslogger.setFormatter(logging.Formatter
175
122
('Mandos [%(process)d]: %(levelname)s:'
176
123
' %(message)s'))
177
124
logger.addHandler(syslogger)
178
125
179
126
if debug:
180
127
console = logging.StreamHandler()
181
128
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
191
138
pass
192
139
193
140
194
class PGPEngine:
141
class PGPEngine(object):
195
142
"""A simple class for OpenPGP symmetric encryption & decryption"""
196
197
143
def __init__(self):
198
144
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
199
self.gpg = "gpg"
200
try:
201
output = subprocess.check_output(["gpgconf"])
202
for line in output.splitlines():
203
name, text, path = line.split(b":")
204
if name == b"gpg":
205
self.gpg = path
206
break
207
except OSError as e:
208
if e.errno != errno.ENOENT:
209
raise
210
145
self.gnupgargs = ['--batch',
211
'--homedir', self.tempdir,
146
'--home', self.tempdir,
212
147
'--force-mdc',
213
'--quiet']
214
# Only GPG version 1 has the --no-use-agent option.
215
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
216
self.gnupgargs.append("--no-use-agent")
217
148
'--quiet',
149
'--no-use-agent']
150
218
151
def __enter__(self):
219
152
return self
220
153
221
154
def __exit__(self, exc_type, exc_value, traceback):
222
155
self._cleanup()
223
156
return False
224
157
225
158
def __del__(self):
226
159
self._cleanup()
227
160
228
161
def _cleanup(self):
229
162
if self.tempdir is not None:
230
163
# Delete contents of tempdir
231
164
for root, dirs, files in os.walk(self.tempdir,
232
topdown=False):
165
topdown = False):
233
166
for filename in files:
234
167
os.remove(os.path.join(root, filename))
235
168
for dirname in dirs:
237
170
# Remove tempdir
238
171
os.rmdir(self.tempdir)
239
172
self.tempdir = None
240
173
241
174
def password_encode(self, password):
242
175
# Passphrase can not be empty and can not contain newlines or
243
176
# NUL bytes. So we prefix it and hex encode it.
248
181
.replace(b"\n", b"\\n")
249
182
.replace(b"\0", b"\\x00"))
250
183
return encoded
251
184
252
185
def encrypt(self, data, password):
253
186
passphrase = self.password_encode(password)
254
with tempfile.NamedTemporaryFile(
255
dir=self.tempdir) as passfile:
187
with tempfile.NamedTemporaryFile(dir=self.tempdir
188
) as passfile:
256
189
passfile.write(passphrase)
257
190
passfile.flush()
258
proc = subprocess.Popen([self.gpg, '--symmetric',
191
proc = subprocess.Popen(['gpg', '--symmetric',
259
192
'--passphrase-file',
260
193
passfile.name]
261
194
+ self.gnupgargs,
262
stdin=subprocess.PIPE,
263
stdout=subprocess.PIPE,
264
stderr=subprocess.PIPE)
265
ciphertext, err = proc.communicate(input=data)
195
stdin = subprocess.PIPE,
196
stdout = subprocess.PIPE,
197
stderr = subprocess.PIPE)
198
ciphertext, err = proc.communicate(input = data)
266
199
if proc.returncode != 0:
267
200
raise PGPError(err)
268
201
return ciphertext
269
202
270
203
def decrypt(self, data, password):
271
204
passphrase = self.password_encode(password)
272
with tempfile.NamedTemporaryFile(
273
dir=self.tempdir) as passfile:
205
with tempfile.NamedTemporaryFile(dir = self.tempdir
206
) as passfile:
274
207
passfile.write(passphrase)
275
208
passfile.flush()
276
proc = subprocess.Popen([self.gpg, '--decrypt',
209
proc = subprocess.Popen(['gpg', '--decrypt',
277
210
'--passphrase-file',
278
211
passfile.name]
279
212
+ self.gnupgargs,
280
stdin=subprocess.PIPE,
281
stdout=subprocess.PIPE,
282
stderr=subprocess.PIPE)
283
decrypted_plaintext, err = proc.communicate(input=data)
213
stdin = subprocess.PIPE,
214
stdout = subprocess.PIPE,
215
stderr = subprocess.PIPE)
216
decrypted_plaintext, err = proc.communicate(input
217
= data)
284
218
if proc.returncode != 0:
285
219
raise PGPError(err)
286
220
return decrypted_plaintext
287
221
288
222
289
# Pretend that we have an Avahi module
290
class avahi:
291
"""This isn't so much a class as it is a module-like namespace."""
292
IF_UNSPEC = -1 # avahi-common/address.h
293
PROTO_UNSPEC = -1 # avahi-common/address.h
294
PROTO_INET = 0 # avahi-common/address.h
295
PROTO_INET6 = 1 # avahi-common/address.h
296
DBUS_NAME = "org.freedesktop.Avahi"
297
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
298
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
299
DBUS_PATH_SERVER = "/"
300
301
@staticmethod
302
def string_array_to_txt_array(t):
303
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
304
for s in t), signature="ay")
305
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
306
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
307
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
308
SERVER_INVALID = 0 # avahi-common/defs.h
309
SERVER_REGISTERING = 1 # avahi-common/defs.h
310
SERVER_RUNNING = 2 # avahi-common/defs.h
311
SERVER_COLLISION = 3 # avahi-common/defs.h
312
SERVER_FAILURE = 4 # avahi-common/defs.h
313
314
315
223
class AvahiError(Exception):
316
224
def __init__(self, value, *args, **kwargs):
317
225
self.value = value
318
return super(AvahiError, self).__init__(value, *args,
319
**kwargs)
320
226
super(AvahiError, self).__init__(value, *args, **kwargs)
227
def __unicode__(self):
228
return unicode(repr(self.value))
321
229
322
230
class AvahiServiceError(AvahiError):
323
231
pass
324
232
325
326
233
class AvahiGroupError(AvahiError):
327
234
pass
328
235
329
236
330
class AvahiService:
237
class AvahiService(object):
331
238
"""An Avahi (Zeroconf) service.
332
239
333
240
Attributes:
334
241
interface: integer; avahi.IF_UNSPEC or an interface index.
335
242
Used to optionally bind to the specified interface.
347
254
server: D-Bus Server
348
255
bus: dbus.SystemBus()
349
256
"""
350
351
def __init__(self,
352
interface=avahi.IF_UNSPEC,
353
name=None,
354
servicetype=None,
355
port=None,
356
TXT=None,
357
domain="",
358
host="",
359
max_renames=32768,
360
protocol=avahi.PROTO_UNSPEC,
361
bus=None):
257
258
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
259
servicetype = None, port = None, TXT = None,
260
domain = "", host = "", max_renames = 32768,
261
protocol = avahi.PROTO_UNSPEC, bus = None):
362
262
self.interface = interface
363
263
self.name = name
364
264
self.type = servicetype
373
273
self.server = None
374
274
self.bus = bus
375
275
self.entry_group_state_changed_match = None
376
377
def rename(self, remove=True):
276
277
def rename(self):
378
278
"""Derived from the Avahi example code"""
379
279
if self.rename_count >= self.max_renames:
380
280
logger.critical("No suitable Zeroconf service name found"
381
281
" after %i retries, exiting.",
382
282
self.rename_count)
383
283
raise AvahiServiceError("Too many renames")
384
self.name = str(
385
self.server.GetAlternativeServiceName(self.name))
386
self.rename_count += 1
284
self.name = unicode(self.server
285
.GetAlternativeServiceName(self.name))
387
286
logger.info("Changing Zeroconf service name to %r ...",
388
287
self.name)
389
if remove:
390
self.remove()
288
self.remove()
391
289
try:
392
290
self.add()
393
291
except dbus.exceptions.DBusException as error:
394
if (error.get_dbus_name()
395
== "org.freedesktop.Avahi.CollisionError"):
396
logger.info("Local Zeroconf service name collision.")
397
return self.rename(remove=False)
398
else:
399
logger.critical("D-Bus Exception", exc_info=error)
400
self.cleanup()
401
os._exit(1)
402
292
logger.critical("D-Bus Exception", exc_info=error)
293
self.cleanup()
294
os._exit(1)
295
self.rename_count += 1
296
403
297
def remove(self):
404
298
"""Derived from the Avahi example code"""
405
299
if self.entry_group_state_changed_match is not None:
407
301
self.entry_group_state_changed_match = None
408
302
if self.group is not None:
409
303
self.group.Reset()
410
304
411
305
def add(self):
412
306
"""Derived from the Avahi example code"""
413
307
self.remove()
430
324
dbus.UInt16(self.port),
431
325
avahi.string_array_to_txt_array(self.TXT))
432
326
self.group.Commit()
433
327
434
328
def entry_group_state_changed(self, state, error):
435
329
"""Derived from the Avahi example code"""
436
330
logger.debug("Avahi entry group state change: %i", state)
437
331
438
332
if state == avahi.ENTRY_GROUP_ESTABLISHED:
439
333
logger.debug("Zeroconf service established.")
440
334
elif state == avahi.ENTRY_GROUP_COLLISION:
442
336
self.rename()
443
337
elif state == avahi.ENTRY_GROUP_FAILURE:
444
338
logger.critical("Avahi: Error in group state changed %s",
445
str(error))
446
raise AvahiGroupError("State changed: {!s}".format(error))
447
339
unicode(error))
340
raise AvahiGroupError("State changed: {0!s}"
341
.format(error))
342
448
343
def cleanup(self):
449
344
"""Derived from the Avahi example code"""
450
345
if self.group is not None:
455
350
pass
456
351
self.group = None
457
352
self.remove()
458
353
459
354
def server_state_changed(self, state, error=None):
460
355
"""Derived from the Avahi example code"""
461
356
logger.debug("Avahi server state change: %i", state)
462
bad_states = {
463
avahi.SERVER_INVALID: "Zeroconf server invalid",
464
avahi.SERVER_REGISTERING: None,
465
avahi.SERVER_COLLISION: "Zeroconf server name collision",
466
avahi.SERVER_FAILURE: "Zeroconf server failure",
467
}
357
bad_states = { avahi.SERVER_INVALID:
358
"Zeroconf server invalid",
359
avahi.SERVER_REGISTERING: None,
360
avahi.SERVER_COLLISION:
361
"Zeroconf server name collision",
362
avahi.SERVER_FAILURE:
363
"Zeroconf server failure" }
468
364
if state in bad_states:
469
365
if bad_states[state] is not None:
470
366
if error is None:
473
369
logger.error(bad_states[state] + ": %r", error)
474
370
self.cleanup()
475
371
elif state == avahi.SERVER_RUNNING:
476
try:
477
self.add()
478
except dbus.exceptions.DBusException as error:
479
if (error.get_dbus_name()
480
== "org.freedesktop.Avahi.CollisionError"):
481
logger.info("Local Zeroconf service name"
482
" collision.")
483
return self.rename(remove=False)
484
else:
485
logger.critical("D-Bus Exception", exc_info=error)
486
self.cleanup()
487
os._exit(1)
372
self.add()
488
373
else:
489
374
if error is None:
490
375
logger.debug("Unknown state: %r", state)
491
376
else:
492
377
logger.debug("Unknown state: %r: %r", state, error)
493
378
494
379
def activate(self):
495
380
"""Derived from the Avahi example code"""
496
381
if self.server is None:
500
385
follow_name_owner_changes=True),
501
386
avahi.DBUS_INTERFACE_SERVER)
502
387
self.server.connect_to_signal("StateChanged",
503
self.server_state_changed)
388
self.server_state_changed)
504
389
self.server_state_changed(self.server.GetState())
505
390
506
391
507
392
class AvahiServiceToSyslog(AvahiService):
508
def rename(self, *args, **kwargs):
393
def rename(self):
509
394
"""Add the new name to the syslog messages"""
510
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
511
syslogger.setFormatter(logging.Formatter(
512
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
513
.format(self.name)))
395
ret = AvahiService.rename(self)
396
syslogger.setFormatter(logging.Formatter
397
('Mandos ({0}) [%(process)d]:'
398
' %(levelname)s: %(message)s'
399
.format(self.name)))
514
400
return ret
515
401
516
402
517
# Pretend that we have a GnuTLS module
518
class gnutls:
519
"""This isn't so much a class as it is a module-like namespace."""
520
521
library = ctypes.util.find_library("gnutls")
522
if library is None:
523
library = ctypes.util.find_library("gnutls-deb0")
524
_library = ctypes.cdll.LoadLibrary(library)
525
del library
526
527
# Unless otherwise indicated, the constants and types below are
528
# all from the gnutls/gnutls.h C header file.
529
530
# Constants
531
E_SUCCESS = 0
532
E_INTERRUPTED = -52
533
E_AGAIN = -28
534
CRT_OPENPGP = 2
535
CRT_RAWPK = 3
536
CLIENT = 2
537
SHUT_RDWR = 0
538
CRD_CERTIFICATE = 1
539
E_NO_CERTIFICATE_FOUND = -49
540
X509_FMT_DER = 0
541
NO_TICKETS = 1<<10
542
ENABLE_RAWPK = 1<<18
543
CTYPE_PEERS = 3
544
KEYID_USE_SHA256 = 1 # gnutls/x509.h
545
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
546
547
# Types
548
class session_int(ctypes.Structure):
549
_fields_ = []
550
session_t = ctypes.POINTER(session_int)
551
552
class certificate_credentials_st(ctypes.Structure):
553
_fields_ = []
554
certificate_credentials_t = ctypes.POINTER(
555
certificate_credentials_st)
556
certificate_type_t = ctypes.c_int
557
558
class datum_t(ctypes.Structure):
559
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
560
('size', ctypes.c_uint)]
561
562
class openpgp_crt_int(ctypes.Structure):
563
_fields_ = []
564
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
565
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
566
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
567
credentials_type_t = ctypes.c_int
568
transport_ptr_t = ctypes.c_void_p
569
close_request_t = ctypes.c_int
570
571
# Exceptions
572
class Error(Exception):
573
def __init__(self, message=None, code=None, args=()):
574
# Default usage is by a message string, but if a return
575
# code is passed, convert it to a string with
576
# gnutls.strerror()
577
self.code = code
578
if message is None and code is not None:
579
message = gnutls.strerror(code)
580
return super(gnutls.Error, self).__init__(
581
message, *args)
582
583
class CertificateSecurityError(Error):
584
pass
585
586
# Classes
587
class Credentials:
588
def __init__(self):
589
self._c_object = gnutls.certificate_credentials_t()
590
gnutls.certificate_allocate_credentials(
591
ctypes.byref(self._c_object))
592
self.type = gnutls.CRD_CERTIFICATE
593
594
def __del__(self):
595
gnutls.certificate_free_credentials(self._c_object)
596
597
class ClientSession:
598
def __init__(self, socket, credentials=None):
599
self._c_object = gnutls.session_t()
600
gnutls_flags = gnutls.CLIENT
601
if gnutls.check_version(b"3.5.6"):
602
gnutls_flags |= gnutls.NO_TICKETS
603
if gnutls.has_rawpk:
604
gnutls_flags |= gnutls.ENABLE_RAWPK
605
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
606
del gnutls_flags
607
gnutls.set_default_priority(self._c_object)
608
gnutls.transport_set_ptr(self._c_object, socket.fileno())
609
gnutls.handshake_set_private_extensions(self._c_object,
610
True)
611
self.socket = socket
612
if credentials is None:
613
credentials = gnutls.Credentials()
614
gnutls.credentials_set(self._c_object, credentials.type,
615
ctypes.cast(credentials._c_object,
616
ctypes.c_void_p))
617
self.credentials = credentials
618
619
def __del__(self):
620
gnutls.deinit(self._c_object)
621
622
def handshake(self):
623
return gnutls.handshake(self._c_object)
624
625
def send(self, data):
626
data = bytes(data)
627
data_len = len(data)
628
while data_len > 0:
629
data_len -= gnutls.record_send(self._c_object,
630
data[-data_len:],
631
data_len)
632
633
def bye(self):
634
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
635
636
# Error handling functions
637
def _error_code(result):
638
"""A function to raise exceptions on errors, suitable
639
for the 'restype' attribute on ctypes functions"""
640
if result >= 0:
641
return result
642
if result == gnutls.E_NO_CERTIFICATE_FOUND:
643
raise gnutls.CertificateSecurityError(code=result)
644
raise gnutls.Error(code=result)
645
646
def _retry_on_error(result, func, arguments):
647
"""A function to retry on some errors, suitable
648
for the 'errcheck' attribute on ctypes functions"""
649
while result < 0:
650
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
651
return _error_code(result)
652
result = func(*arguments)
653
return result
654
655
# Unless otherwise indicated, the function declarations below are
656
# all from the gnutls/gnutls.h C header file.
657
658
# Functions
659
priority_set_direct = _library.gnutls_priority_set_direct
660
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
661
ctypes.POINTER(ctypes.c_char_p)]
662
priority_set_direct.restype = _error_code
663
664
init = _library.gnutls_init
665
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
666
init.restype = _error_code
667
668
set_default_priority = _library.gnutls_set_default_priority
669
set_default_priority.argtypes = [session_t]
670
set_default_priority.restype = _error_code
671
672
record_send = _library.gnutls_record_send
673
record_send.argtypes = [session_t, ctypes.c_void_p,
674
ctypes.c_size_t]
675
record_send.restype = ctypes.c_ssize_t
676
record_send.errcheck = _retry_on_error
677
678
certificate_allocate_credentials = (
679
_library.gnutls_certificate_allocate_credentials)
680
certificate_allocate_credentials.argtypes = [
681
ctypes.POINTER(certificate_credentials_t)]
682
certificate_allocate_credentials.restype = _error_code
683
684
certificate_free_credentials = (
685
_library.gnutls_certificate_free_credentials)
686
certificate_free_credentials.argtypes = [
687
certificate_credentials_t]
688
certificate_free_credentials.restype = None
689
690
handshake_set_private_extensions = (
691
_library.gnutls_handshake_set_private_extensions)
692
handshake_set_private_extensions.argtypes = [session_t,
693
ctypes.c_int]
694
handshake_set_private_extensions.restype = None
695
696
credentials_set = _library.gnutls_credentials_set
697
credentials_set.argtypes = [session_t, credentials_type_t,
698
ctypes.c_void_p]
699
credentials_set.restype = _error_code
700
701
strerror = _library.gnutls_strerror
702
strerror.argtypes = [ctypes.c_int]
703
strerror.restype = ctypes.c_char_p
704
705
certificate_type_get = _library.gnutls_certificate_type_get
706
certificate_type_get.argtypes = [session_t]
707
certificate_type_get.restype = _error_code
708
709
certificate_get_peers = _library.gnutls_certificate_get_peers
710
certificate_get_peers.argtypes = [session_t,
711
ctypes.POINTER(ctypes.c_uint)]
712
certificate_get_peers.restype = ctypes.POINTER(datum_t)
713
714
global_set_log_level = _library.gnutls_global_set_log_level
715
global_set_log_level.argtypes = [ctypes.c_int]
716
global_set_log_level.restype = None
717
718
global_set_log_function = _library.gnutls_global_set_log_function
719
global_set_log_function.argtypes = [log_func]
720
global_set_log_function.restype = None
721
722
deinit = _library.gnutls_deinit
723
deinit.argtypes = [session_t]
724
deinit.restype = None
725
726
handshake = _library.gnutls_handshake
727
handshake.argtypes = [session_t]
728
handshake.restype = _error_code
729
handshake.errcheck = _retry_on_error
730
731
transport_set_ptr = _library.gnutls_transport_set_ptr
732
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
733
transport_set_ptr.restype = None
734
735
bye = _library.gnutls_bye
736
bye.argtypes = [session_t, close_request_t]
737
bye.restype = _error_code
738
bye.errcheck = _retry_on_error
739
740
check_version = _library.gnutls_check_version
741
check_version.argtypes = [ctypes.c_char_p]
742
check_version.restype = ctypes.c_char_p
743
744
_need_version = b"3.3.0"
745
if check_version(_need_version) is None:
746
raise self.Error("Needs GnuTLS {} or later"
747
.format(_need_version))
748
749
_tls_rawpk_version = b"3.6.6"
750
has_rawpk = bool(check_version(_tls_rawpk_version))
751
752
if has_rawpk:
753
# Types
754
class pubkey_st(ctypes.Structure):
755
_fields = []
756
pubkey_t = ctypes.POINTER(pubkey_st)
757
758
x509_crt_fmt_t = ctypes.c_int
759
760
# All the function declarations below are from gnutls/abstract.h
761
pubkey_init = _library.gnutls_pubkey_init
762
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
763
pubkey_init.restype = _error_code
764
765
pubkey_import = _library.gnutls_pubkey_import
766
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
767
x509_crt_fmt_t]
768
pubkey_import.restype = _error_code
769
770
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
771
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
772
ctypes.POINTER(ctypes.c_ubyte),
773
ctypes.POINTER(ctypes.c_size_t)]
774
pubkey_get_key_id.restype = _error_code
775
776
pubkey_deinit = _library.gnutls_pubkey_deinit
777
pubkey_deinit.argtypes = [pubkey_t]
778
pubkey_deinit.restype = None
779
else:
780
# All the function declarations below are from gnutls/openpgp.h
781
782
openpgp_crt_init = _library.gnutls_openpgp_crt_init
783
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
784
openpgp_crt_init.restype = _error_code
785
786
openpgp_crt_import = _library.gnutls_openpgp_crt_import
787
openpgp_crt_import.argtypes = [openpgp_crt_t,
788
ctypes.POINTER(datum_t),
789
openpgp_crt_fmt_t]
790
openpgp_crt_import.restype = _error_code
791
792
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
793
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
794
ctypes.POINTER(ctypes.c_uint)]
795
openpgp_crt_verify_self.restype = _error_code
796
797
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
798
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
799
openpgp_crt_deinit.restype = None
800
801
openpgp_crt_get_fingerprint = (
802
_library.gnutls_openpgp_crt_get_fingerprint)
803
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
804
ctypes.c_void_p,
805
ctypes.POINTER(
806
ctypes.c_size_t)]
807
openpgp_crt_get_fingerprint.restype = _error_code
808
809
if check_version(b"3.6.4"):
810
certificate_type_get2 = _library.gnutls_certificate_type_get2
811
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
812
certificate_type_get2.restype = _error_code
813
814
# Remove non-public functions
815
del _error_code, _retry_on_error
816
817
818
def call_pipe(connection, # : multiprocessing.Connection
819
func, *args, **kwargs):
820
"""This function is meant to be called by multiprocessing.Process
821
822
This function runs func(*args, **kwargs), and writes the resulting
823
return value on the provided multiprocessing.Connection.
824
"""
825
connection.send(func(*args, **kwargs))
826
connection.close()
827
828
829
class Client:
403
def timedelta_to_milliseconds(td):
404
"Convert a datetime.timedelta() to milliseconds"
405
return ((td.days * 24 * 60 * 60 * 1000)
406
+ (td.seconds * 1000)
407
+ (td.microseconds // 1000))
408
409
410
class Client(object):
830
411
"""A representation of a client host served by this server.
831
412
832
413
Attributes:
833
414
approved: bool(); 'None' if not yet approved/disapproved
834
415
approval_delay: datetime.timedelta(); Time to wait for approval
835
416
approval_duration: datetime.timedelta(); Duration of one approval
836
checker: multiprocessing.Process(); a running checker process used
837
to see if the client lives. 'None' if no process is
838
running.
839
checker_callback_tag: a GLib event source tag, or None
417
checker: subprocess.Popen(); a running checker process used
418
to see if the client lives.
419
'None' if no process is running.
420
checker_callback_tag: a gobject event source tag, or None
840
421
checker_command: string; External command which is run to check
841
422
if client lives. %() expansions are done at
842
423
runtime with vars(self) as dict, so that for
843
424
instance %(name)s can be used in the command.
844
checker_initiator_tag: a GLib event source tag, or None
425
checker_initiator_tag: a gobject event source tag, or None
845
426
created: datetime.datetime(); (UTC) object creation
846
427
client_structure: Object describing what attributes a client has
847
428
and is used for storing the client at exit
848
429
current_checker_command: string; current running checker_command
849
disable_initiator_tag: a GLib event source tag, or None
430
disable_initiator_tag: a gobject event source tag, or None
850
431
enabled: bool()
851
432
fingerprint: string (40 or 32 hexadecimal digits); used to
852
uniquely identify an OpenPGP client
853
key_id: string (64 hexadecimal digits); used to uniquely identify
854
a client using raw public keys
433
uniquely identify the client
855
434
host: string; available for use by the checker command
856
435
interval: datetime.timedelta(); How often to start a new checker
857
436
last_approval_request: datetime.datetime(); (UTC) or None
859
438
last_checker_status: integer between 0 and 255 reflecting exit
860
439
status of last checker. -1 reflects crashed
861
440
checker, -2 means no checker completed yet.
862
last_checker_signal: The signal which killed the last checker, if
863
last_checker_status is -1
864
441
last_enabled: datetime.datetime(); (UTC) or None
865
442
name: string; from the config file, used in log messages and
866
443
D-Bus identifiers
873
450
disabled, or None
874
451
server_settings: The server_settings dict from main()
875
452
"""
876
453
877
454
runtime_expansions = ("approval_delay", "approval_duration",
878
"created", "enabled", "expires", "key_id",
455
"created", "enabled", "expires",
879
456
"fingerprint", "host", "interval",
880
457
"last_approval_request", "last_checked_ok",
881
458
"last_enabled", "name", "timeout")
882
client_defaults = {
883
"timeout": "PT5M",
884
"extended_timeout": "PT15M",
885
"interval": "PT2M",
886
"checker": "fping -q -- %%(host)s",
887
"host": "",
888
"approval_delay": "PT0S",
889
"approval_duration": "PT1S",
890
"approved_by_default": "True",
891
"enabled": "True",
892
}
893
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
461
"interval": "PT2M",
462
"checker": "fping -q -- %%(host)s",
463
"host": "",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
466
"approved_by_default": "True",
467
"enabled": "True",
468
}
469
470
def timeout_milliseconds(self):
471
"Return the 'timeout' attribute in milliseconds"
472
return timedelta_to_milliseconds(self.timeout)
473
474
def extended_timeout_milliseconds(self):
475
"Return the 'extended_timeout' attribute in milliseconds"
476
return timedelta_to_milliseconds(self.extended_timeout)
477
478
def interval_milliseconds(self):
479
"Return the 'interval' attribute in milliseconds"
480
return timedelta_to_milliseconds(self.interval)
481
482
def approval_delay_milliseconds(self):
483
return timedelta_to_milliseconds(self.approval_delay)
484
894
485
@staticmethod
895
486
def config_parser(config):
896
487
"""Construct a new dict of client settings of this form:
903
494
for client_name in config.sections():
904
495
section = dict(config.items(client_name))
905
496
client = settings[client_name] = {}
906
497
907
498
client["host"] = section["host"]
908
499
# Reformat values from string types to Python types
909
500
client["approved_by_default"] = config.getboolean(
910
501
client_name, "approved_by_default")
911
502
client["enabled"] = config.getboolean(client_name,
912
503
"enabled")
913
914
# Uppercase and remove spaces from key_id and fingerprint
915
# for later comparison purposes with return value from the
916
# key_id() and fingerprint() functions
917
client["key_id"] = (section.get("key_id", "").upper()
918
.replace(" ", ""))
504
919
505
client["fingerprint"] = (section["fingerprint"].upper()
920
506
.replace(" ", ""))
921
507
if "secret" in section:
922
client["secret"] = codecs.decode(section["secret"]
923
.encode("utf-8"),
924
"base64")
508
client["secret"] = section["secret"].decode("base64")
925
509
elif "secfile" in section:
926
510
with open(os.path.expanduser(os.path.expandvars
927
511
(section["secfile"])),
928
512
"rb") as secfile:
929
513
client["secret"] = secfile.read()
930
514
else:
931
raise TypeError("No secret or secfile for section {}"
515
raise TypeError("No secret or secfile for section {0}"
932
516
.format(section))
933
517
client["timeout"] = string_to_delta(section["timeout"])
934
518
client["extended_timeout"] = string_to_delta(
942
526
client["last_approval_request"] = None
943
527
client["last_checked_ok"] = None
944
528
client["last_checker_status"] = -2
945
529
946
530
return settings
947
948
def __init__(self, settings, name=None, server_settings=None):
531
532
def __init__(self, settings, name = None, server_settings=None):
949
533
self.name = name
950
534
if server_settings is None:
951
535
server_settings = {}
952
536
self.server_settings = server_settings
953
537
# adding all client settings
954
for setting, value in settings.items():
538
for setting, value in settings.iteritems():
955
539
setattr(self, setting, value)
956
540
957
541
if self.enabled:
958
542
if not hasattr(self, "last_enabled"):
959
543
self.last_enabled = datetime.datetime.utcnow()
963
547
else:
964
548
self.last_enabled = None
965
549
self.expires = None
966
550
967
551
logger.debug("Creating client %r", self.name)
968
logger.debug(" Key ID: %s", self.key_id)
552
# Uppercase and remove spaces from fingerprint for later
553
# comparison purposes with return value from the fingerprint()
554
# function
969
555
logger.debug(" Fingerprint: %s", self.fingerprint)
970
556
self.created = settings.get("created",
971
557
datetime.datetime.utcnow())
972
558
973
559
# attributes specific for this server instance
974
560
self.checker = None
975
561
self.checker_initiator_tag = None
978
564
self.current_checker_command = None
979
565
self.approved = None
980
566
self.approvals_pending = 0
981
self.changedstate = multiprocessing_manager.Condition(
982
multiprocessing_manager.Lock())
983
self.client_structure = [attr
984
for attr in self.__dict__.keys()
567
self.changedstate = (multiprocessing_manager
568
.Condition(multiprocessing_manager
569
.Lock()))
570
self.client_structure = [attr for attr in
571
self.__dict__.iterkeys()
985
572
if not attr.startswith("_")]
986
573
self.client_structure.append("client_structure")
987
988
for name, t in inspect.getmembers(
989
type(self), lambda obj: isinstance(obj, property)):
574
575
for name, t in inspect.getmembers(type(self),
576
lambda obj:
577
isinstance(obj,
578
property)):
990
579
if not name.startswith("_"):
991
580
self.client_structure.append(name)
992
581
993
582
# Send notice to process children that client state has changed
994
583
def send_changedstate(self):
995
584
with self.changedstate:
996
585
self.changedstate.notify_all()
997
586
998
587
def enable(self):
999
588
"""Start this client's checker and timeout hooks"""
1000
589
if getattr(self, "enabled", False):
1005
594
self.last_enabled = datetime.datetime.utcnow()
1006
595
self.init_checker()
1007
596
self.send_changedstate()
1008
597
1009
598
def disable(self, quiet=True):
1010
599
"""Disable this client."""
1011
600
if not getattr(self, "enabled", False):
1013
602
if not quiet:
1014
603
logger.info("Disabling client %s", self.name)
1015
604
if getattr(self, "disable_initiator_tag", None) is not None:
1016
GLib.source_remove(self.disable_initiator_tag)
605
gobject.source_remove(self.disable_initiator_tag)
1017
606
self.disable_initiator_tag = None
1018
607
self.expires = None
1019
608
if getattr(self, "checker_initiator_tag", None) is not None:
1020
GLib.source_remove(self.checker_initiator_tag)
609
gobject.source_remove(self.checker_initiator_tag)
1021
610
self.checker_initiator_tag = None
1022
611
self.stop_checker()
1023
612
self.enabled = False
1024
613
if not quiet:
1025
614
self.send_changedstate()
1026
# Do not run this again if called by a GLib.timeout_add
615
# Do not run this again if called by a gobject.timeout_add
1027
616
return False
1028
617
1029
618
def __del__(self):
1030
619
self.disable()
1031
620
1032
621
def init_checker(self):
1033
622
# Schedule a new checker to be started an 'interval' from now,
1034
623
# and every interval from then on.
1035
624
if self.checker_initiator_tag is not None:
1036
GLib.source_remove(self.checker_initiator_tag)
1037
self.checker_initiator_tag = GLib.timeout_add(
1038
int(self.interval.total_seconds() * 1000),
1039
self.start_checker)
625
gobject.source_remove(self.checker_initiator_tag)
626
self.checker_initiator_tag = (gobject.timeout_add
627
(self.interval_milliseconds(),
628
self.start_checker))
1040
629
# Schedule a disable() when 'timeout' has passed
1041
630
if self.disable_initiator_tag is not None:
1042
GLib.source_remove(self.disable_initiator_tag)
1043
self.disable_initiator_tag = GLib.timeout_add(
1044
int(self.timeout.total_seconds() * 1000), self.disable)
631
gobject.source_remove(self.disable_initiator_tag)
632
self.disable_initiator_tag = (gobject.timeout_add
633
(self.timeout_milliseconds(),
634
self.disable))
1045
635
# Also start a new checker *right now*.
1046
636
self.start_checker()
1047
1048
def checker_callback(self, source, condition, connection,
1049
command):
637
638
def checker_callback(self, pid, condition, command):
1050
639
"""The checker has completed, so take appropriate actions."""
1051
# Read return code from connection (see call_pipe)
1052
returncode = connection.recv()
1053
connection.close()
1054
if self.checker is not None:
1055
self.checker.join()
1056
640
self.checker_callback_tag = None
1057
641
self.checker = None
1058
1059
if returncode >= 0:
1060
self.last_checker_status = returncode
1061
self.last_checker_signal = None
642
if os.WIFEXITED(condition):
643
self.last_checker_status = os.WEXITSTATUS(condition)
1062
644
if self.last_checker_status == 0:
1063
645
logger.info("Checker for %(name)s succeeded",
1064
646
vars(self))
1065
647
self.checked_ok()
1066
648
else:
1067
logger.info("Checker for %(name)s failed", vars(self))
649
logger.info("Checker for %(name)s failed",
650
vars(self))
1068
651
else:
1069
652
self.last_checker_status = -1
1070
self.last_checker_signal = -returncode
1071
653
logger.warning("Checker for %(name)s crashed?",
1072
654
vars(self))
1073
return False
1074
655
1075
656
def checked_ok(self):
1076
657
"""Assert that the client has been seen, alive and well."""
1077
658
self.last_checked_ok = datetime.datetime.utcnow()
1078
659
self.last_checker_status = 0
1079
self.last_checker_signal = None
1080
660
self.bump_timeout()
1081
661
1082
662
def bump_timeout(self, timeout=None):
1083
663
"""Bump up the timeout for this client."""
1084
664
if timeout is None:
1085
665
timeout = self.timeout
1086
666
if self.disable_initiator_tag is not None:
1087
GLib.source_remove(self.disable_initiator_tag)
667
gobject.source_remove(self.disable_initiator_tag)
1088
668
self.disable_initiator_tag = None
1089
669
if getattr(self, "enabled", False):
1090
self.disable_initiator_tag = GLib.timeout_add(
1091
int(timeout.total_seconds() * 1000), self.disable)
670
self.disable_initiator_tag = (gobject.timeout_add
671
(timedelta_to_milliseconds
672
(timeout), self.disable))
1092
673
self.expires = datetime.datetime.utcnow() + timeout
1093
674
1094
675
def need_approval(self):
1095
676
self.last_approval_request = datetime.datetime.utcnow()
1096
677
1097
678
def start_checker(self):
1098
679
"""Start a new checker subprocess if one is not running.
1099
680
1100
681
If a checker already exists, leave it running and do
1101
682
nothing."""
1102
683
# The reason for not killing a running checker is that if we
1107
688
# checkers alone, the checker would have to take more time
1108
689
# than 'timeout' for the client to be disabled, which is as it
1109
690
# should be.
1110
1111
if self.checker is not None and not self.checker.is_alive():
1112
logger.warning("Checker was not alive; joining")
1113
self.checker.join()
1114
self.checker = None
691
692
# If a checker exists, make sure it is not a zombie
693
try:
694
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
695
except AttributeError:
696
pass
697
except OSError as error:
698
if error.errno != errno.ECHILD:
699
raise
700
else:
701
if pid:
702
logger.warning("Checker was a zombie")
703
gobject.source_remove(self.checker_callback_tag)
704
self.checker_callback(pid, status,
705
self.current_checker_command)
1115
706
# Start a new checker if needed
1116
707
if self.checker is None:
1117
708
# Escape attributes for the shell
1118
escaped_attrs = {
1119
attr: re.escape(str(getattr(self, attr)))
1120
for attr in self.runtime_expansions}
709
escaped_attrs = dict(
710
(attr, re.escape(unicode(getattr(self, attr))))
711
for attr in
712
self.runtime_expansions)
1121
713
try:
1122
714
command = self.checker_command % escaped_attrs
1123
715
except TypeError as error:
1124
716
logger.error('Could not format string "%s"',
1125
self.checker_command,
717
self.checker_command, exc_info=error)
718
return True # Try again later
719
self.current_checker_command = command
720
try:
721
logger.info("Starting checker %r for %s",
722
command, self.name)
723
# We don't need to redirect stdout and stderr, since
724
# in normal mode, that is already done by daemon(),
725
# and in debug mode we don't want to. (Stdin is
726
# always replaced by /dev/null.)
727
# The exception is when not debugging but nevertheless
728
# running in the foreground; use the previously
729
# created wnull.
730
popen_args = {}
731
if (not self.server_settings["debug"]
732
and self.server_settings["foreground"]):
733
popen_args.update({"stdout": wnull,
734
"stderr": wnull })
735
self.checker = subprocess.Popen(command,
736
close_fds=True,
737
shell=True, cwd="/",
738
**popen_args)
739
except OSError as error:
740
logger.error("Failed to start subprocess",
1126
741
exc_info=error)
1127
return True # Try again later
1128
self.current_checker_command = command
1129
logger.info("Starting checker %r for %s", command,
1130
self.name)
1131
# We don't need to redirect stdout and stderr, since
1132
# in normal mode, that is already done by daemon(),
1133
# and in debug mode we don't want to. (Stdin is
1134
# always replaced by /dev/null.)
1135
# The exception is when not debugging but nevertheless
1136
# running in the foreground; use the previously
1137
# created wnull.
1138
popen_args = {"close_fds": True,
1139
"shell": True,
1140
"cwd": "/"}
1141
if (not self.server_settings["debug"]
1142
and self.server_settings["foreground"]):
1143
popen_args.update({"stdout": wnull,
1144
"stderr": wnull})
1145
pipe = multiprocessing.Pipe(duplex=False)
1146
self.checker = multiprocessing.Process(
1147
target=call_pipe,
1148
args=(pipe[1], subprocess.call, command),
1149
kwargs=popen_args)
1150
self.checker.start()
1151
self.checker_callback_tag = GLib.io_add_watch(
1152
GLib.IOChannel.unix_new(pipe[0].fileno()),
1153
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1154
self.checker_callback, pipe[0], command)
1155
# Re-run this periodically if run by GLib.timeout_add
742
return True
743
self.checker_callback_tag = (gobject.child_watch_add
744
(self.checker.pid,
745
self.checker_callback,
746
data=command))
747
# The checker may have completed before the gobject
748
# watch was added. Check for this.
749
try:
750
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
751
except OSError as error:
752
if error.errno == errno.ECHILD:
753
# This should never happen
754
logger.error("Child process vanished",
755
exc_info=error)
756
return True
757
raise
758
if pid:
759
gobject.source_remove(self.checker_callback_tag)
760
self.checker_callback(pid, status, command)
761
# Re-run this periodically if run by gobject.timeout_add
1156
762
return True
1157
763
1158
764
def stop_checker(self):
1159
765
"""Force the checker process, if any, to stop."""
1160
766
if self.checker_callback_tag:
1161
GLib.source_remove(self.checker_callback_tag)
767
gobject.source_remove(self.checker_callback_tag)
1162
768
self.checker_callback_tag = None
1163
769
if getattr(self, "checker", None) is None:
1164
770
return
1165
771
logger.debug("Stopping checker for %(name)s", vars(self))
1166
self.checker.terminate()
772
try:
773
self.checker.terminate()
774
#time.sleep(0.5)
775
#if self.checker.poll() is None:
776
# self.checker.kill()
777
except OSError as error:
778
if error.errno != errno.ESRCH: # No such process
779
raise
1167
780
self.checker = None
1168
781
1169
782
1170
def dbus_service_property(dbus_interface,
1171
signature="v",
1172
access="readwrite",
1173
byte_arrays=False):
783
def dbus_service_property(dbus_interface, signature="v",
784
access="readwrite", byte_arrays=False):
1174
785
"""Decorators for marking methods of a DBusObjectWithProperties to
1175
786
become properties on the D-Bus.
1176
787
1177
788
The decorated method will be called with no arguments by "Get"
1178
789
and with one argument by "Set".
1179
790
1180
791
The parameters, where they are supported, are the same as
1181
792
dbus.service.method, except there is only "signature", since the
1182
793
type from Get() and the type sent to Set() is the same.
1185
796
# "Set" method, so we fail early here:
1186
797
if byte_arrays and signature != "ay":
1187
798
raise ValueError("Byte arrays not supported for non-'ay'"
1188
" signature {!r}".format(signature))
1189
799
" signature {0!r}".format(signature))
1190
800
def decorator(func):
1191
801
func._dbus_is_property = True
1192
802
func._dbus_interface = dbus_interface
1195
805
func._dbus_name = func.__name__
1196
806
if func._dbus_name.endswith("_dbus_property"):
1197
807
func._dbus_name = func._dbus_name[:-14]
1198
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
808
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1199
809
return func
1200
1201
810
return decorator
1202
811
1203
812
1204
813
def dbus_interface_annotations(dbus_interface):
1205
814
"""Decorator for marking functions returning interface annotations
1206
815
1207
816
Usage:
1208
817
1209
818
@dbus_interface_annotations("org.example.Interface")
1210
819
def _foo(self): # Function name does not matter
1211
820
return {"org.freedesktop.DBus.Deprecated": "true",
1212
821
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1213
822
"false"}
1214
823
"""
1215
1216
824
def decorator(func):
1217
825
func._dbus_is_interface = True
1218
826
func._dbus_interface = dbus_interface
1219
827
func._dbus_name = dbus_interface
1220
828
return func
1221
1222
829
return decorator
1223
830
1224
831
1225
832
def dbus_annotations(annotations):
1226
833
"""Decorator to annotate D-Bus methods, signals or properties
1227
834
Usage:
1228
1229
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1230
"org.freedesktop.DBus.Property."
1231
"EmitsChangedSignal": "false"})
835
1232
836
@dbus_service_property("org.example.Interface", signature="b",
1233
837
access="r")
838
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
839
"org.freedesktop.DBus.Property."
840
"EmitsChangedSignal": "false"})
1234
841
def Property_dbus_property(self):
1235
842
return dbus.Boolean(False)
1236
1237
See also the DBusObjectWithAnnotations class.
1238
843
"""
1239
1240
844
def decorator(func):
1241
845
func._dbus_annotations = annotations
1242
846
return func
1243
1244
847
return decorator
1245
848
1246
849
1247
850
class DBusPropertyException(dbus.exceptions.DBusException):
1248
851
"""A base class for D-Bus property-related exceptions
1249
852
"""
1250
pass
853
def __unicode__(self):
854
return unicode(str(self))
1251
855
1252
856
1253
857
class DBusPropertyAccessException(DBusPropertyException):
1262
866
pass
1263
867
1264
868
1265
class DBusObjectWithAnnotations(dbus.service.Object):
1266
"""A D-Bus object with annotations.
1267
1268
Classes inheriting from this can use the dbus_annotations
1269
decorator to add annotations to methods or signals.
869
class DBusObjectWithProperties(dbus.service.Object):
870
"""A D-Bus object with properties.
871
872
Classes inheriting from this can use the dbus_service_property
873
decorator to expose methods as D-Bus properties. It exposes the
874
standard Get(), Set(), and GetAll() methods on the D-Bus.
1270
875
"""
1271
876
1272
877
@staticmethod
1273
878
def _is_dbus_thing(thing):
1274
879
"""Returns a function testing if an attribute is a D-Bus thing
1275
880
1276
881
If called like _is_dbus_thing("method") it returns a function
1277
882
suitable for use as predicate to inspect.getmembers().
1278
883
"""
1279
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
884
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1280
885
False)
1281
886
1282
887
def _get_all_dbus_things(self, thing):
1283
888
"""Returns a generator of (name, attribute) pairs
1284
889
"""
1285
return ((getattr(athing.__get__(self), "_dbus_name", name),
890
return ((getattr(athing.__get__(self), "_dbus_name",
891
name),
1286
892
athing.__get__(self))
1287
893
for cls in self.__class__.__mro__
1288
894
for name, athing in
1289
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1290
1291
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1292
out_signature="s",
1293
path_keyword='object_path',
1294
connection_keyword='connection')
1295
def Introspect(self, object_path, connection):
1296
"""Overloading of standard D-Bus method.
1297
1298
Inserts annotation tags on methods and signals.
1299
"""
1300
xmlstring = dbus.service.Object.Introspect(self, object_path,
1301
connection)
1302
try:
1303
document = xml.dom.minidom.parseString(xmlstring)
1304
1305
for if_tag in document.getElementsByTagName("interface"):
1306
# Add annotation tags
1307
for typ in ("method", "signal"):
1308
for tag in if_tag.getElementsByTagName(typ):
1309
annots = dict()
1310
for name, prop in (self.
1311
_get_all_dbus_things(typ)):
1312
if (name == tag.getAttribute("name")
1313
and prop._dbus_interface
1314
== if_tag.getAttribute("name")):
1315
annots.update(getattr(
1316
prop, "_dbus_annotations", {}))
1317
for name, value in annots.items():
1318
ann_tag = document.createElement(
1319
"annotation")
1320
ann_tag.setAttribute("name", name)
1321
ann_tag.setAttribute("value", value)
1322
tag.appendChild(ann_tag)
1323
# Add interface annotation tags
1324
for annotation, value in dict(
1325
itertools.chain.from_iterable(
1326
annotations().items()
1327
for name, annotations
1328
in self._get_all_dbus_things("interface")
1329
if name == if_tag.getAttribute("name")
1330
)).items():
1331
ann_tag = document.createElement("annotation")
1332
ann_tag.setAttribute("name", annotation)
1333
ann_tag.setAttribute("value", value)
1334
if_tag.appendChild(ann_tag)
1335
# Fix argument name for the Introspect method itself
1336
if (if_tag.getAttribute("name")
1337
== dbus.INTROSPECTABLE_IFACE):
1338
for cn in if_tag.getElementsByTagName("method"):
1339
if cn.getAttribute("name") == "Introspect":
1340
for arg in cn.getElementsByTagName("arg"):
1341
if (arg.getAttribute("direction")
1342
== "out"):
1343
arg.setAttribute("name",
1344
"xml_data")
1345
xmlstring = document.toxml("utf-8")
1346
document.unlink()
1347
except (AttributeError, xml.dom.DOMException,
1348
xml.parsers.expat.ExpatError) as error:
1349
logger.error("Failed to override Introspection method",
1350
exc_info=error)
1351
return xmlstring
1352
1353
1354
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1355
"""A D-Bus object with properties.
1356
1357
Classes inheriting from this can use the dbus_service_property
1358
decorator to expose methods as D-Bus properties. It exposes the
1359
standard Get(), Set(), and GetAll() methods on the D-Bus.
1360
"""
1361
895
inspect.getmembers(cls,
896
self._is_dbus_thing(thing)))
897
1362
898
def _get_dbus_property(self, interface_name, property_name):
1363
899
"""Returns a bound method if one exists which is a D-Bus
1364
900
property with the specified name and interface.
1365
901
"""
1366
for cls in self.__class__.__mro__:
1367
for name, value in inspect.getmembers(
1368
cls, self._is_dbus_thing("property")):
902
for cls in self.__class__.__mro__:
903
for name, value in (inspect.getmembers
904
(cls,
905
self._is_dbus_thing("property"))):
1369
906
if (value._dbus_name == property_name
1370
907
and value._dbus_interface == interface_name):
1371
908
return value.__get__(self)
1372
909
1373
910
# No such property
1374
raise DBusPropertyNotFound("{}:{}.{}".format(
1375
self.dbus_object_path, interface_name, property_name))
1376
1377
@classmethod
1378
def _get_all_interface_names(cls):
1379
"""Get a sequence of all interfaces supported by an object"""
1380
return (name for name in set(getattr(getattr(x, attr),
1381
"_dbus_interface", None)
1382
for x in (inspect.getmro(cls))
1383
for attr in dir(x))
1384
if name is not None)
1385
1386
@dbus.service.method(dbus.PROPERTIES_IFACE,
1387
in_signature="ss",
911
raise DBusPropertyNotFound(self.dbus_object_path + ":"
912
+ interface_name + "."
913
+ property_name)
914
915
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1388
916
out_signature="v")
1389
917
def Get(self, interface_name, property_name):
1390
918
"""Standard D-Bus property Get() method, see D-Bus standard.
1396
924
if not hasattr(value, "variant_level"):
1397
925
return value
1398
926
return type(value)(value, variant_level=value.variant_level+1)
1399
927
1400
928
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1401
929
def Set(self, interface_name, property_name, value):
1402
930
"""Standard D-Bus property Set() method, see D-Bus standard.
1409
937
# signatures other than "ay".
1410
938
if prop._dbus_signature != "ay":
1411
939
raise ValueError("Byte arrays not supported for non-"
1412
"'ay' signature {!r}"
940
"'ay' signature {0!r}"
1413
941
.format(prop._dbus_signature))
1414
value = dbus.ByteArray(bytes(value))
942
value = dbus.ByteArray(b''.join(chr(byte)
943
for byte in value))
1415
944
prop(value)
1416
1417
@dbus.service.method(dbus.PROPERTIES_IFACE,
1418
in_signature="s",
945
946
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1419
947
out_signature="a{sv}")
1420
948
def GetAll(self, interface_name):
1421
949
"""Standard D-Bus property GetAll() method, see D-Bus
1422
950
standard.
1423
951
1424
952
Note: Will not include properties with access="write".
1425
953
"""
1426
954
properties = {}
1436
964
if not hasattr(value, "variant_level"):
1437
965
properties[name] = value
1438
966
continue
1439
properties[name] = type(value)(
1440
value, variant_level=value.variant_level + 1)
967
properties[name] = type(value)(value, variant_level=
968
value.variant_level+1)
1441
969
return dbus.Dictionary(properties, signature="sv")
1442
1443
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1444
def PropertiesChanged(self, interface_name, changed_properties,
1445
invalidated_properties):
1446
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1447
standard.
1448
"""
1449
pass
1450
970
1451
971
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1452
972
out_signature="s",
1453
973
path_keyword='object_path',
1454
974
connection_keyword='connection')
1455
975
def Introspect(self, object_path, connection):
1456
976
"""Overloading of standard D-Bus method.
1457
977
1458
978
Inserts property tags and interface annotation tags.
1459
979
"""
1460
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1461
object_path,
1462
connection)
980
xmlstring = dbus.service.Object.Introspect(self, object_path,
981
connection)
1463
982
try:
1464
983
document = xml.dom.minidom.parseString(xmlstring)
1465
1466
984
def make_tag(document, name, prop):
1467
985
e = document.createElement("property")
1468
986
e.setAttribute("name", name)
1469
987
e.setAttribute("type", prop._dbus_signature)
1470
988
e.setAttribute("access", prop._dbus_access)
1471
989
return e
1472
1473
990
for if_tag in document.getElementsByTagName("interface"):
1474
991
# Add property tags
1475
992
for tag in (make_tag(document, name, prop)
1478
995
if prop._dbus_interface
1479
996
== if_tag.getAttribute("name")):
1480
997
if_tag.appendChild(tag)
1481
# Add annotation tags for properties
1482
for tag in if_tag.getElementsByTagName("property"):
1483
annots = dict()
1484
for name, prop in self._get_all_dbus_things(
1485
"property"):
1486
if (name == tag.getAttribute("name")
1487
and prop._dbus_interface
1488
== if_tag.getAttribute("name")):
1489
annots.update(getattr(
1490
prop, "_dbus_annotations", {}))
1491
for name, value in annots.items():
1492
ann_tag = document.createElement(
1493
"annotation")
1494
ann_tag.setAttribute("name", name)
1495
ann_tag.setAttribute("value", value)
1496
tag.appendChild(ann_tag)
998
# Add annotation tags
999
for typ in ("method", "signal", "property"):
1000
for tag in if_tag.getElementsByTagName(typ):
1001
annots = dict()
1002
for name, prop in (self.
1003
_get_all_dbus_things(typ)):
1004
if (name == tag.getAttribute("name")
1005
and prop._dbus_interface
1006
== if_tag.getAttribute("name")):
1007
annots.update(getattr
1008
(prop,
1009
"_dbus_annotations",
1010
{}))
1011
for name, value in annots.iteritems():
1012
ann_tag = document.createElement(
1013
"annotation")
1014
ann_tag.setAttribute("name", name)
1015
ann_tag.setAttribute("value", value)
1016
tag.appendChild(ann_tag)
1017
# Add interface annotation tags
1018
for annotation, value in dict(
1019
itertools.chain.from_iterable(
1020
annotations().iteritems()
1021
for name, annotations in
1022
self._get_all_dbus_things("interface")
1023
if name == if_tag.getAttribute("name")
1024
)).iteritems():
1025
ann_tag = document.createElement("annotation")
1026
ann_tag.setAttribute("name", annotation)
1027
ann_tag.setAttribute("value", value)
1028
if_tag.appendChild(ann_tag)
1497
1029
# Add the names to the return values for the
1498
1030
# "org.freedesktop.DBus.Properties" methods
1499
1031
if (if_tag.getAttribute("name")
1518
1050
return xmlstring
1519
1051
1520
1052
1521
try:
1522
dbus.OBJECT_MANAGER_IFACE
1523
except AttributeError:
1524
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1525
1526
1527
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1528
"""A D-Bus object with an ObjectManager.
1529
1530
Classes inheriting from this exposes the standard
1531
GetManagedObjects call and the InterfacesAdded and
1532
InterfacesRemoved signals on the standard
1533
"org.freedesktop.DBus.ObjectManager" interface.
1534
1535
Note: No signals are sent automatically; they must be sent
1536
manually.
1537
"""
1538
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1539
out_signature="a{oa{sa{sv}}}")
1540
def GetManagedObjects(self):
1541
"""This function must be overridden"""
1542
raise NotImplementedError()
1543
1544
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1545
signature="oa{sa{sv}}")
1546
def InterfacesAdded(self, object_path, interfaces_and_properties):
1547
pass
1548
1549
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1550
def InterfacesRemoved(self, object_path, interfaces):
1551
pass
1552
1553
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1554
out_signature="s",
1555
path_keyword='object_path',
1556
connection_keyword='connection')
1557
def Introspect(self, object_path, connection):
1558
"""Overloading of standard D-Bus method.
1559
1560
Override return argument name of GetManagedObjects to be
1561
"objpath_interfaces_and_properties"
1562
"""
1563
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1564
object_path,
1565
connection)
1566
try:
1567
document = xml.dom.minidom.parseString(xmlstring)
1568
1569
for if_tag in document.getElementsByTagName("interface"):
1570
# Fix argument name for the GetManagedObjects method
1571
if (if_tag.getAttribute("name")
1572
== dbus.OBJECT_MANAGER_IFACE):
1573
for cn in if_tag.getElementsByTagName("method"):
1574
if (cn.getAttribute("name")
1575
== "GetManagedObjects"):
1576
for arg in cn.getElementsByTagName("arg"):
1577
if (arg.getAttribute("direction")
1578
== "out"):
1579
arg.setAttribute(
1580
"name",
1581
"objpath_interfaces"
1582
"_and_properties")
1583
xmlstring = document.toxml("utf-8")
1584
document.unlink()
1585
except (AttributeError, xml.dom.DOMException,
1586
xml.parsers.expat.ExpatError) as error:
1587
logger.error("Failed to override Introspection method",
1588
exc_info=error)
1589
return xmlstring
1590
1591
1592
1053
def datetime_to_dbus(dt, variant_level=0):
1593
1054
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1594
1055
if dt is None:
1595
return dbus.String("", variant_level=variant_level)
1596
return dbus.String(dt.isoformat(), variant_level=variant_level)
1056
return dbus.String("", variant_level = variant_level)
1057
return dbus.String(dt.isoformat(),
1058
variant_level=variant_level)
1597
1059
1598
1060
1599
1061
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1601
1063
dbus.service.Object, it will add alternate D-Bus attributes with
1602
1064
interface names according to the "alt_interface_names" mapping.
1603
1065
Usage:
1604
1066
1605
1067
@alternate_dbus_interfaces({"org.example.Interface":
1606
1068
"net.example.AlternateInterface"})
1607
1069
class SampleDBusObject(dbus.service.Object):
1608
1070
@dbus.service.method("org.example.Interface")
1609
1071
def SampleDBusMethod():
1610
1072
pass
1611
1073
1612
1074
The above "SampleDBusMethod" on "SampleDBusObject" will be
1613
1075
reachable via two interfaces: "org.example.Interface" and
1614
1076
"net.example.AlternateInterface", the latter of which will have
1615
1077
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1616
1078
"true", unless "deprecate" is passed with a False value.
1617
1079
1618
1080
This works for methods and signals, and also for D-Bus properties
1619
1081
(from DBusObjectWithProperties) and interfaces (from the
1620
1082
dbus_interface_annotations decorator).
1621
1083
"""
1622
1623
1084
def wrapper(cls):
1624
1085
for orig_interface_name, alt_interface_name in (
1625
alt_interface_names.items()):
1086
alt_interface_names.iteritems()):
1626
1087
attr = {}
1627
1088
interface_names = set()
1628
1089
# Go though all attributes of the class
1630
1091
# Ignore non-D-Bus attributes, and D-Bus attributes
1631
1092
# with the wrong interface name
1632
1093
if (not hasattr(attribute, "_dbus_interface")
1633
or not attribute._dbus_interface.startswith(
1634
orig_interface_name)):
1094
or not attribute._dbus_interface
1095
.startswith(orig_interface_name)):
1635
1096
continue
1636
1097
# Create an alternate D-Bus interface name based on
1637
1098
# the current name
1638
alt_interface = attribute._dbus_interface.replace(
1639
orig_interface_name, alt_interface_name)
1099
alt_interface = (attribute._dbus_interface
1100
.replace(orig_interface_name,
1101
alt_interface_name))
1640
1102
interface_names.add(alt_interface)
1641
1103
# Is this a D-Bus signal?
1642
1104
if getattr(attribute, "_dbus_is_signal", False):
1643
1105
# Extract the original non-method undecorated
1644
1106
# function by black magic
1645
if sys.version_info.major == 2:
1646
nonmethod_func = (dict(
1107
nonmethod_func = (dict(
1647
1108
zip(attribute.func_code.co_freevars,
1648
attribute.__closure__))
1649
["func"].cell_contents)
1650
else:
1651
nonmethod_func = (dict(
1652
zip(attribute.__code__.co_freevars,
1653
attribute.__closure__))
1654
["func"].cell_contents)
1109
attribute.__closure__))["func"]
1110
.cell_contents)
1655
1111
# Create a new, but exactly alike, function
1656
1112
# object, and decorate it to be a new D-Bus signal
1657
1113
# with the alternate D-Bus interface name
1658
new_function = copy_function(nonmethod_func)
1659
new_function = (dbus.service.signal(
1660
alt_interface,
1661
attribute._dbus_signature)(new_function))
1114
new_function = (dbus.service.signal
1115
(alt_interface,
1116
attribute._dbus_signature)
1117
(types.FunctionType(
1118
nonmethod_func.func_code,
1119
nonmethod_func.func_globals,
1120
nonmethod_func.func_name,
1121
nonmethod_func.func_defaults,
1122
nonmethod_func.func_closure)))
1662
1123
# Copy annotations, if any
1663
1124
try:
1664
new_function._dbus_annotations = dict(
1665
attribute._dbus_annotations)
1125
new_function._dbus_annotations = (
1126
dict(attribute._dbus_annotations))
1666
1127
except AttributeError:
1667
1128
pass
1668
1669
1129
# Define a creator of a function to call both the
1670
1130
# original and alternate functions, so both the
1671
1131
# original and alternate signals gets sent when
1674
1134
"""This function is a scope container to pass
1675
1135
func1 and func2 to the "call_both" function
1676
1136
outside of its arguments"""
1677
1678
@functools.wraps(func2)
1679
1137
def call_both(*args, **kwargs):
1680
1138
"""This function will emit two D-Bus
1681
1139
signals by calling func1 and func2"""
1682
1140
func1(*args, **kwargs)
1683
1141
func2(*args, **kwargs)
1684
# Make wrapper function look like a D-Bus
1685
# signal
1686
for name, attr in inspect.getmembers(func2):
1687
if name.startswith("_dbus_"):
1688
setattr(call_both, name, attr)
1689
1690
1142
return call_both
1691
1143
# Create the "call_both" function and add it to
1692
1144
# the class
1697
1149
# object. Decorate it to be a new D-Bus method
1698
1150
# with the alternate D-Bus interface name. Add it
1699
1151
# to the class.
1700
attr[attrname] = (
1701
dbus.service.method(
1702
alt_interface,
1703
attribute._dbus_in_signature,
1704
attribute._dbus_out_signature)
1705
(copy_function(attribute)))
1152
attr[attrname] = (dbus.service.method
1153
(alt_interface,
1154
attribute._dbus_in_signature,
1155
attribute._dbus_out_signature)
1156
(types.FunctionType
1157
(attribute.func_code,
1158
attribute.func_globals,
1159
attribute.func_name,
1160
attribute.func_defaults,
1161
attribute.func_closure)))
1706
1162
# Copy annotations, if any
1707
1163
try:
1708
attr[attrname]._dbus_annotations = dict(
1709
attribute._dbus_annotations)
1164
attr[attrname]._dbus_annotations = (
1165
dict(attribute._dbus_annotations))
1710
1166
except AttributeError:
1711
1167
pass
1712
1168
# Is this a D-Bus property?
1715
1171
# object, and decorate it to be a new D-Bus
1716
1172
# property with the alternate D-Bus interface
1717
1173
# name. Add it to the class.
1718
attr[attrname] = (dbus_service_property(
1719
alt_interface, attribute._dbus_signature,
1720
attribute._dbus_access,
1721
attribute._dbus_get_args_options
1722
["byte_arrays"])
1723
(copy_function(attribute)))
1174
attr[attrname] = (dbus_service_property
1175
(alt_interface,
1176
attribute._dbus_signature,
1177
attribute._dbus_access,
1178
attribute
1179
._dbus_get_args_options
1180
["byte_arrays"])
1181
(types.FunctionType
1182
(attribute.func_code,
1183
attribute.func_globals,
1184
attribute.func_name,
1185
attribute.func_defaults,
1186
attribute.func_closure)))
1724
1187
# Copy annotations, if any
1725
1188
try:
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1189
attr[attrname]._dbus_annotations = (
1190
dict(attribute._dbus_annotations))
1728
1191
except AttributeError:
1729
1192
pass
1730
1193
# Is this a D-Bus interface?
1733
1196
# object. Decorate it to be a new D-Bus interface
1734
1197
# with the alternate D-Bus interface name. Add it
1735
1198
# to the class.
1736
attr[attrname] = (
1737
dbus_interface_annotations(alt_interface)
1738
(copy_function(attribute)))
1199
attr[attrname] = (dbus_interface_annotations
1200
(alt_interface)
1201
(types.FunctionType
1202
(attribute.func_code,
1203
attribute.func_globals,
1204
attribute.func_name,
1205
attribute.func_defaults,
1206
attribute.func_closure)))
1739
1207
if deprecate:
1740
1208
# Deprecate all alternate interfaces
1741
iname = "_AlternateDBusNames_interface_annotation{}"
1209
iname="_AlternateDBusNames_interface_annotation{0}"
1742
1210
for interface_name in interface_names:
1743
1744
1211
@dbus_interface_annotations(interface_name)
1745
1212
def func(self):
1746
return {"org.freedesktop.DBus.Deprecated":
1747
"true"}
1213
return { "org.freedesktop.DBus.Deprecated":
1214
"true" }
1748
1215
# Find an unused name
1749
1216
for aname in (iname.format(i)
1750
1217
for i in itertools.count()):
1754
1221
if interface_names:
1755
1222
# Replace the class with a new subclass of it with
1756
1223
# methods, signals, etc. as created above.
1757
if sys.version_info.major == 2:
1758
cls = type(b"{}Alternate".format(cls.__name__),
1759
(cls, ), attr)
1760
else:
1761
cls = type("{}Alternate".format(cls.__name__),
1762
(cls, ), attr)
1224
cls = type(b"{0}Alternate".format(cls.__name__),
1225
(cls,), attr)
1763
1226
return cls
1764
1765
1227
return wrapper
1766
1228
1767
1229
1768
1230
@alternate_dbus_interfaces({"se.recompile.Mandos":
1769
"se.bsnet.fukt.Mandos"})
1231
"se.bsnet.fukt.Mandos"})
1770
1232
class ClientDBus(Client, DBusObjectWithProperties):
1771
1233
"""A Client class using D-Bus
1772
1234
1773
1235
Attributes:
1774
1236
dbus_object_path: dbus.ObjectPath
1775
1237
bus: dbus.SystemBus()
1776
1238
"""
1777
1239
1778
1240
runtime_expansions = (Client.runtime_expansions
1779
+ ("dbus_object_path", ))
1780
1781
_interface = "se.recompile.Mandos.Client"
1782
1241
+ ("dbus_object_path",))
1242
1783
1243
# dbus.service.Object doesn't use super(), so we can't either.
1784
1785
def __init__(self, bus=None, *args, **kwargs):
1244
1245
def __init__(self, bus = None, *args, **kwargs):
1786
1246
self.bus = bus
1787
1247
Client.__init__(self, *args, **kwargs)
1788
1248
# Only now, when this client is initialized, can it show up on
1789
1249
# the D-Bus
1790
client_object_name = str(self.name).translate(
1250
client_object_name = unicode(self.name).translate(
1791
1251
{ord("."): ord("_"),
1792
1252
ord("-"): ord("_")})
1793
self.dbus_object_path = dbus.ObjectPath(
1794
"/clients/" + client_object_name)
1253
self.dbus_object_path = (dbus.ObjectPath
1254
("/clients/" + client_object_name))
1795
1255
DBusObjectWithProperties.__init__(self, self.bus,
1796
1256
self.dbus_object_path)
1797
1798
def notifychangeproperty(transform_func, dbus_name,
1799
type_func=lambda x: x,
1800
variant_level=1,
1801
invalidate_only=False,
1802
_interface=_interface):
1257
1258
def notifychangeproperty(transform_func,
1259
dbus_name, type_func=lambda x: x,
1260
variant_level=1):
1803
1261
""" Modify a variable so that it's a property which announces
1804
1262
its changes to DBus.
1805
1263
1806
1264
transform_fun: Function that takes a value and a variant_level
1807
1265
and transforms it to a D-Bus type.
1808
1266
dbus_name: D-Bus name of the variable
1810
1268
to the D-Bus. Default: no transform
1811
1269
variant_level: D-Bus variant level. Default: 1
1812
1270
"""
1813
attrname = "_{}".format(dbus_name)
1814
1271
attrname = "_{0}".format(dbus_name)
1815
1272
def setter(self, value):
1816
1273
if hasattr(self, "dbus_object_path"):
1817
1274
if (not hasattr(self, attrname) or
1818
1275
type_func(getattr(self, attrname, None))
1819
1276
!= type_func(value)):
1820
if invalidate_only:
1821
self.PropertiesChanged(
1822
_interface, dbus.Dictionary(),
1823
dbus.Array((dbus_name, )))
1824
else:
1825
dbus_value = transform_func(
1826
type_func(value),
1827
variant_level=variant_level)
1828
self.PropertyChanged(dbus.String(dbus_name),
1829
dbus_value)
1830
self.PropertiesChanged(
1831
_interface,
1832
dbus.Dictionary({dbus.String(dbus_name):
1833
dbus_value}),
1834
dbus.Array())
1277
dbus_value = transform_func(type_func(value),
1278
variant_level
1279
=variant_level)
1280
self.PropertyChanged(dbus.String(dbus_name),
1281
dbus_value)
1835
1282
setattr(self, attrname, value)
1836
1283
1837
1284
return property(lambda self: getattr(self, attrname), setter)
1838
1285
1839
1286
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1840
1287
approvals_pending = notifychangeproperty(dbus.Boolean,
1841
1288
"ApprovalPending",
1842
type_func=bool)
1289
type_func = bool)
1843
1290
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1844
1291
last_enabled = notifychangeproperty(datetime_to_dbus,
1845
1292
"LastEnabled")
1846
checker = notifychangeproperty(
1847
dbus.Boolean, "CheckerRunning",
1848
type_func=lambda checker: checker is not None)
1293
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1294
type_func = lambda checker:
1295
checker is not None)
1849
1296
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1850
1297
"LastCheckedOK")
1851
1298
last_checker_status = notifychangeproperty(dbus.Int16,
1854
1301
datetime_to_dbus, "LastApprovalRequest")
1855
1302
approved_by_default = notifychangeproperty(dbus.Boolean,
1856
1303
"ApprovedByDefault")
1857
approval_delay = notifychangeproperty(
1858
dbus.UInt64, "ApprovalDelay",
1859
type_func=lambda td: td.total_seconds() * 1000)
1304
approval_delay = notifychangeproperty(dbus.UInt64,
1305
"ApprovalDelay",
1306
type_func =
1307
timedelta_to_milliseconds)
1860
1308
approval_duration = notifychangeproperty(
1861
1309
dbus.UInt64, "ApprovalDuration",
1862
type_func=lambda td: td.total_seconds() * 1000)
1310
type_func = timedelta_to_milliseconds)
1863
1311
host = notifychangeproperty(dbus.String, "Host")
1864
timeout = notifychangeproperty(
1865
dbus.UInt64, "Timeout",
1866
type_func=lambda td: td.total_seconds() * 1000)
1312
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1313
type_func =
1314
timedelta_to_milliseconds)
1867
1315
extended_timeout = notifychangeproperty(
1868
1316
dbus.UInt64, "ExtendedTimeout",
1869
type_func=lambda td: td.total_seconds() * 1000)
1870
interval = notifychangeproperty(
1871
dbus.UInt64, "Interval",
1872
type_func=lambda td: td.total_seconds() * 1000)
1317
type_func = timedelta_to_milliseconds)
1318
interval = notifychangeproperty(dbus.UInt64,
1319
"Interval",
1320
type_func =
1321
timedelta_to_milliseconds)
1873
1322
checker_command = notifychangeproperty(dbus.String, "Checker")
1874
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1875
invalidate_only=True)
1876
1323
1877
1324
del notifychangeproperty
1878
1325
1879
1326
def __del__(self, *args, **kwargs):
1880
1327
try:
1881
1328
self.remove_from_connection()
1884
1331
if hasattr(DBusObjectWithProperties, "__del__"):
1885
1332
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1886
1333
Client.__del__(self, *args, **kwargs)
1887
1888
def checker_callback(self, source, condition,
1889
connection, command, *args, **kwargs):
1890
ret = Client.checker_callback(self, source, condition,
1891
connection, command, *args,
1892
**kwargs)
1893
exitstatus = self.last_checker_status
1894
if exitstatus >= 0:
1334
1335
def checker_callback(self, pid, condition, command,
1336
*args, **kwargs):
1337
self.checker_callback_tag = None
1338
self.checker = None
1339
if os.WIFEXITED(condition):
1340
exitstatus = os.WEXITSTATUS(condition)
1895
1341
# Emit D-Bus signal
1896
1342
self.CheckerCompleted(dbus.Int16(exitstatus),
1897
# This is specific to GNU libC
1898
dbus.Int64(exitstatus << 8),
1343
dbus.Int64(condition),
1899
1344
dbus.String(command))
1900
1345
else:
1901
1346
# Emit D-Bus signal
1902
1347
self.CheckerCompleted(dbus.Int16(-1),
1903
dbus.Int64(
1904
# This is specific to GNU libC
1905
(exitstatus << 8)
1906
| self.last_checker_signal),
1348
dbus.Int64(condition),
1907
1349
dbus.String(command))
1908
return ret
1909
1350
1351
return Client.checker_callback(self, pid, condition, command,
1352
*args, **kwargs)
1353
1910
1354
def start_checker(self, *args, **kwargs):
1911
1355
old_checker_pid = getattr(self.checker, "pid", None)
1912
1356
r = Client.start_checker(self, *args, **kwargs)
1916
1360
# Emit D-Bus signal
1917
1361
self.CheckerStarted(self.current_checker_command)
1918
1362
return r
1919
1363
1920
1364
def _reset_approved(self):
1921
1365
self.approved = None
1922
1366
return False
1923
1367
1924
1368
def approve(self, value=True):
1925
1369
self.approved = value
1926
GLib.timeout_add(int(self.approval_duration.total_seconds()
1927
* 1000), self._reset_approved)
1370
gobject.timeout_add(timedelta_to_milliseconds
1371
(self.approval_duration),
1372
self._reset_approved)
1928
1373
self.send_changedstate()
1929
1930
# D-Bus methods, signals & properties
1931
1932
# Interfaces
1933
1934
# Signals
1935
1374
1375
## D-Bus methods, signals & properties
1376
_interface = "se.recompile.Mandos.Client"
1377
1378
## Interfaces
1379
1380
@dbus_interface_annotations(_interface)
1381
def _foo(self):
1382
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1383
"false"}
1384
1385
## Signals
1386
1936
1387
# CheckerCompleted - signal
1937
1388
@dbus.service.signal(_interface, signature="nxs")
1938
1389
def CheckerCompleted(self, exitcode, waitstatus, command):
1939
1390
"D-Bus signal"
1940
1391
pass
1941
1392
1942
1393
# CheckerStarted - signal
1943
1394
@dbus.service.signal(_interface, signature="s")
1944
1395
def CheckerStarted(self, command):
1945
1396
"D-Bus signal"
1946
1397
pass
1947
1398
1948
1399
# PropertyChanged - signal
1949
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1950
1400
@dbus.service.signal(_interface, signature="sv")
1951
1401
def PropertyChanged(self, property, value):
1952
1402
"D-Bus signal"
1953
1403
pass
1954
1404
1955
1405
# GotSecret - signal
1956
1406
@dbus.service.signal(_interface)
1957
1407
def GotSecret(self):
1960
1410
server to mandos-client
1961
1411
"""
1962
1412
pass
1963
1413
1964
1414
# Rejected - signal
1965
1415
@dbus.service.signal(_interface, signature="s")
1966
1416
def Rejected(self, reason):
1967
1417
"D-Bus signal"
1968
1418
pass
1969
1419
1970
1420
# NeedApproval - signal
1971
1421
@dbus.service.signal(_interface, signature="tb")
1972
1422
def NeedApproval(self, timeout, default):
1973
1423
"D-Bus signal"
1974
1424
return self.need_approval()
1975
1976
# Methods
1977
1425
1426
## Methods
1427
1978
1428
# Approve - method
1979
1429
@dbus.service.method(_interface, in_signature="b")
1980
1430
def Approve(self, value):
1981
1431
self.approve(value)
1982
1432
1983
1433
# CheckedOK - method
1984
1434
@dbus.service.method(_interface)
1985
1435
def CheckedOK(self):
1986
1436
self.checked_ok()
1987
1437
1988
1438
# Enable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
1439
@dbus.service.method(_interface)
1991
1440
def Enable(self):
1992
1441
"D-Bus method"
1993
1442
self.enable()
1994
1443
1995
1444
# StartChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
1445
@dbus.service.method(_interface)
1998
1446
def StartChecker(self):
1999
1447
"D-Bus method"
2000
1448
self.start_checker()
2001
1449
2002
1450
# Disable - method
2003
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2004
1451
@dbus.service.method(_interface)
2005
1452
def Disable(self):
2006
1453
"D-Bus method"
2007
1454
self.disable()
2008
1455
2009
1456
# StopChecker - method
2010
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2011
1457
@dbus.service.method(_interface)
2012
1458
def StopChecker(self):
2013
1459
self.stop_checker()
2014
2015
# Properties
2016
1460
1461
## Properties
1462
2017
1463
# ApprovalPending - property
2018
1464
@dbus_service_property(_interface, signature="b", access="read")
2019
1465
def ApprovalPending_dbus_property(self):
2020
1466
return dbus.Boolean(bool(self.approvals_pending))
2021
1467
2022
1468
# ApprovedByDefault - property
2023
@dbus_service_property(_interface,
2024
signature="b",
1469
@dbus_service_property(_interface, signature="b",
2025
1470
access="readwrite")
2026
1471
def ApprovedByDefault_dbus_property(self, value=None):
2027
1472
if value is None: # get
2028
1473
return dbus.Boolean(self.approved_by_default)
2029
1474
self.approved_by_default = bool(value)
2030
1475
2031
1476
# ApprovalDelay - property
2032
@dbus_service_property(_interface,
2033
signature="t",
1477
@dbus_service_property(_interface, signature="t",
2034
1478
access="readwrite")
2035
1479
def ApprovalDelay_dbus_property(self, value=None):
2036
1480
if value is None: # get
2037
return dbus.UInt64(self.approval_delay.total_seconds()
2038
* 1000)
1481
return dbus.UInt64(self.approval_delay_milliseconds())
2039
1482
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2040
1483
2041
1484
# ApprovalDuration - property
2042
@dbus_service_property(_interface,
2043
signature="t",
1485
@dbus_service_property(_interface, signature="t",
2044
1486
access="readwrite")
2045
1487
def ApprovalDuration_dbus_property(self, value=None):
2046
1488
if value is None: # get
2047
return dbus.UInt64(self.approval_duration.total_seconds()
2048
* 1000)
1489
return dbus.UInt64(timedelta_to_milliseconds(
1490
self.approval_duration))
2049
1491
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2050
1492
2051
1493
# Name - property
2052
@dbus_annotations(
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
1494
@dbus_service_property(_interface, signature="s", access="read")
2055
1495
def Name_dbus_property(self):
2056
1496
return dbus.String(self.name)
2057
2058
# KeyID - property
2059
@dbus_annotations(
2060
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2061
@dbus_service_property(_interface, signature="s", access="read")
2062
def KeyID_dbus_property(self):
2063
return dbus.String(self.key_id)
2064
1497
2065
1498
# Fingerprint - property
2066
@dbus_annotations(
2067
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2068
1499
@dbus_service_property(_interface, signature="s", access="read")
2069
1500
def Fingerprint_dbus_property(self):
2070
1501
return dbus.String(self.fingerprint)
2071
1502
2072
1503
# Host - property
2073
@dbus_service_property(_interface,
2074
signature="s",
1504
@dbus_service_property(_interface, signature="s",
2075
1505
access="readwrite")
2076
1506
def Host_dbus_property(self, value=None):
2077
1507
if value is None: # get
2078
1508
return dbus.String(self.host)
2079
self.host = str(value)
2080
1509
self.host = unicode(value)
1510
2081
1511
# Created - property
2082
@dbus_annotations(
2083
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2084
1512
@dbus_service_property(_interface, signature="s", access="read")
2085
1513
def Created_dbus_property(self):
2086
1514
return datetime_to_dbus(self.created)
2087
1515
2088
1516
# LastEnabled - property
2089
1517
@dbus_service_property(_interface, signature="s", access="read")
2090
1518
def LastEnabled_dbus_property(self):
2091
1519
return datetime_to_dbus(self.last_enabled)
2092
1520
2093
1521
# Enabled - property
2094
@dbus_service_property(_interface,
2095
signature="b",
1522
@dbus_service_property(_interface, signature="b",
2096
1523
access="readwrite")
2097
1524
def Enabled_dbus_property(self, value=None):
2098
1525
if value is None: # get
2101
1528
self.enable()
2102
1529
else:
2103
1530
self.disable()
2104
1531
2105
1532
# LastCheckedOK - property
2106
@dbus_service_property(_interface,
2107
signature="s",
1533
@dbus_service_property(_interface, signature="s",
2108
1534
access="readwrite")
2109
1535
def LastCheckedOK_dbus_property(self, value=None):
2110
1536
if value is not None:
2111
1537
self.checked_ok()
2112
1538
return
2113
1539
return datetime_to_dbus(self.last_checked_ok)
2114
1540
2115
1541
# LastCheckerStatus - property
2116
@dbus_service_property(_interface, signature="n", access="read")
1542
@dbus_service_property(_interface, signature="n",
1543
access="read")
2117
1544
def LastCheckerStatus_dbus_property(self):
2118
1545
return dbus.Int16(self.last_checker_status)
2119
1546
2120
1547
# Expires - property
2121
1548
@dbus_service_property(_interface, signature="s", access="read")
2122
1549
def Expires_dbus_property(self):
2123
1550
return datetime_to_dbus(self.expires)
2124
1551
2125
1552
# LastApprovalRequest - property
2126
1553
@dbus_service_property(_interface, signature="s", access="read")
2127
1554
def LastApprovalRequest_dbus_property(self):
2128
1555
return datetime_to_dbus(self.last_approval_request)
2129
1556
2130
1557
# Timeout - property
2131
@dbus_service_property(_interface,
2132
signature="t",
1558
@dbus_service_property(_interface, signature="t",
2133
1559
access="readwrite")
2134
1560
def Timeout_dbus_property(self, value=None):
2135
1561
if value is None: # get
2136
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1562
return dbus.UInt64(self.timeout_milliseconds())
2137
1563
old_timeout = self.timeout
2138
1564
self.timeout = datetime.timedelta(0, 0, 0, value)
2139
1565
# Reschedule disabling
2147
1573
if (getattr(self, "disable_initiator_tag", None)
2148
1574
is None):
2149
1575
return
2150
GLib.source_remove(self.disable_initiator_tag)
2151
self.disable_initiator_tag = GLib.timeout_add(
2152
int((self.expires - now).total_seconds() * 1000),
2153
self.disable)
2154
1576
gobject.source_remove(self.disable_initiator_tag)
1577
self.disable_initiator_tag = (
1578
gobject.timeout_add(
1579
timedelta_to_milliseconds(self.expires - now),
1580
self.disable))
1581
2155
1582
# ExtendedTimeout - property
2156
@dbus_service_property(_interface,
2157
signature="t",
1583
@dbus_service_property(_interface, signature="t",
2158
1584
access="readwrite")
2159
1585
def ExtendedTimeout_dbus_property(self, value=None):
2160
1586
if value is None: # get
2161
return dbus.UInt64(self.extended_timeout.total_seconds()
2162
* 1000)
1587
return dbus.UInt64(self.extended_timeout_milliseconds())
2163
1588
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2164
1589
2165
1590
# Interval - property
2166
@dbus_service_property(_interface,
2167
signature="t",
1591
@dbus_service_property(_interface, signature="t",
2168
1592
access="readwrite")
2169
1593
def Interval_dbus_property(self, value=None):
2170
1594
if value is None: # get
2171
return dbus.UInt64(self.interval.total_seconds() * 1000)
1595
return dbus.UInt64(self.interval_milliseconds())
2172
1596
self.interval = datetime.timedelta(0, 0, 0, value)
2173
1597
if getattr(self, "checker_initiator_tag", None) is None:
2174
1598
return
2175
1599
if self.enabled:
2176
1600
# Reschedule checker run
2177
GLib.source_remove(self.checker_initiator_tag)
2178
self.checker_initiator_tag = GLib.timeout_add(
2179
value, self.start_checker)
2180
self.start_checker() # Start one now, too
2181
1601
gobject.source_remove(self.checker_initiator_tag)
1602
self.checker_initiator_tag = (gobject.timeout_add
1603
(value, self.start_checker))
1604
self.start_checker() # Start one now, too
1605
2182
1606
# Checker - property
2183
@dbus_service_property(_interface,
2184
signature="s",
1607
@dbus_service_property(_interface, signature="s",
2185
1608
access="readwrite")
2186
1609
def Checker_dbus_property(self, value=None):
2187
1610
if value is None: # get
2188
1611
return dbus.String(self.checker_command)
2189
self.checker_command = str(value)
2190
1612
self.checker_command = unicode(value)
1613
2191
1614
# CheckerRunning - property
2192
@dbus_service_property(_interface,
2193
signature="b",
1615
@dbus_service_property(_interface, signature="b",
2194
1616
access="readwrite")
2195
1617
def CheckerRunning_dbus_property(self, value=None):
2196
1618
if value is None: # get
2199
1621
self.start_checker()
2200
1622
else:
2201
1623
self.stop_checker()
2202
1624
2203
1625
# ObjectPath - property
2204
@dbus_annotations(
2205
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2206
"org.freedesktop.DBus.Deprecated": "true"})
2207
1626
@dbus_service_property(_interface, signature="o", access="read")
2208
1627
def ObjectPath_dbus_property(self):
2209
return self.dbus_object_path # is already a dbus.ObjectPath
2210
1628
return self.dbus_object_path # is already a dbus.ObjectPath
1629
2211
1630
# Secret = property
2212
@dbus_annotations(
2213
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2214
"invalidates"})
2215
@dbus_service_property(_interface,
2216
signature="ay",
2217
access="write",
2218
byte_arrays=True)
1631
@dbus_service_property(_interface, signature="ay",
1632
access="write", byte_arrays=True)
2219
1633
def Secret_dbus_property(self, value):
2220
self.secret = bytes(value)
2221
1634
self.secret = str(value)
1635
2222
1636
del _interface
2223
1637
2224
1638
2225
class ProxyClient:
2226
def __init__(self, child_pipe, key_id, fpr, address):
1639
class ProxyClient(object):
1640
def __init__(self, child_pipe, fpr, address):
2227
1641
self._pipe = child_pipe
2228
self._pipe.send(('init', key_id, fpr, address))
1642
self._pipe.send(('init', fpr, address))
2229
1643
if not self._pipe.recv():
2230
raise KeyError(key_id or fpr)
2231
1644
raise KeyError()
1645
2232
1646
def __getattribute__(self, name):
2233
1647
if name == '_pipe':
2234
1648
return super(ProxyClient, self).__getattribute__(name)
2237
1651
if data[0] == 'data':
2238
1652
return data[1]
2239
1653
if data[0] == 'function':
2240
2241
1654
def func(*args, **kwargs):
2242
1655
self._pipe.send(('funcall', name, args, kwargs))
2243
1656
return self._pipe.recv()[1]
2244
2245
1657
return func
2246
1658
2247
1659
def __setattr__(self, name, value):
2248
1660
if name == '_pipe':
2249
1661
return super(ProxyClient, self).__setattr__(name, value)
2252
1664
2253
1665
class ClientHandler(socketserver.BaseRequestHandler, object):
2254
1666
"""A class to handle client connections.
2255
1667
2256
1668
Instantiated once for each connection to handle it.
2257
1669
Note: This will run in its own forked process."""
2258
1670
2259
1671
def handle(self):
2260
1672
with contextlib.closing(self.server.child_pipe) as child_pipe:
2261
1673
logger.info("TCP connection from: %s",
2262
str(self.client_address))
1674
unicode(self.client_address))
2263
1675
logger.debug("Pipe FD: %d",
2264
1676
self.server.child_pipe.fileno())
2265
2266
session = gnutls.ClientSession(self.request)
2267
2268
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2269
# "+AES-256-CBC", "+SHA1",
2270
# "+COMP-NULL", "+CTYPE-OPENPGP",
2271
# "+DHE-DSS"))
1677
1678
session = (gnutls.connection
1679
.ClientSession(self.request,
1680
gnutls.connection
1681
.X509Credentials()))
1682
1683
# Note: gnutls.connection.X509Credentials is really a
1684
# generic GnuTLS certificate credentials object so long as
1685
# no X.509 keys are added to it. Therefore, we can use it
1686
# here despite using OpenPGP certificates.
1687
1688
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1689
# "+AES-256-CBC", "+SHA1",
1690
# "+COMP-NULL", "+CTYPE-OPENPGP",
1691
# "+DHE-DSS"))
2272
1692
# Use a fallback default, since this MUST be set.
2273
1693
priority = self.server.gnutls_priority
2274
1694
if priority is None:
2275
1695
priority = "NORMAL"
2276
gnutls.priority_set_direct(session._c_object,
2277
priority.encode("utf-8"),
2278
None)
2279
1696
(gnutls.library.functions
1697
.gnutls_priority_set_direct(session._c_object,
1698
priority, None))
1699
2280
1700
# Start communication using the Mandos protocol
2281
1701
# Get protocol number
2282
1702
line = self.request.makefile().readline()
2287
1707
except (ValueError, IndexError, RuntimeError) as error:
2288
1708
logger.error("Unknown protocol version: %s", error)
2289
1709
return
2290
1710
2291
1711
# Start GnuTLS connection
2292
1712
try:
2293
1713
session.handshake()
2294
except gnutls.Error as error:
1714
except gnutls.errors.GNUTLSError as error:
2295
1715
logger.warning("Handshake failed: %s", error)
2296
1716
# Do not run session.bye() here: the session is not
2297
1717
# established. Just abandon the request.
2298
1718
return
2299
1719
logger.debug("Handshake succeeded")
2300
1720
2301
1721
approval_required = False
2302
1722
try:
2303
if gnutls.has_rawpk:
2304
fpr = b""
2305
try:
2306
key_id = self.key_id(
2307
self.peer_certificate(session))
2308
except (TypeError, gnutls.Error) as error:
2309
logger.warning("Bad certificate: %s", error)
2310
return
2311
logger.debug("Key ID: %s", key_id)
2312
2313
else:
2314
key_id = b""
2315
try:
2316
fpr = self.fingerprint(
2317
self.peer_certificate(session))
2318
except (TypeError, gnutls.Error) as error:
2319
logger.warning("Bad certificate: %s", error)
2320
return
2321
logger.debug("Fingerprint: %s", fpr)
2322
2323
try:
2324
client = ProxyClient(child_pipe, key_id, fpr,
1723
try:
1724
fpr = self.fingerprint(self.peer_certificate
1725
(session))
1726
except (TypeError,
1727
gnutls.errors.GNUTLSError) as error:
1728
logger.warning("Bad certificate: %s", error)
1729
return
1730
logger.debug("Fingerprint: %s", fpr)
1731
1732
try:
1733
client = ProxyClient(child_pipe, fpr,
2325
1734
self.client_address)
2326
1735
except KeyError:
2327
1736
return
2328
1737
2329
1738
if client.approval_delay:
2330
1739
delay = client.approval_delay
2331
1740
client.approvals_pending += 1
2332
1741
approval_required = True
2333
1742
2334
1743
while True:
2335
1744
if not client.enabled:
2336
1745
logger.info("Client %s is disabled",
2337
client.name)
1746
client.name)
2338
1747
if self.server.use_dbus:
2339
1748
# Emit D-Bus signal
2340
1749
client.Rejected("Disabled")
2341
1750
return
2342
1751
2343
1752
if client.approved or not client.approval_delay:
2344
# We are approved or approval is disabled
1753
#We are approved or approval is disabled
2345
1754
break
2346
1755
elif client.approved is None:
2347
1756
logger.info("Client %s needs approval",
2349
1758
if self.server.use_dbus:
2350
1759
# Emit D-Bus signal
2351
1760
client.NeedApproval(
2352
client.approval_delay.total_seconds()
2353
* 1000, client.approved_by_default)
1761
client.approval_delay_milliseconds(),
1762
client.approved_by_default)
2354
1763
else:
2355
1764
logger.warning("Client %s was not approved",
2356
1765
client.name)
2358
1767
# Emit D-Bus signal
2359
1768
client.Rejected("Denied")
2360
1769
return
2361
2362
# wait until timeout or approved
1770
1771
#wait until timeout or approved
2363
1772
time = datetime.datetime.now()
2364
1773
client.changedstate.acquire()
2365
client.changedstate.wait(delay.total_seconds())
1774
client.changedstate.wait(
1775
float(timedelta_to_milliseconds(delay)
1776
/ 1000))
2366
1777
client.changedstate.release()
2367
1778
time2 = datetime.datetime.now()
2368
1779
if (time2 - time) >= delay:
2378
1789
break
2379
1790
else:
2380
1791
delay -= time2 - time
2381
2382
try:
2383
session.send(client.secret)
2384
except gnutls.Error as error:
2385
logger.warning("gnutls send failed",
2386
exc_info=error)
2387
return
2388
1792
1793
sent_size = 0
1794
while sent_size < len(client.secret):
1795
try:
1796
sent = session.send(client.secret[sent_size:])
1797
except gnutls.errors.GNUTLSError as error:
1798
logger.warning("gnutls send failed",
1799
exc_info=error)
1800
return
1801
logger.debug("Sent: %d, remaining: %d",
1802
sent, len(client.secret)
1803
- (sent_size + sent))
1804
sent_size += sent
1805
2389
1806
logger.info("Sending secret to %s", client.name)
2390
1807
# bump the timeout using extended_timeout
2391
1808
client.bump_timeout(client.extended_timeout)
2392
1809
if self.server.use_dbus:
2393
1810
# Emit D-Bus signal
2394
1811
client.GotSecret()
2395
1812
2396
1813
finally:
2397
1814
if approval_required:
2398
1815
client.approvals_pending -= 1
2399
1816
try:
2400
1817
session.bye()
2401
except gnutls.Error as error:
1818
except gnutls.errors.GNUTLSError as error:
2402
1819
logger.warning("GnuTLS bye failed",
2403
1820
exc_info=error)
2404
1821
2405
1822
@staticmethod
2406
1823
def peer_certificate(session):
2407
"Return the peer's certificate as a bytestring"
2408
try:
2409
cert_type = gnutls.certificate_type_get2(session._c_object,
2410
gnutls.CTYPE_PEERS)
2411
except AttributeError:
2412
cert_type = gnutls.certificate_type_get(session._c_object)
2413
if gnutls.has_rawpk:
2414
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2415
else:
2416
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2417
# If not a valid certificate type...
2418
if cert_type not in valid_cert_types:
2419
logger.info("Cert type %r not in %r", cert_type,
2420
valid_cert_types)
2421
# ...return invalid data
2422
return b""
1824
"Return the peer's OpenPGP certificate as a bytestring"
1825
# If not an OpenPGP certificate...
1826
if (gnutls.library.functions
1827
.gnutls_certificate_type_get(session._c_object)
1828
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1829
# ...do the normal thing
1830
return session.peer_certificate
2423
1831
list_size = ctypes.c_uint(1)
2424
cert_list = (gnutls.certificate_get_peers
1832
cert_list = (gnutls.library.functions
1833
.gnutls_certificate_get_peers
2425
1834
(session._c_object, ctypes.byref(list_size)))
2426
1835
if not bool(cert_list) and list_size.value != 0:
2427
raise gnutls.Error("error getting peer certificate")
1836
raise gnutls.errors.GNUTLSError("error getting peer"
1837
" certificate")
2428
1838
if list_size.value == 0:
2429
1839
return None
2430
1840
cert = cert_list[0]
2431
1841
return ctypes.string_at(cert.data, cert.size)
2432
2433
@staticmethod
2434
def key_id(certificate):
2435
"Convert a certificate bytestring to a hexdigit key ID"
2436
# New GnuTLS "datum" with the public key
2437
datum = gnutls.datum_t(
2438
ctypes.cast(ctypes.c_char_p(certificate),
2439
ctypes.POINTER(ctypes.c_ubyte)),
2440
ctypes.c_uint(len(certificate)))
2441
# XXX all these need to be created in the gnutls "module"
2442
# New empty GnuTLS certificate
2443
pubkey = gnutls.pubkey_t()
2444
gnutls.pubkey_init(ctypes.byref(pubkey))
2445
# Import the raw public key into the certificate
2446
gnutls.pubkey_import(pubkey,
2447
ctypes.byref(datum),
2448
gnutls.X509_FMT_DER)
2449
# New buffer for the key ID
2450
buf = ctypes.create_string_buffer(32)
2451
buf_len = ctypes.c_size_t(len(buf))
2452
# Get the key ID from the raw public key into the buffer
2453
gnutls.pubkey_get_key_id(pubkey,
2454
gnutls.KEYID_USE_SHA256,
2455
ctypes.cast(ctypes.byref(buf),
2456
ctypes.POINTER(ctypes.c_ubyte)),
2457
ctypes.byref(buf_len))
2458
# Deinit the certificate
2459
gnutls.pubkey_deinit(pubkey)
2460
2461
# Convert the buffer to a Python bytestring
2462
key_id = ctypes.string_at(buf, buf_len.value)
2463
# Convert the bytestring to hexadecimal notation
2464
hex_key_id = binascii.hexlify(key_id).upper()
2465
return hex_key_id
2466
1842
2467
1843
@staticmethod
2468
1844
def fingerprint(openpgp):
2469
1845
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2470
1846
# New GnuTLS "datum" with the OpenPGP public key
2471
datum = gnutls.datum_t(
2472
ctypes.cast(ctypes.c_char_p(openpgp),
2473
ctypes.POINTER(ctypes.c_ubyte)),
2474
ctypes.c_uint(len(openpgp)))
1847
datum = (gnutls.library.types
1848
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1849
ctypes.POINTER
1850
(ctypes.c_ubyte)),
1851
ctypes.c_uint(len(openpgp))))
2475
1852
# New empty GnuTLS certificate
2476
crt = gnutls.openpgp_crt_t()
2477
gnutls.openpgp_crt_init(ctypes.byref(crt))
1853
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2478
1856
# Import the OpenPGP public key into the certificate
2479
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2480
gnutls.OPENPGP_FMT_RAW)
1857
(gnutls.library.functions
1858
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1859
gnutls.library.constants
1860
.GNUTLS_OPENPGP_FMT_RAW))
2481
1861
# Verify the self signature in the key
2482
1862
crtverify = ctypes.c_uint()
2483
gnutls.openpgp_crt_verify_self(crt, 0,
2484
ctypes.byref(crtverify))
1863
(gnutls.library.functions
1864
.gnutls_openpgp_crt_verify_self(crt, 0,
1865
ctypes.byref(crtverify)))
2485
1866
if crtverify.value != 0:
2486
gnutls.openpgp_crt_deinit(crt)
2487
raise gnutls.CertificateSecurityError(code
2488
=crtverify.value)
1867
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1868
raise (gnutls.errors.CertificateSecurityError
1869
("Verify failed"))
2489
1870
# New buffer for the fingerprint
2490
1871
buf = ctypes.create_string_buffer(20)
2491
1872
buf_len = ctypes.c_size_t()
2492
1873
# Get the fingerprint from the certificate into the buffer
2493
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2494
ctypes.byref(buf_len))
1874
(gnutls.library.functions
1875
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1876
ctypes.byref(buf_len)))
2495
1877
# Deinit the certificate
2496
gnutls.openpgp_crt_deinit(crt)
1878
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2497
1879
# Convert the buffer to a Python bytestring
2498
1880
fpr = ctypes.string_at(buf, buf_len.value)
2499
1881
# Convert the bytestring to hexadecimal notation
2501
1883
return hex_fpr
2502
1884
2503
1885
2504
class MultiprocessingMixIn:
1886
class MultiprocessingMixIn(object):
2505
1887
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2506
2507
1888
def sub_process_main(self, request, address):
2508
1889
try:
2509
1890
self.finish_request(request, address)
2510
1891
except Exception:
2511
1892
self.handle_error(request, address)
2512
1893
self.close_request(request)
2513
1894
2514
1895
def process_request(self, request, address):
2515
1896
"""Start a new process to process the request."""
2516
proc = multiprocessing.Process(target=self.sub_process_main,
2517
args=(request, address))
1897
proc = multiprocessing.Process(target = self.sub_process_main,
1898
args = (request, address))
2518
1899
proc.start()
2519
1900
return proc
2520
1901
2521
1902
2522
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1903
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2523
1904
""" adds a pipe to the MixIn """
2524
2525
1905
def process_request(self, request, client_address):
2526
1906
"""Overrides and wraps the original process_request().
2527
1907
2528
1908
This function creates a new pipe in self.pipe
2529
1909
"""
2530
1910
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2531
1911
2532
1912
proc = MultiprocessingMixIn.process_request(self, request,
2533
1913
client_address)
2534
1914
self.child_pipe.close()
2535
1915
self.add_pipe(parent_pipe, proc)
2536
1916
2537
1917
def add_pipe(self, parent_pipe, proc):
2538
1918
"""Dummy function; override as necessary"""
2539
1919
raise NotImplementedError()
2540
1920
2541
1921
2542
1922
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2543
socketserver.TCPServer):
1923
socketserver.TCPServer, object):
2544
1924
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2545
1925
2546
1926
Attributes:
2547
1927
enabled: Boolean; whether this server is activated yet
2548
1928
interface: None or a network interface name (string)
2549
1929
use_ipv6: Boolean; to use IPv6 or not
2550
1930
"""
2551
2552
1931
def __init__(self, server_address, RequestHandlerClass,
2553
interface=None,
2554
use_ipv6=True,
2555
socketfd=None):
1932
interface=None, use_ipv6=True, socketfd=None):
2556
1933
"""If socketfd is set, use that file descriptor instead of
2557
1934
creating a new one with socket.socket().
2558
1935
"""
2564
1941
self.socketfd = socketfd
2565
1942
# Save the original socket.socket() function
2566
1943
self.socket_socket = socket.socket
2567
2568
1944
# To implement --socket, we monkey patch socket.socket.
2569
#
1945
#
2570
1946
# (When socketserver.TCPServer is a new-style class, we
2571
1947
# could make self.socket into a property instead of monkey
2572
1948
# patching socket.socket.)
2573
#
1949
#
2574
1950
# Create a one-time-only replacement for socket.socket()
2575
1951
@functools.wraps(socket.socket)
2576
1952
def socket_wrapper(*args, **kwargs):
2588
1964
# socket_wrapper(), if socketfd was set.
2589
1965
socketserver.TCPServer.__init__(self, server_address,
2590
1966
RequestHandlerClass)
2591
1967
2592
1968
def server_bind(self):
2593
1969
"""This overrides the normal server_bind() function
2594
1970
to bind to an interface if one was specified, and also NOT to
2595
1971
bind to an address or port if they were not specified."""
2596
global SO_BINDTODEVICE
2597
1972
if self.interface is not None:
2598
1973
if SO_BINDTODEVICE is None:
2599
# Fall back to a hard-coded value which seems to be
2600
# common enough.
2601
logger.warning("SO_BINDTODEVICE not found, trying 25")
2602
SO_BINDTODEVICE = 25
2603
try:
2604
self.socket.setsockopt(
2605
socket.SOL_SOCKET, SO_BINDTODEVICE,
2606
(self.interface + "\0").encode("utf-8"))
2607
except socket.error as error:
2608
if error.errno == errno.EPERM:
2609
logger.error("No permission to bind to"
2610
" interface %s", self.interface)
2611
elif error.errno == errno.ENOPROTOOPT:
2612
logger.error("SO_BINDTODEVICE not available;"
2613
" cannot bind to interface %s",
2614
self.interface)
2615
elif error.errno == errno.ENODEV:
2616
logger.error("Interface %s does not exist,"
2617
" cannot bind", self.interface)
2618
else:
2619
raise
1974
logger.error("SO_BINDTODEVICE does not exist;"
1975
" cannot bind to interface %s",
1976
self.interface)
1977
else:
1978
try:
1979
self.socket.setsockopt(socket.SOL_SOCKET,
1980
SO_BINDTODEVICE,
1981
str(self.interface + '\0'))
1982
except socket.error as error:
1983
if error.errno == errno.EPERM:
1984
logger.error("No permission to bind to"
1985
" interface %s", self.interface)
1986
elif error.errno == errno.ENOPROTOOPT:
1987
logger.error("SO_BINDTODEVICE not available;"
1988
" cannot bind to interface %s",
1989
self.interface)
1990
elif error.errno == errno.ENODEV:
1991
logger.error("Interface %s does not exist,"
1992
" cannot bind", self.interface)
1993
else:
1994
raise
2620
1995
# Only bind(2) the socket if we really need to.
2621
1996
if self.server_address[0] or self.server_address[1]:
2622
if self.server_address[1]:
2623
self.allow_reuse_address = True
2624
1997
if not self.server_address[0]:
2625
1998
if self.address_family == socket.AF_INET6:
2626
any_address = "::" # in6addr_any
1999
any_address = "::" # in6addr_any
2627
2000
else:
2628
any_address = "0.0.0.0" # INADDR_ANY
2001
any_address = "0.0.0.0" # INADDR_ANY
2629
2002
self.server_address = (any_address,
2630
2003
self.server_address[1])
2631
2004
elif not self.server_address[1]:
2632
self.server_address = (self.server_address[0], 0)
2005
self.server_address = (self.server_address[0],
2006
0)
2633
2007
# if self.interface:
2634
2008
# self.server_address = (self.server_address[0],
2635
2009
# 0, # port
2641
2015
2642
2016
class MandosServer(IPv6_TCPServer):
2643
2017
"""Mandos server.
2644
2018
2645
2019
Attributes:
2646
2020
clients: set of Client objects
2647
2021
gnutls_priority GnuTLS priority string
2648
2022
use_dbus: Boolean; to emit D-Bus signals or not
2649
2650
Assumes a GLib.MainLoop event loop.
2023
2024
Assumes a gobject.MainLoop event loop.
2651
2025
"""
2652
2653
2026
def __init__(self, server_address, RequestHandlerClass,
2654
interface=None,
2655
use_ipv6=True,
2656
clients=None,
2657
gnutls_priority=None,
2658
use_dbus=True,
2659
socketfd=None):
2027
interface=None, use_ipv6=True, clients=None,
2028
gnutls_priority=None, use_dbus=True, socketfd=None):
2660
2029
self.enabled = False
2661
2030
self.clients = clients
2662
2031
if self.clients is None:
2665
2034
self.gnutls_priority = gnutls_priority
2666
2035
IPv6_TCPServer.__init__(self, server_address,
2667
2036
RequestHandlerClass,
2668
interface=interface,
2669
use_ipv6=use_ipv6,
2670
socketfd=socketfd)
2671
2037
interface = interface,
2038
use_ipv6 = use_ipv6,
2039
socketfd = socketfd)
2672
2040
def server_activate(self):
2673
2041
if self.enabled:
2674
2042
return socketserver.TCPServer.server_activate(self)
2675
2043
2676
2044
def enable(self):
2677
2045
self.enabled = True
2678
2046
2679
2047
def add_pipe(self, parent_pipe, proc):
2680
2048
# Call "handle_ipc" for both data and EOF events
2681
GLib.io_add_watch(
2682
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2683
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2684
functools.partial(self.handle_ipc,
2685
parent_pipe=parent_pipe,
2686
proc=proc))
2687
2688
def handle_ipc(self, source, condition,
2689
parent_pipe=None,
2690
proc=None,
2691
client_object=None):
2049
gobject.io_add_watch(parent_pipe.fileno(),
2050
gobject.IO_IN | gobject.IO_HUP,
2051
functools.partial(self.handle_ipc,
2052
parent_pipe =
2053
parent_pipe,
2054
proc = proc))
2055
2056
def handle_ipc(self, source, condition, parent_pipe=None,
2057
proc = None, client_object=None):
2692
2058
# error, or the other end of multiprocessing.Pipe has closed
2693
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2059
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2694
2060
# Wait for other process to exit
2695
2061
proc.join()
2696
2062
return False
2697
2063
2698
2064
# Read a request from the child
2699
2065
request = parent_pipe.recv()
2700
2066
command = request[0]
2701
2067
2702
2068
if command == 'init':
2703
key_id = request[1].decode("ascii")
2704
fpr = request[2].decode("ascii")
2705
address = request[3]
2706
2707
for c in self.clients.values():
2708
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2709
continue
2710
if key_id and c.key_id == key_id:
2711
client = c
2712
break
2713
if fpr and c.fingerprint == fpr:
2069
fpr = request[1]
2070
address = request[2]
2071
2072
for c in self.clients.itervalues():
2073
if c.fingerprint == fpr:
2714
2074
client = c
2715
2075
break
2716
2076
else:
2717
logger.info("Client not found for key ID: %s, address"
2718
": %s", key_id or fpr, address)
2077
logger.info("Client not found for fingerprint: %s, ad"
2078
"dress: %s", fpr, address)
2719
2079
if self.use_dbus:
2720
2080
# Emit D-Bus signal
2721
mandos_dbus_service.ClientNotFound(key_id or fpr,
2081
mandos_dbus_service.ClientNotFound(fpr,
2722
2082
address[0])
2723
2083
parent_pipe.send(False)
2724
2084
return False
2725
2726
GLib.io_add_watch(
2727
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2728
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2729
functools.partial(self.handle_ipc,
2730
parent_pipe=parent_pipe,
2731
proc=proc,
2732
client_object=client))
2085
2086
gobject.io_add_watch(parent_pipe.fileno(),
2087
gobject.IO_IN | gobject.IO_HUP,
2088
functools.partial(self.handle_ipc,
2089
parent_pipe =
2090
parent_pipe,
2091
proc = proc,
2092
client_object =
2093
client))
2733
2094
parent_pipe.send(True)
2734
2095
# remove the old hook in favor of the new above hook on
2735
2096
# same fileno
2738
2099
funcname = request[1]
2739
2100
args = request[2]
2740
2101
kwargs = request[3]
2741
2102
2742
2103
parent_pipe.send(('data', getattr(client_object,
2743
2104
funcname)(*args,
2744
**kwargs)))
2745
2105
**kwargs)))
2106
2746
2107
if command == 'getattr':
2747
2108
attrname = request[1]
2748
if isinstance(client_object.__getattribute__(attrname),
2749
collections.Callable):
2750
parent_pipe.send(('function', ))
2109
if callable(client_object.__getattribute__(attrname)):
2110
parent_pipe.send(('function',))
2751
2111
else:
2752
parent_pipe.send((
2753
'data', client_object.__getattribute__(attrname)))
2754
2112
parent_pipe.send(('data', client_object
2113
.__getattribute__(attrname)))
2114
2755
2115
if command == 'setattr':
2756
2116
attrname = request[1]
2757
2117
value = request[2]
2758
2118
setattr(client_object, attrname, value)
2759
2119
2760
2120
return True
2761
2121
2762
2122
2763
2123
def rfc3339_duration_to_delta(duration):
2764
2124
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2765
2766
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2767
True
2768
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2769
True
2770
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2771
True
2772
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2773
True
2774
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2775
True
2776
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2777
True
2778
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2779
True
2125
2126
>>> rfc3339_duration_to_delta("P7D")
2127
datetime.timedelta(7)
2128
>>> rfc3339_duration_to_delta("PT60S")
2129
datetime.timedelta(0, 60)
2130
>>> rfc3339_duration_to_delta("PT60M")
2131
datetime.timedelta(0, 3600)
2132
>>> rfc3339_duration_to_delta("PT24H")
2133
datetime.timedelta(1)
2134
>>> rfc3339_duration_to_delta("P1W")
2135
datetime.timedelta(7)
2136
>>> rfc3339_duration_to_delta("PT5M30S")
2137
datetime.timedelta(0, 330)
2138
>>> rfc3339_duration_to_delta("P1DT3M20S")
2139
datetime.timedelta(1, 200)
2780
2140
"""
2781
2141
2782
2142
# Parsing an RFC 3339 duration with regular expressions is not
2783
2143
# possible - there would have to be multiple places for the same
2784
2144
# values, like seconds. The current code, while more esoteric, is
2785
2145
# cleaner without depending on a parsing library. If Python had a
2786
2146
# built-in library for parsing we would use it, but we'd like to
2787
2147
# avoid excessive use of external libraries.
2788
2148
2789
2149
# New type for defining tokens, syntax, and semantics all-in-one
2790
Token = collections.namedtuple("Token", (
2791
"regexp", # To match token; if "value" is not None, must have
2792
# a "group" containing digits
2793
"value", # datetime.timedelta or None
2794
"followers")) # Tokens valid after this token
2150
Token = collections.namedtuple("Token",
2151
("regexp", # To match token; if
2152
# "value" is not None,
2153
# must have a "group"
2154
# containing digits
2155
"value", # datetime.timedelta or
2156
# None
2157
"followers")) # Tokens valid after
2158
# this token
2795
2159
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2796
2160
# the "duration" ABNF definition in RFC 3339, Appendix A.
2797
2161
token_end = Token(re.compile(r"$"), None, frozenset())
2798
2162
token_second = Token(re.compile(r"(\d+)S"),
2799
2163
datetime.timedelta(seconds=1),
2800
frozenset((token_end, )))
2164
frozenset((token_end,)))
2801
2165
token_minute = Token(re.compile(r"(\d+)M"),
2802
2166
datetime.timedelta(minutes=1),
2803
2167
frozenset((token_second, token_end)))
2819
2183
frozenset((token_month, token_end)))
2820
2184
token_week = Token(re.compile(r"(\d+)W"),
2821
2185
datetime.timedelta(weeks=1),
2822
frozenset((token_end, )))
2186
frozenset((token_end,)))
2823
2187
token_duration = Token(re.compile(r"P"), None,
2824
2188
frozenset((token_year, token_month,
2825
2189
token_day, token_time,
2826
token_week)))
2827
# Define starting values:
2828
# Value so far
2829
value = datetime.timedelta()
2190
token_week))),
2191
# Define starting values
2192
value = datetime.timedelta() # Value so far
2830
2193
found_token = None
2831
# Following valid tokens
2832
followers = frozenset((token_duration, ))
2833
# String left to parse
2834
s = duration
2194
followers = frozenset(token_duration,) # Following valid tokens
2195
s = duration # String left to parse
2835
2196
# Loop until end token is found
2836
2197
while found_token is not token_end:
2837
2198
# Search for any currently valid tokens
2853
2214
break
2854
2215
else:
2855
2216
# No currently valid tokens were found
2856
raise ValueError("Invalid RFC 3339 duration: {!r}"
2857
.format(duration))
2217
raise ValueError("Invalid RFC 3339 duration")
2858
2218
# End token found
2859
2219
return value
2860
2220
2861
2221
2862
2222
def string_to_delta(interval):
2863
2223
"""Parse a string and return a datetime.timedelta
2864
2865
>>> string_to_delta('7d') == datetime.timedelta(7)
2866
True
2867
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2868
True
2869
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2870
True
2871
>>> string_to_delta('24h') == datetime.timedelta(1)
2872
True
2873
>>> string_to_delta('1w') == datetime.timedelta(7)
2874
True
2875
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2876
True
2224
2225
>>> string_to_delta('7d')
2226
datetime.timedelta(7)
2227
>>> string_to_delta('60s')
2228
datetime.timedelta(0, 60)
2229
>>> string_to_delta('60m')
2230
datetime.timedelta(0, 3600)
2231
>>> string_to_delta('24h')
2232
datetime.timedelta(1)
2233
>>> string_to_delta('1w')
2234
datetime.timedelta(7)
2235
>>> string_to_delta('5m 30s')
2236
datetime.timedelta(0, 330)
2877
2237
"""
2878
2238
2879
2239
try:
2880
2240
return rfc3339_duration_to_delta(interval)
2881
2241
except ValueError:
2882
2242
pass
2883
2243
2884
2244
timevalue = datetime.timedelta(0)
2885
2245
for s in interval.split():
2886
2246
try:
2887
suffix = s[-1]
2247
suffix = unicode(s[-1])
2888
2248
value = int(s[:-1])
2889
2249
if suffix == "d":
2890
2250
delta = datetime.timedelta(value)
2897
2257
elif suffix == "w":
2898
2258
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2899
2259
else:
2900
raise ValueError("Unknown suffix {!r}".format(suffix))
2260
raise ValueError("Unknown suffix {0!r}"
2261
.format(suffix))
2901
2262
except IndexError as e:
2902
2263
raise ValueError(*(e.args))
2903
2264
timevalue += delta
2904
2265
return timevalue
2905
2266
2906
2267
2907
def daemon(nochdir=False, noclose=False):
2268
def daemon(nochdir = False, noclose = False):
2908
2269
"""See daemon(3). Standard BSD Unix function.
2909
2270
2910
2271
This should really exist as os.daemon, but it doesn't (yet)."""
2911
2272
if os.fork():
2912
2273
sys.exit()
2920
2281
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2921
2282
if not stat.S_ISCHR(os.fstat(null).st_mode):
2922
2283
raise OSError(errno.ENODEV,
2923
"{} not a character device"
2284
"{0} not a character device"
2924
2285
.format(os.devnull))
2925
2286
os.dup2(null, sys.stdin.fileno())
2926
2287
os.dup2(null, sys.stdout.fileno())
2930
2291
2931
2292
2932
2293
def main():
2933
2294
2934
2295
##################################################################
2935
2296
# Parsing of options, both command line and config file
2936
2297
2937
2298
parser = argparse.ArgumentParser()
2938
2299
parser.add_argument("-v", "--version", action="version",
2939
version="%(prog)s {}".format(version),
2300
version = "%(prog)s {0}".format(version),
2940
2301
help="show version number and exit")
2941
2302
parser.add_argument("-i", "--interface", metavar="IF",
2942
2303
help="Bind to interface IF")
2975
2336
help="Directory to save/restore state in")
2976
2337
parser.add_argument("--foreground", action="store_true",
2977
2338
help="Run in foreground", default=None)
2978
parser.add_argument("--no-zeroconf", action="store_false",
2979
dest="zeroconf", help="Do not use Zeroconf",
2980
default=None)
2981
2339
2982
2340
options = parser.parse_args()
2983
2341
2342
if options.check:
2343
import doctest
2344
fail_count, test_count = doctest.testmod()
2345
sys.exit(os.EX_OK if fail_count == 0 else 1)
2346
2984
2347
# Default values for config file for server-global settings
2985
if gnutls.has_rawpk:
2986
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2987
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2988
else:
2989
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2990
":+SIGN-DSA-SHA256")
2991
server_defaults = {"interface": "",
2992
"address": "",
2993
"port": "",
2994
"debug": "False",
2995
"priority": priority,
2996
"servicename": "Mandos",
2997
"use_dbus": "True",
2998
"use_ipv6": "True",
2999
"debuglevel": "",
3000
"restore": "True",
3001
"socket": "",
3002
"statedir": "/var/lib/mandos",
3003
"foreground": "False",
3004
"zeroconf": "True",
3005
}
3006
del priority
3007
2348
server_defaults = { "interface": "",
2349
"address": "",
2350
"port": "",
2351
"debug": "False",
2352
"priority":
2353
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2354
"servicename": "Mandos",
2355
"use_dbus": "True",
2356
"use_ipv6": "True",
2357
"debuglevel": "",
2358
"restore": "True",
2359
"socket": "",
2360
"statedir": "/var/lib/mandos",
2361
"foreground": "False",
2362
}
2363
3008
2364
# Parse config file for server-global settings
3009
server_config = configparser.ConfigParser(server_defaults)
2365
server_config = configparser.SafeConfigParser(server_defaults)
3010
2366
del server_defaults
3011
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3012
# Convert the ConfigParser object to a dict
2367
server_config.read(os.path.join(options.configdir,
2368
"mandos.conf"))
2369
# Convert the SafeConfigParser object to a dict
3013
2370
server_settings = server_config.defaults()
3014
2371
# Use the appropriate methods on the non-string config options
3015
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
"foreground", "zeroconf"):
2372
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
3017
2373
server_settings[option] = server_config.getboolean("DEFAULT",
3018
2374
option)
3019
2375
if server_settings["port"]:
3029
2385
server_settings["socket"] = os.dup(server_settings
3030
2386
["socket"])
3031
2387
del server_config
3032
2388
3033
2389
# Override the settings from the config file with command line
3034
2390
# options, if set.
3035
2391
for option in ("interface", "address", "port", "debug",
3036
"priority", "servicename", "configdir", "use_dbus",
3037
"use_ipv6", "debuglevel", "restore", "statedir",
3038
"socket", "foreground", "zeroconf"):
2392
"priority", "servicename", "configdir",
2393
"use_dbus", "use_ipv6", "debuglevel", "restore",
2394
"statedir", "socket", "foreground"):
3039
2395
value = getattr(options, option)
3040
2396
if value is not None:
3041
2397
server_settings[option] = value
3042
2398
del options
3043
2399
# Force all strings to be unicode
3044
2400
for option in server_settings.keys():
3045
if isinstance(server_settings[option], bytes):
3046
server_settings[option] = (server_settings[option]
3047
.decode("utf-8"))
2401
if type(server_settings[option]) is str:
2402
server_settings[option] = unicode(server_settings[option])
3048
2403
# Force all boolean options to be boolean
3049
2404
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3050
"foreground", "zeroconf"):
2405
"foreground"):
3051
2406
server_settings[option] = bool(server_settings[option])
3052
2407
# Debug implies foreground
3053
2408
if server_settings["debug"]:
3054
2409
server_settings["foreground"] = True
3055
2410
# Now we have our good server settings in "server_settings"
3056
2411
3057
2412
##################################################################
3058
3059
if (not server_settings["zeroconf"]
3060
and not (server_settings["port"]
3061
or server_settings["socket"] != "")):
3062
parser.error("Needs port or socket to work without Zeroconf")
3063
2413
3064
2414
# For convenience
3065
2415
debug = server_settings["debug"]
3066
2416
debuglevel = server_settings["debuglevel"]
3069
2419
stored_state_path = os.path.join(server_settings["statedir"],
3070
2420
stored_state_file)
3071
2421
foreground = server_settings["foreground"]
3072
zeroconf = server_settings["zeroconf"]
3073
2422
3074
2423
if debug:
3075
2424
initlogger(debug, logging.DEBUG)
3076
2425
else:
3079
2428
else:
3080
2429
level = getattr(logging, debuglevel.upper())
3081
2430
initlogger(debug, level)
3082
2431
3083
2432
if server_settings["servicename"] != "Mandos":
3084
syslogger.setFormatter(
3085
logging.Formatter('Mandos ({}) [%(process)d]:'
3086
' %(levelname)s: %(message)s'.format(
3087
server_settings["servicename"])))
3088
2433
syslogger.setFormatter(logging.Formatter
2434
('Mandos ({0}) [%(process)d]:'
2435
' %(levelname)s: %(message)s'
2436
.format(server_settings
2437
["servicename"])))
2438
3089
2439
# Parse config file with clients
3090
client_config = configparser.ConfigParser(Client.client_defaults)
2440
client_config = configparser.SafeConfigParser(Client
2441
.client_defaults)
3091
2442
client_config.read(os.path.join(server_settings["configdir"],
3092
2443
"clients.conf"))
3093
2444
3094
2445
global mandos_dbus_service
3095
2446
mandos_dbus_service = None
3096
3097
socketfd = None
3098
if server_settings["socket"] != "":
3099
socketfd = server_settings["socket"]
3100
tcp_server = MandosServer(
3101
(server_settings["address"], server_settings["port"]),
3102
ClientHandler,
3103
interface=(server_settings["interface"] or None),
3104
use_ipv6=use_ipv6,
3105
gnutls_priority=server_settings["priority"],
3106
use_dbus=use_dbus,
3107
socketfd=socketfd)
2447
2448
tcp_server = MandosServer((server_settings["address"],
2449
server_settings["port"]),
2450
ClientHandler,
2451
interface=(server_settings["interface"]
2452
or None),
2453
use_ipv6=use_ipv6,
2454
gnutls_priority=
2455
server_settings["priority"],
2456
use_dbus=use_dbus,
2457
socketfd=(server_settings["socket"]
2458
or None))
3108
2459
if not foreground:
3109
2460
pidfilename = "/run/mandos.pid"
3110
2461
if not os.path.isdir("/run/."):
3111
2462
pidfilename = "/var/run/mandos.pid"
3112
2463
pidfile = None
3113
2464
try:
3114
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2465
pidfile = open(pidfilename, "w")
3115
2466
except IOError as e:
3116
2467
logger.error("Could not open file %r", pidfilename,
3117
2468
exc_info=e)
3118
3119
for name, group in (("_mandos", "_mandos"),
3120
("mandos", "mandos"),
3121
("nobody", "nogroup")):
2469
2470
for name in ("_mandos", "mandos", "nobody"):
3122
2471
try:
3123
2472
uid = pwd.getpwnam(name).pw_uid
3124
gid = pwd.getpwnam(group).pw_gid
2473
gid = pwd.getpwnam(name).pw_gid
3125
2474
break
3126
2475
except KeyError:
3127
2476
continue
3131
2480
try:
3132
2481
os.setgid(gid)
3133
2482
os.setuid(uid)
3134
if debug:
3135
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3136
gid))
3137
2483
except OSError as error:
3138
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3139
.format(uid, gid, os.strerror(error.errno)))
3140
2484
if error.errno != errno.EPERM:
3141
2485
raise
3142
2486
3143
2487
if debug:
3144
2488
# Enable all possible GnuTLS debugging
3145
2489
3146
2490
# "Use a log level over 10 to enable all debugging options."
3147
2491
# - GnuTLS manual
3148
gnutls.global_set_log_level(11)
3149
3150
@gnutls.log_func
2492
gnutls.library.functions.gnutls_global_set_log_level(11)
2493
2494
@gnutls.library.types.gnutls_log_func
3151
2495
def debug_gnutls(level, string):
3152
2496
logger.debug("GnuTLS: %s", string[:-1])
3153
3154
gnutls.global_set_log_function(debug_gnutls)
3155
2497
2498
(gnutls.library.functions
2499
.gnutls_global_set_log_function(debug_gnutls))
2500
3156
2501
# Redirect stdin so all checkers get /dev/null
3157
2502
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3158
2503
os.dup2(null, sys.stdin.fileno())
3159
2504
if null > 2:
3160
2505
os.close(null)
3161
2506
3162
2507
# Need to fork before connecting to D-Bus
3163
2508
if not foreground:
3164
2509
# Close all input and output, do double fork, etc.
3165
2510
daemon()
3166
3167
if gi.version_info < (3, 10, 2):
3168
# multiprocessing will use threads, so before we use GLib we
3169
# need to inform GLib that threads will be used.
3170
GLib.threads_init()
3171
2511
2512
# multiprocessing will use threads, so before we use gobject we
2513
# need to inform gobject that threads will be used.
2514
gobject.threads_init()
2515
3172
2516
global main_loop
3173
2517
# From the Avahi example code
3174
2518
DBusGMainLoop(set_as_default=True)
3175
main_loop = GLib.MainLoop()
2519
main_loop = gobject.MainLoop()
3176
2520
bus = dbus.SystemBus()
3177
2521
# End of Avahi example code
3178
2522
if use_dbus:
3179
2523
try:
3180
2524
bus_name = dbus.service.BusName("se.recompile.Mandos",
3181
bus,
3182
do_not_queue=True)
3183
old_bus_name = dbus.service.BusName(
3184
"se.bsnet.fukt.Mandos", bus,
3185
do_not_queue=True)
3186
except dbus.exceptions.DBusException as e:
2525
bus, do_not_queue=True)
2526
old_bus_name = (dbus.service.BusName
2527
("se.bsnet.fukt.Mandos", bus,
2528
do_not_queue=True))
2529
except dbus.exceptions.NameExistsException as e:
3187
2530
logger.error("Disabling D-Bus:", exc_info=e)
3188
2531
use_dbus = False
3189
2532
server_settings["use_dbus"] = False
3190
2533
tcp_server.use_dbus = False
3191
if zeroconf:
3192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3193
service = AvahiServiceToSyslog(
3194
name=server_settings["servicename"],
3195
servicetype="_mandos._tcp",
3196
protocol=protocol,
3197
bus=bus)
3198
if server_settings["interface"]:
3199
service.interface = if_nametoindex(
3200
server_settings["interface"].encode("utf-8"))
3201
2534
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2535
service = AvahiServiceToSyslog(name =
2536
server_settings["servicename"],
2537
servicetype = "_mandos._tcp",
2538
protocol = protocol, bus = bus)
2539
if server_settings["interface"]:
2540
service.interface = (if_nametoindex
2541
(str(server_settings["interface"])))
2542
3202
2543
global multiprocessing_manager
3203
2544
multiprocessing_manager = multiprocessing.Manager()
3204
2545
3205
2546
client_class = Client
3206
2547
if use_dbus:
3207
client_class = functools.partial(ClientDBus, bus=bus)
3208
2548
client_class = functools.partial(ClientDBus, bus = bus)
2549
3209
2550
client_settings = Client.config_parser(client_config)
3210
2551
old_client_settings = {}
3211
2552
clients_data = {}
3212
2553
3213
2554
# This is used to redirect stdout and stderr for checker processes
3214
2555
global wnull
3215
wnull = open(os.devnull, "w") # A writable /dev/null
2556
wnull = open(os.devnull, "w") # A writable /dev/null
3216
2557
# Only used if server is running in foreground but not in debug
3217
2558
# mode
3218
2559
if debug or not foreground:
3219
2560
wnull.close()
3220
2561
3221
2562
# Get client data and settings from last running state.
3222
2563
if server_settings["restore"]:
3223
2564
try:
3224
2565
with open(stored_state_path, "rb") as stored_state:
3225
if sys.version_info.major == 2:
3226
clients_data, old_client_settings = pickle.load(
3227
stored_state)
3228
else:
3229
bytes_clients_data, bytes_old_client_settings = (
3230
pickle.load(stored_state, encoding="bytes"))
3231
# Fix bytes to strings
3232
# clients_data
3233
# .keys()
3234
clients_data = {(key.decode("utf-8")
3235
if isinstance(key, bytes)
3236
else key): value
3237
for key, value in
3238
bytes_clients_data.items()}
3239
del bytes_clients_data
3240
for key in clients_data:
3241
value = {(k.decode("utf-8")
3242
if isinstance(k, bytes) else k): v
3243
for k, v in
3244
clients_data[key].items()}
3245
clients_data[key] = value
3246
# .client_structure
3247
value["client_structure"] = [
3248
(s.decode("utf-8")
3249
if isinstance(s, bytes)
3250
else s) for s in
3251
value["client_structure"]]
3252
# .name, .host, and .checker_command
3253
for k in ("name", "host", "checker_command"):
3254
if isinstance(value[k], bytes):
3255
value[k] = value[k].decode("utf-8")
3256
if "key_id" not in value:
3257
value["key_id"] = ""
3258
elif "fingerprint" not in value:
3259
value["fingerprint"] = ""
3260
# old_client_settings
3261
# .keys()
3262
old_client_settings = {
3263
(key.decode("utf-8")
3264
if isinstance(key, bytes)
3265
else key): value
3266
for key, value in
3267
bytes_old_client_settings.items()}
3268
del bytes_old_client_settings
3269
# .host and .checker_command
3270
for value in old_client_settings.values():
3271
for attribute in ("host", "checker_command"):
3272
if isinstance(value[attribute], bytes):
3273
value[attribute] = (value[attribute]
3274
.decode("utf-8"))
2566
clients_data, old_client_settings = (pickle.load
2567
(stored_state))
3275
2568
os.remove(stored_state_path)
3276
2569
except IOError as e:
3277
2570
if e.errno == errno.ENOENT:
3278
logger.warning("Could not load persistent state:"
3279
" {}".format(os.strerror(e.errno)))
2571
logger.warning("Could not load persistent state: {0}"
2572
.format(os.strerror(e.errno)))
3280
2573
else:
3281
2574
logger.critical("Could not load persistent state:",
3282
2575
exc_info=e)
3283
2576
raise
3284
2577
except EOFError as e:
3285
2578
logger.warning("Could not load persistent state: "
3286
"EOFError:",
3287
exc_info=e)
3288
2579
"EOFError:", exc_info=e)
2580
3289
2581
with PGPEngine() as pgp:
3290
for client_name, client in clients_data.items():
2582
for client_name, client in clients_data.iteritems():
3291
2583
# Skip removed clients
3292
2584
if client_name not in client_settings:
3293
2585
continue
3294
2586
3295
2587
# Decide which value to use after restoring saved state.
3296
2588
# We have three different values: Old config file,
3297
2589
# new config file, and saved state.
3302
2594
# For each value in new config, check if it
3303
2595
# differs from the old config value (Except for
3304
2596
# the "secret" attribute)
3305
if (name != "secret"
3306
and (value !=
3307
old_client_settings[client_name][name])):
2597
if (name != "secret" and
2598
value != old_client_settings[client_name]
2599
[name]):
3308
2600
client[name] = value
3309
2601
except KeyError:
3310
2602
pass
3311
2603
3312
2604
# Clients who has passed its expire date can still be
3313
# enabled if its last checker was successful. A Client
2605
# enabled if its last checker was successful. Clients
3314
2606
# whose checker succeeded before we stored its state is
3315
2607
# assumed to have successfully run all checkers during
3316
2608
# downtime.
3318
2610
if datetime.datetime.utcnow() >= client["expires"]:
3319
2611
if not client["last_checked_ok"]:
3320
2612
logger.warning(
3321
"disabling client {} - Client never "
3322
"performed a successful checker".format(
3323
client_name))
2613
"disabling client {0} - Client never "
2614
"performed a successful checker"
2615
.format(client_name))
3324
2616
client["enabled"] = False
3325
2617
elif client["last_checker_status"] != 0:
3326
2618
logger.warning(
3327
"disabling client {} - Client last"
3328
" checker failed with error code"
3329
" {}".format(
3330
client_name,
3331
client["last_checker_status"]))
2619
"disabling client {0} - Client "
2620
"last checker failed with error code {1}"
2621
.format(client_name,
2622
client["last_checker_status"]))
3332
2623
client["enabled"] = False
3333
2624
else:
3334
client["expires"] = (
3335
datetime.datetime.utcnow()
3336
+ client["timeout"])
2625
client["expires"] = (datetime.datetime
2626
.utcnow()
2627
+ client["timeout"])
3337
2628
logger.debug("Last checker succeeded,"
3338
" keeping {} enabled".format(
3339
client_name))
2629
" keeping {0} enabled"
2630
.format(client_name))
3340
2631
try:
3341
client["secret"] = pgp.decrypt(
3342
client["encrypted_secret"],
3343
client_settings[client_name]["secret"])
2632
client["secret"] = (
2633
pgp.decrypt(client["encrypted_secret"],
2634
client_settings[client_name]
2635
["secret"]))
3344
2636
except PGPError:
3345
2637
# If decryption fails, we use secret from new settings
3346
logger.debug("Failed to decrypt {} old secret".format(
3347
client_name))
3348
client["secret"] = (client_settings[client_name]
3349
["secret"])
3350
2638
logger.debug("Failed to decrypt {0} old secret"
2639
.format(client_name))
2640
client["secret"] = (
2641
client_settings[client_name]["secret"])
2642
3351
2643
# Add/remove clients based on new changes made to config
3352
2644
for client_name in (set(old_client_settings)
3353
2645
- set(client_settings)):
3355
2647
for client_name in (set(client_settings)
3356
2648
- set(old_client_settings)):
3357
2649
clients_data[client_name] = client_settings[client_name]
3358
2650
3359
2651
# Create all client objects
3360
for client_name, client in clients_data.items():
2652
for client_name, client in clients_data.iteritems():
3361
2653
tcp_server.clients[client_name] = client_class(
3362
name=client_name,
3363
settings=client,
3364
server_settings=server_settings)
3365
2654
name = client_name, settings = client,
2655
server_settings = server_settings)
2656
3366
2657
if not tcp_server.clients:
3367
2658
logger.warning("No clients defined")
3368
2659
3369
2660
if not foreground:
3370
2661
if pidfile is not None:
3371
pid = os.getpid()
3372
2662
try:
3373
2663
with pidfile:
3374
print(pid, file=pidfile)
2664
pid = os.getpid()
2665
pidfile.write(str(pid) + "\n".encode("utf-8"))
3375
2666
except IOError:
3376
2667
logger.error("Could not write to file %r with PID %d",
3377
2668
pidfilename, pid)
3378
2669
del pidfile
3379
2670
del pidfilename
3380
3381
for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
lambda: main_loop.quit() and False)
3384
2671
2672
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2673
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2674
3385
2675
if use_dbus:
3386
3387
@alternate_dbus_interfaces(
3388
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
class MandosDBusService(DBusObjectWithObjectManager):
2676
@alternate_dbus_interfaces({"se.recompile.Mandos":
2677
"se.bsnet.fukt.Mandos"})
2678
class MandosDBusService(DBusObjectWithProperties):
3390
2679
"""A D-Bus proxy object"""
3391
3392
2680
def __init__(self):
3393
2681
dbus.service.Object.__init__(self, bus, "/")
3394
3395
2682
_interface = "se.recompile.Mandos"
3396
2683
2684
@dbus_interface_annotations(_interface)
2685
def _foo(self):
2686
return { "org.freedesktop.DBus.Property"
2687
".EmitsChangedSignal":
2688
"false"}
2689
3397
2690
@dbus.service.signal(_interface, signature="o")
3398
2691
def ClientAdded(self, objpath):
3399
2692
"D-Bus signal"
3400
2693
pass
3401
2694
3402
2695
@dbus.service.signal(_interface, signature="ss")
3403
def ClientNotFound(self, key_id, address):
2696
def ClientNotFound(self, fingerprint, address):
3404
2697
"D-Bus signal"
3405
2698
pass
3406
3407
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3408
"true"})
2699
3409
2700
@dbus.service.signal(_interface, signature="os")
3410
2701
def ClientRemoved(self, objpath, name):
3411
2702
"D-Bus signal"
3412
2703
pass
3413
3414
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3415
"true"})
2704
3416
2705
@dbus.service.method(_interface, out_signature="ao")
3417
2706
def GetAllClients(self):
3418
2707
"D-Bus method"
3419
return dbus.Array(c.dbus_object_path for c in
3420
tcp_server.clients.values())
3421
3422
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3423
"true"})
2708
return dbus.Array(c.dbus_object_path
2709
for c in
2710
tcp_server.clients.itervalues())
2711
3424
2712
@dbus.service.method(_interface,
3425
2713
out_signature="a{oa{sv}}")
3426
2714
def GetAllClientsWithProperties(self):
3427
2715
"D-Bus method"
3428
2716
return dbus.Dictionary(
3429
{c.dbus_object_path: c.GetAll(
3430
"se.recompile.Mandos.Client")
3431
for c in tcp_server.clients.values()},
2717
((c.dbus_object_path, c.GetAll(""))
2718
for c in tcp_server.clients.itervalues()),
3432
2719
signature="oa{sv}")
3433
2720
3434
2721
@dbus.service.method(_interface, in_signature="o")
3435
2722
def RemoveClient(self, object_path):
3436
2723
"D-Bus method"
3437
for c in tcp_server.clients.values():
2724
for c in tcp_server.clients.itervalues():
3438
2725
if c.dbus_object_path == object_path:
3439
2726
del tcp_server.clients[c.name]
3440
2727
c.remove_from_connection()
3441
# Don't signal the disabling
2728
# Don't signal anything except ClientRemoved
3442
2729
c.disable(quiet=True)
3443
# Emit D-Bus signal for removal
3444
self.client_removed_signal(c)
2730
# Emit D-Bus signal
2731
self.ClientRemoved(object_path, c.name)
3445
2732
return
3446
2733
raise KeyError(object_path)
3447
2734
3448
2735
del _interface
3449
3450
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3451
out_signature="a{oa{sa{sv}}}")
3452
def GetManagedObjects(self):
3453
"""D-Bus method"""
3454
return dbus.Dictionary(
3455
{client.dbus_object_path:
3456
dbus.Dictionary(
3457
{interface: client.GetAll(interface)
3458
for interface in
3459
client._get_all_interface_names()})
3460
for client in tcp_server.clients.values()})
3461
3462
def client_added_signal(self, client):
3463
"""Send the new standard signal and the old signal"""
3464
if use_dbus:
3465
# New standard signal
3466
self.InterfacesAdded(
3467
client.dbus_object_path,
3468
dbus.Dictionary(
3469
{interface: client.GetAll(interface)
3470
for interface in
3471
client._get_all_interface_names()}))
3472
# Old signal
3473
self.ClientAdded(client.dbus_object_path)
3474
3475
def client_removed_signal(self, client):
3476
"""Send the new standard signal and the old signal"""
3477
if use_dbus:
3478
# New standard signal
3479
self.InterfacesRemoved(
3480
client.dbus_object_path,
3481
client._get_all_interface_names())
3482
# Old signal
3483
self.ClientRemoved(client.dbus_object_path,
3484
client.name)
3485
2736
3486
2737
mandos_dbus_service = MandosDBusService()
3487
3488
# Save modules to variables to exempt the modules from being
3489
# unloaded before the function registered with atexit() is run.
3490
mp = multiprocessing
3491
wn = wnull
3492
2738
3493
2739
def cleanup():
3494
2740
"Cleanup function; run on exit"
3495
if zeroconf:
3496
service.cleanup()
3497
3498
mp.active_children()
3499
wn.close()
2741
service.cleanup()
2742
2743
multiprocessing.active_children()
2744
wnull.close()
3500
2745
if not (tcp_server.clients or client_settings):
3501
2746
return
3502
2747
3503
2748
# Store client before exiting. Secrets are encrypted with key
3504
2749
# based on what config file has. If config file is
3505
2750
# removed/edited, old secret will thus be unrecovable.
3506
2751
clients = {}
3507
2752
with PGPEngine() as pgp:
3508
for client in tcp_server.clients.values():
2753
for client in tcp_server.clients.itervalues():
3509
2754
key = client_settings[client.name]["secret"]
3510
2755
client.encrypted_secret = pgp.encrypt(client.secret,
3511
2756
key)
3512
2757
client_dict = {}
3513
2758
3514
2759
# A list of attributes that can not be pickled
3515
2760
# + secret.
3516
exclude = {"bus", "changedstate", "secret",
3517
"checker", "server_settings"}
3518
for name, typ in inspect.getmembers(dbus.service
3519
.Object):
2761
exclude = set(("bus", "changedstate", "secret",
2762
"checker", "server_settings"))
2763
for name, typ in (inspect.getmembers
2764
(dbus.service.Object)):
3520
2765
exclude.add(name)
3521
2766
3522
2767
client_dict["encrypted_secret"] = (client
3523
2768
.encrypted_secret)
3524
2769
for attr in client.client_structure:
3525
2770
if attr not in exclude:
3526
2771
client_dict[attr] = getattr(client, attr)
3527
2772
3528
2773
clients[client.name] = client_dict
3529
2774
del client_settings[client.name]["secret"]
3530
2775
3531
2776
try:
3532
with tempfile.NamedTemporaryFile(
3533
mode='wb',
3534
suffix=".pickle",
3535
prefix='clients-',
3536
dir=os.path.dirname(stored_state_path),
3537
delete=False) as stored_state:
3538
pickle.dump((clients, client_settings), stored_state,
3539
protocol=2)
3540
tempname = stored_state.name
2777
with (tempfile.NamedTemporaryFile
2778
(mode='wb', suffix=".pickle", prefix='clients-',
2779
dir=os.path.dirname(stored_state_path),
2780
delete=False)) as stored_state:
2781
pickle.dump((clients, client_settings), stored_state)
2782
tempname=stored_state.name
3541
2783
os.rename(tempname, stored_state_path)
3542
2784
except (IOError, OSError) as e:
3543
2785
if not debug:
3546
2788
except NameError:
3547
2789
pass
3548
2790
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3549
logger.warning("Could not save persistent state: {}"
2791
logger.warning("Could not save persistent state: {0}"
3550
2792
.format(os.strerror(e.errno)))
3551
2793
else:
3552
2794
logger.warning("Could not save persistent state:",
3553
2795
exc_info=e)
3554
2796
raise
3555
2797
3556
2798
# Delete all clients, and settings from config
3557
2799
while tcp_server.clients:
3558
2800
name, client = tcp_server.clients.popitem()
3559
2801
if use_dbus:
3560
2802
client.remove_from_connection()
3561
# Don't signal the disabling
2803
# Don't signal anything except ClientRemoved
3562
2804
client.disable(quiet=True)
3563
# Emit D-Bus signal for removal
3564
2805
if use_dbus:
3565
mandos_dbus_service.client_removed_signal(client)
2806
# Emit D-Bus signal
2807
mandos_dbus_service.ClientRemoved(client
2808
.dbus_object_path,
2809
client.name)
3566
2810
client_settings.clear()
3567
2811
3568
2812
atexit.register(cleanup)
3569
3570
for client in tcp_server.clients.values():
2813
2814
for client in tcp_server.clients.itervalues():
3571
2815
if use_dbus:
3572
# Emit D-Bus signal for adding
3573
mandos_dbus_service.client_added_signal(client)
2816
# Emit D-Bus signal
2817
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3574
2818
# Need to initiate checking of clients
3575
2819
if client.enabled:
3576
2820
client.init_checker()
3577
2821
3578
2822
tcp_server.enable()
3579
2823
tcp_server.server_activate()
3580
2824
3581
2825
# Find out what port we got
3582
if zeroconf:
3583
service.port = tcp_server.socket.getsockname()[1]
2826
service.port = tcp_server.socket.getsockname()[1]
3584
2827
if use_ipv6:
3585
2828
logger.info("Now listening on address %r, port %d,"
3586
2829
" flowinfo %d, scope_id %d",
3588
2831
else: # IPv4
3589
2832
logger.info("Now listening on address %r, port %d",
3590
2833
*tcp_server.socket.getsockname())
3591
3592
# service.interface = tcp_server.socket.getsockname()[3]
3593
2834
2835
#service.interface = tcp_server.socket.getsockname()[3]
2836
3594
2837
try:
3595
if zeroconf:
3596
# From the Avahi example code
3597
try:
3598
service.activate()
3599
except dbus.exceptions.DBusException as error:
3600
logger.critical("D-Bus Exception", exc_info=error)
3601
cleanup()
3602
sys.exit(1)
3603
# End of Avahi example code
3604
3605
GLib.io_add_watch(
3606
GLib.IOChannel.unix_new(tcp_server.fileno()),
3607
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3608
lambda *args, **kwargs: (tcp_server.handle_request
3609
(*args[2:], **kwargs) or True))
3610
2838
# From the Avahi example code
2839
try:
2840
service.activate()
2841
except dbus.exceptions.DBusException as error:
2842
logger.critical("D-Bus Exception", exc_info=error)
2843
cleanup()
2844
sys.exit(1)
2845
# End of Avahi example code
2846
2847
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2848
lambda *args, **kwargs:
2849
(tcp_server.handle_request
2850
(*args[2:], **kwargs) or True))
2851
3611
2852
logger.debug("Starting main loop")
3612
2853
main_loop.run()
3613
2854
except AvahiError as error:
3622
2863
# Must run before the D-Bus bus name gets deregistered
3623
2864
cleanup()
3624
2865
3625
3626
def should_only_run_tests():
3627
parser = argparse.ArgumentParser(add_help=False)
3628
parser.add_argument("--check", action='store_true')
3629
args, unknown_args = parser.parse_known_args()
3630
run_tests = args.check
3631
if run_tests:
3632
# Remove --check argument from sys.argv
3633
sys.argv[1:] = unknown_args
3634
return run_tests
3635
3636
# Add all tests from doctest strings
3637
def load_tests(loader, tests, none):
3638
import doctest
3639
tests.addTests(doctest.DocTestSuite())
3640
return tests
3641
3642
2866
if __name__ == '__main__':
3643
try:
3644
if should_only_run_tests():
3645
# Call using ./mandos --check [--verbose]
3646
unittest.main()
3647
else:
3648
main()
3649
finally:
3650
logging.shutdown()
2867
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0