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