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 817
- compare with another revision
- download diff
- download tarball
- view history from revision 817
- Committer: Teddy Hogeborn
- Date: 2016-03-04 20:50:45 UTC
- Revision ID: teddy@recompile.se-20160304205045-jksfb2qzv9erkf21
Only use -fsanitize=... options if they work.
* Makefile (ALL_SANITIZE_OPTIONS): New.
(SANITIZE): Loop through all known sanitizing options and only use
those which do not give an error.
* Makefile (ALL_SANITIZE_OPTIONS): New.
(SANITIZE): Loop through all known sanitizing options and only use
those which do not give an error.
- files added:
- debian/mandos-client.examples
- 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-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 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
73
import itertools
74
import collections
75
import codecs
68
76
69
77
import dbus
70
78
import dbus.service
71
import gobject
79
try:
80
import gobject
81
except ImportError:
82
from gi.repository import GObject as gobject
72
83
import avahi
73
84
from dbus.mainloop.glib import DBusGMainLoop
74
85
import ctypes
75
86
import ctypes.util
76
87
import xml.dom.minidom
77
88
import inspect
78
import GnuPGInterface
79
89
80
90
try:
81
91
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
95
except ImportError:
86
96
SO_BINDTODEVICE = None
87
97
88
version = "1.4.1"
98
if sys.version_info.major == 2:
99
str = unicode
100
101
version = "1.7.3"
89
102
stored_state_file = "clients.pickle"
90
103
91
104
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
105
syslogger = None
95
106
96
107
try:
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
99
.if_nametoindex)
108
if_nametoindex = ctypes.cdll.LoadLibrary(
109
ctypes.util.find_library("c")).if_nametoindex
100
110
except (OSError, AttributeError):
111
101
112
def if_nametoindex(interface):
102
113
"Get an interface index the hard way, i.e. using fcntl()"
103
114
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
104
115
with contextlib.closing(socket.socket()) as s:
105
116
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
struct.pack(str("16s16x"),
107
interface))
108
interface_index = struct.unpack(str("I"),
109
ifreq[16:20])[0]
117
struct.pack(b"16s16x", interface))
118
interface_index = struct.unpack("I", ifreq[16:20])[0]
110
119
return interface_index
111
120
112
121
113
def initlogger(level=logging.WARNING):
122
def initlogger(debug, level=logging.WARNING):
114
123
"""init logger and add loglevel"""
115
124
125
global syslogger
126
syslogger = (logging.handlers.SysLogHandler(
127
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
128
address = "/dev/log"))
116
129
syslogger.setFormatter(logging.Formatter
117
130
('Mandos [%(process)d]: %(levelname)s:'
118
131
' %(message)s'))
119
132
logger.addHandler(syslogger)
120
133
121
console = logging.StreamHandler()
122
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
123
' [%(process)d]:'
124
' %(levelname)s:'
125
' %(message)s'))
126
logger.addHandler(console)
134
if debug:
135
console = logging.StreamHandler()
136
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
137
' [%(process)d]:'
138
' %(levelname)s:'
139
' %(message)s'))
140
logger.addHandler(console)
127
141
logger.setLevel(level)
128
142
129
143
134
148
135
149
class PGPEngine(object):
136
150
"""A simple class for OpenPGP symmetric encryption & decryption"""
151
137
152
def __init__(self):
138
self.gnupg = GnuPGInterface.GnuPG()
139
153
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
140
self.gnupg = GnuPGInterface.GnuPG()
141
self.gnupg.options.meta_interactive = False
142
self.gnupg.options.homedir = self.tempdir
143
self.gnupg.options.extra_args.extend(['--force-mdc',
144
'--quiet'])
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']
145
170
146
171
def __enter__(self):
147
172
return self
148
173
149
def __exit__ (self, exc_type, exc_value, traceback):
174
def __exit__(self, exc_type, exc_value, traceback):
150
175
self._cleanup()
151
176
return False
152
177
169
194
def password_encode(self, password):
170
195
# Passphrase can not be empty and can not contain newlines or
171
196
# NUL bytes. So we prefix it and hex encode it.
172
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
173
204
174
205
def encrypt(self, data, password):
175
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
177
try:
178
proc = self.gnupg.run(['--symmetric'],
179
create_fhs=['stdin', 'stdout'],
180
attach_fhs={'stderr': devnull})
181
with contextlib.closing(proc.handles['stdin']) as f:
182
f.write(data)
183
with contextlib.closing(proc.handles['stdout']) as f:
184
ciphertext = f.read()
185
proc.wait()
186
except IOError as e:
187
raise PGPError(e)
188
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)
189
221
return ciphertext
190
222
191
223
def decrypt(self, data, password):
192
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
194
try:
195
proc = self.gnupg.run(['--decrypt'],
196
create_fhs=['stdin', 'stdout'],
197
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
199
f.write(data)
200
with contextlib.closing(proc.handles['stdout']) as f:
201
decrypted_plaintext = f.read()
202
proc.wait()
203
except IOError as e:
204
raise PGPError(e)
205
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)
206
239
return decrypted_plaintext
207
240
208
241
209
210
242
class AvahiError(Exception):
211
243
def __init__(self, value, *args, **kwargs):
212
244
self.value = value
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
245
return super(AvahiError, self).__init__(value, *args,
246
**kwargs)
247
216
248
217
249
class AvahiServiceError(AvahiError):
218
250
pass
219
251
252
220
253
class AvahiGroupError(AvahiError):
221
254
pass
222
255
229
262
Used to optionally bind to the specified interface.
230
263
name: string; Example: 'Mandos'
231
264
type: string; Example: '_mandos._tcp'.
232
See <http://www.dns-sd.org/ServiceTypes.html>
265
See <https://www.iana.org/assignments/service-names-port-numbers>
233
266
port: integer; what port to announce
234
267
TXT: list of strings; TXT record for the service
235
268
domain: string; Domain to publish on, default to .local if empty.
241
274
server: D-Bus Server
242
275
bus: dbus.SystemBus()
243
276
"""
244
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
245
servicetype = None, port = None, TXT = None,
246
domain = "", host = "", max_renames = 32768,
247
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):
248
289
self.interface = interface
249
290
self.name = name
250
291
self.type = servicetype
259
300
self.server = None
260
301
self.bus = bus
261
302
self.entry_group_state_changed_match = None
262
def rename(self):
303
304
def rename(self, remove=True):
263
305
"""Derived from the Avahi example code"""
264
306
if self.rename_count >= self.max_renames:
265
307
logger.critical("No suitable Zeroconf service name found"
266
308
" after %i retries, exiting.",
267
309
self.rename_count)
268
310
raise AvahiServiceError("Too many renames")
269
self.name = unicode(self.server
270
.GetAlternativeServiceName(self.name))
311
self.name = str(
312
self.server.GetAlternativeServiceName(self.name))
313
self.rename_count += 1
271
314
logger.info("Changing Zeroconf service name to %r ...",
272
315
self.name)
273
self.remove()
316
if remove:
317
self.remove()
274
318
try:
275
319
self.add()
276
320
except dbus.exceptions.DBusException as error:
277
logger.critical("DBusException: %s", error)
278
self.cleanup()
279
os._exit(1)
280
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
281
330
def remove(self):
282
331
"""Derived from the Avahi example code"""
283
332
if self.entry_group_state_changed_match is not None:
285
334
self.entry_group_state_changed_match = None
286
335
if self.group is not None:
287
336
self.group.Reset()
337
288
338
def add(self):
289
339
"""Derived from the Avahi example code"""
290
340
self.remove()
307
357
dbus.UInt16(self.port),
308
358
avahi.string_array_to_txt_array(self.TXT))
309
359
self.group.Commit()
360
310
361
def entry_group_state_changed(self, state, error):
311
362
"""Derived from the Avahi example code"""
312
363
logger.debug("Avahi entry group state change: %i", state)
318
369
self.rename()
319
370
elif state == avahi.ENTRY_GROUP_FAILURE:
320
371
logger.critical("Avahi: Error in group state changed %s",
321
unicode(error))
322
raise AvahiGroupError("State changed: %s"
323
% unicode(error))
372
str(error))
373
raise AvahiGroupError("State changed: {!s}".format(error))
374
324
375
def cleanup(self):
325
376
"""Derived from the Avahi example code"""
326
377
if self.group is not None:
331
382
pass
332
383
self.group = None
333
384
self.remove()
385
334
386
def server_state_changed(self, state, error=None):
335
387
"""Derived from the Avahi example code"""
336
388
logger.debug("Avahi server state change: %i", state)
337
bad_states = { avahi.SERVER_INVALID:
338
"Zeroconf server invalid",
339
avahi.SERVER_REGISTERING: None,
340
avahi.SERVER_COLLISION:
341
"Zeroconf server name collision",
342
avahi.SERVER_FAILURE:
343
"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
}
344
395
if state in bad_states:
345
396
if bad_states[state] is not None:
346
397
if error is None:
349
400
logger.error(bad_states[state] + ": %r", error)
350
401
self.cleanup()
351
402
elif state == avahi.SERVER_RUNNING:
352
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)
353
415
else:
354
416
if error is None:
355
417
logger.debug("Unknown state: %r", state)
356
418
else:
357
419
logger.debug("Unknown state: %r: %r", state, error)
420
358
421
def activate(self):
359
422
"""Derived from the Avahi example code"""
360
423
if self.server is None:
364
427
follow_name_owner_changes=True),
365
428
avahi.DBUS_INTERFACE_SERVER)
366
429
self.server.connect_to_signal("StateChanged",
367
self.server_state_changed)
430
self.server_state_changed)
368
431
self.server_state_changed(self.server.GetState())
369
432
433
370
434
class AvahiServiceToSyslog(AvahiService):
371
def rename(self):
435
def rename(self, *args, **kwargs):
372
436
"""Add the new name to the syslog messages"""
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
377
% 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)))
378
441
return ret
379
442
380
def timedelta_to_milliseconds(td):
381
"Convert a datetime.timedelta() to milliseconds"
382
return ((td.days * 24 * 60 * 60 * 1000)
383
+ (td.seconds * 1000)
384
+ (td.microseconds // 1000))
385
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
386
708
class Client(object):
387
709
"""A representation of a client host served by this server.
388
710
413
735
last_checked_ok: datetime.datetime(); (UTC) or None
414
736
last_checker_status: integer between 0 and 255 reflecting exit
415
737
status of last checker. -1 reflects crashed
416
checker, or None.
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
417
741
last_enabled: datetime.datetime(); (UTC) or None
418
742
name: string; from the config file, used in log messages and
419
743
D-Bus identifiers
420
744
secret: bytestring; sent verbatim (over TLS) to client
421
745
timeout: datetime.timedelta(); How long from last_checked_ok
422
746
until this client is disabled
423
extended_timeout: extra long timeout when password has been sent
747
extended_timeout: extra long timeout when secret has been sent
424
748
runtime_expansions: Allowed attributes for runtime expansion.
425
749
expires: datetime.datetime(); time (UTC) when a client will be
426
750
disabled, or None
751
server_settings: The server_settings dict from main()
427
752
"""
428
753
429
754
runtime_expansions = ("approval_delay", "approval_duration",
430
"created", "enabled", "fingerprint",
431
"host", "interval", "last_checked_ok",
755
"created", "enabled", "expires",
756
"fingerprint", "host", "interval",
757
"last_approval_request", "last_checked_ok",
432
758
"last_enabled", "name", "timeout")
433
client_defaults = { "timeout": "5m",
434
"extended_timeout": "15m",
435
"interval": "2m",
436
"checker": "fping -q -- %%(host)s",
437
"host": "",
438
"approval_delay": "0s",
439
"approval_duration": "1s",
440
"approved_by_default": "True",
441
"enabled": "True",
442
}
443
444
def timeout_milliseconds(self):
445
"Return the 'timeout' attribute in milliseconds"
446
return timedelta_to_milliseconds(self.timeout)
447
448
def extended_timeout_milliseconds(self):
449
"Return the 'extended_timeout' attribute in milliseconds"
450
return timedelta_to_milliseconds(self.extended_timeout)
451
452
def interval_milliseconds(self):
453
"Return the 'interval' attribute in milliseconds"
454
return timedelta_to_milliseconds(self.interval)
455
456
def approval_delay_milliseconds(self):
457
return timedelta_to_milliseconds(self.approval_delay)
458
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
459
771
@staticmethod
460
772
def config_parser(config):
461
""" Construct a new dict of client settings of this form:
773
"""Construct a new dict of client settings of this form:
462
774
{ client_name: {setting_name: value, ...}, ...}
463
with exceptions for any special settings as defined above"""
775
with exceptions for any special settings as defined above.
776
NOTE: Must be a pure function. Must return the same result
777
value given the same arguments.
778
"""
464
779
settings = {}
465
780
for client_name in config.sections():
466
781
section = dict(config.items(client_name))
470
785
# Reformat values from string types to Python types
471
786
client["approved_by_default"] = config.getboolean(
472
787
client_name, "approved_by_default")
473
client["enabled"] = config.getboolean(client_name, "enabled")
788
client["enabled"] = config.getboolean(client_name,
789
"enabled")
474
790
791
# Uppercase and remove spaces from fingerprint for later
792
# comparison purposes with return value from the
793
# fingerprint() function
475
794
client["fingerprint"] = (section["fingerprint"].upper()
476
795
.replace(" ", ""))
477
796
if "secret" in section:
482
801
"rb") as secfile:
483
802
client["secret"] = secfile.read()
484
803
else:
485
raise TypeError("No secret or secfile for section %s"
486
% section)
804
raise TypeError("No secret or secfile for section {}"
805
.format(section))
487
806
client["timeout"] = string_to_delta(section["timeout"])
488
807
client["extended_timeout"] = string_to_delta(
489
808
section["extended_timeout"])
495
814
client["checker_command"] = section["checker"]
496
815
client["last_approval_request"] = None
497
816
client["last_checked_ok"] = None
498
client["last_checker_status"] = None
499
if client["enabled"]:
500
client["last_enabled"] = datetime.datetime.utcnow()
501
client["expires"] = (datetime.datetime.utcnow()
502
+ client["timeout"])
503
else:
504
client["last_enabled"] = None
505
client["expires"] = None
506
817
client["last_checker_status"] = -2
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
830
if self.enabled:
831
if not hasattr(self, "last_enabled"):
832
self.last_enabled = datetime.datetime.utcnow()
833
if not hasattr(self, "expires"):
834
self.expires = (datetime.datetime.utcnow()
835
+ self.timeout)
836
else:
837
self.last_enabled = None
838
self.expires = None
839
519
840
logger.debug("Creating client %r", self.name)
520
# Uppercase and remove spaces from fingerprint for later
521
# comparison purposes with return value from the fingerprint()
522
# function
523
841
logger.debug(" Fingerprint: %s", self.fingerprint)
524
self.created = settings.get("created", datetime.datetime.utcnow())
525
842
self.created = settings.get("created",
843
datetime.datetime.utcnow())
844
526
845
# attributes specific for this server instance
527
846
self.checker = None
528
847
self.checker_initiator_tag = None
531
850
self.current_checker_command = None
532
851
self.approved = None
533
852
self.approvals_pending = 0
534
self.changedstate = (multiprocessing_manager
535
.Condition(multiprocessing_manager
536
.Lock()))
537
self.client_structure = [attr for attr in
538
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()
539
857
if not attr.startswith("_")]
540
858
self.client_structure.append("client_structure")
541
859
542
for name, t in inspect.getmembers(type(self),
543
lambda obj:
544
isinstance(obj,
545
property)):
860
for name, t in inspect.getmembers(
861
type(self), lambda obj: isinstance(obj, property)):
546
862
if not name.startswith("_"):
547
863
self.client_structure.append(name)
548
864
556
872
if getattr(self, "enabled", False):
557
873
# Already enabled
558
874
return
559
self.send_changedstate()
560
875
self.expires = datetime.datetime.utcnow() + self.timeout
561
876
self.enabled = True
562
877
self.last_enabled = datetime.datetime.utcnow()
563
878
self.init_checker()
879
self.send_changedstate()
564
880
565
881
def disable(self, quiet=True):
566
882
"""Disable this client."""
567
883
if not getattr(self, "enabled", False):
568
884
return False
569
885
if not quiet:
570
self.send_changedstate()
571
if not quiet:
572
886
logger.info("Disabling client %s", self.name)
573
if getattr(self, "disable_initiator_tag", False):
887
if getattr(self, "disable_initiator_tag", None) is not None:
574
888
gobject.source_remove(self.disable_initiator_tag)
575
889
self.disable_initiator_tag = None
576
890
self.expires = None
577
if getattr(self, "checker_initiator_tag", False):
891
if getattr(self, "checker_initiator_tag", None) is not None:
578
892
gobject.source_remove(self.checker_initiator_tag)
579
893
self.checker_initiator_tag = None
580
894
self.stop_checker()
581
895
self.enabled = False
896
if not quiet:
897
self.send_changedstate()
582
898
# Do not run this again if called by a gobject.timeout_add
583
899
return False
584
900
588
904
def init_checker(self):
589
905
# Schedule a new checker to be started an 'interval' from now,
590
906
# and every interval from then on.
591
self.checker_initiator_tag = (gobject.timeout_add
592
(self.interval_milliseconds(),
593
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)
594
912
# Schedule a disable() when 'timeout' has passed
595
self.disable_initiator_tag = (gobject.timeout_add
596
(self.timeout_milliseconds(),
597
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)
598
917
# Also start a new checker *right now*.
599
918
self.start_checker()
600
919
601
def checker_callback(self, pid, condition, command):
920
def checker_callback(self, source, condition, connection,
921
command):
602
922
"""The checker has completed, so take appropriate actions."""
603
923
self.checker_callback_tag = None
604
924
self.checker = None
605
if os.WIFEXITED(condition):
606
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
607
932
if self.last_checker_status == 0:
608
933
logger.info("Checker for %(name)s succeeded",
609
934
vars(self))
610
935
self.checked_ok()
611
936
else:
612
logger.info("Checker for %(name)s failed",
613
vars(self))
937
logger.info("Checker for %(name)s failed", vars(self))
614
938
else:
615
939
self.last_checker_status = -1
940
self.last_checker_signal = -returncode
616
941
logger.warning("Checker for %(name)s crashed?",
617
942
vars(self))
618
619
def checked_ok(self, timeout=None):
620
"""Bump up the timeout for this client.
621
622
This should only be called when the client has been seen,
623
alive and well.
624
"""
943
return False
944
945
def checked_ok(self):
946
"""Assert that the client has been seen, alive and well."""
947
self.last_checked_ok = datetime.datetime.utcnow()
948
self.last_checker_status = 0
949
self.last_checker_signal = None
950
self.bump_timeout()
951
952
def bump_timeout(self, timeout=None):
953
"""Bump up the timeout for this client."""
625
954
if timeout is None:
626
955
timeout = self.timeout
627
self.last_checked_ok = datetime.datetime.utcnow()
628
956
if self.disable_initiator_tag is not None:
629
957
gobject.source_remove(self.disable_initiator_tag)
958
self.disable_initiator_tag = None
630
959
if getattr(self, "enabled", False):
631
self.disable_initiator_tag = (gobject.timeout_add
632
(timedelta_to_milliseconds
633
(timeout), self.disable))
960
self.disable_initiator_tag = gobject.timeout_add(
961
int(timeout.total_seconds() * 1000), self.disable)
634
962
self.expires = datetime.datetime.utcnow() + timeout
635
963
636
964
def need_approval(self):
642
970
If a checker already exists, leave it running and do
643
971
nothing."""
644
972
# The reason for not killing a running checker is that if we
645
# did that, then if a checker (for some reason) started
646
# running slowly and taking more than 'interval' time, the
647
# client would inevitably timeout, since no checker would get
648
# 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
649
977
# checkers alone, the checker would have to take more time
650
978
# than 'timeout' for the client to be disabled, which is as it
651
979
# should be.
652
980
653
# If a checker exists, make sure it is not a zombie
654
try:
655
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
656
except (AttributeError, OSError) as error:
657
if (isinstance(error, OSError)
658
and error.errno != errno.ECHILD):
659
raise error
660
else:
661
if pid:
662
logger.warning("Checker was a zombie")
663
gobject.source_remove(self.checker_callback_tag)
664
self.checker_callback(pid, status,
665
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
666
985
# Start a new checker if needed
667
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 }
668
991
try:
669
# In case checker_command has exactly one % operator
670
command = self.checker_command % self.host
671
except TypeError:
672
# Escape attributes for the shell
673
escaped_attrs = dict(
674
(attr,
675
re.escape(unicode(str(getattr(self, attr, "")),
676
errors=
677
'replace')))
678
for attr in
679
self.runtime_expansions)
680
681
try:
682
command = self.checker_command % escaped_attrs
683
except TypeError as error:
684
logger.error('Could not format string "%s":'
685
' %s', self.checker_command, error)
686
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
687
998
self.current_checker_command = command
688
try:
689
logger.info("Starting checker %r for %s",
690
command, self.name)
691
# We don't need to redirect stdout and stderr, since
692
# in normal mode, that is already done by daemon(),
693
# and in debug mode we don't want to. (Stdin is
694
# always replaced by /dev/null.)
695
self.checker = subprocess.Popen(command,
696
close_fds=True,
697
shell=True, cwd="/")
698
self.checker_callback_tag = (gobject.child_watch_add
699
(self.checker.pid,
700
self.checker_callback,
701
data=command))
702
# The checker may have completed before the gobject
703
# watch was added. Check for this.
704
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
705
if pid:
706
gobject.source_remove(self.checker_callback_tag)
707
self.checker_callback(pid, status, command)
708
except OSError as error:
709
logger.error("Failed to start subprocess: %s",
710
error)
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)
711
1024
# Re-run this periodically if run by gobject.timeout_add
712
1025
return True
713
1026
719
1032
if getattr(self, "checker", None) is None:
720
1033
return
721
1034
logger.debug("Stopping checker for %(name)s", vars(self))
722
try:
723
os.kill(self.checker.pid, signal.SIGTERM)
724
#time.sleep(0.5)
725
#if self.checker.poll() is None:
726
# os.kill(self.checker.pid, signal.SIGKILL)
727
except OSError as error:
728
if error.errno != errno.ESRCH: # No such process
729
raise
1035
self.checker.terminate()
730
1036
self.checker = None
731
1037
732
1038
733
def dbus_service_property(dbus_interface, signature="v",
734
access="readwrite", byte_arrays=False):
1039
def dbus_service_property(dbus_interface,
1040
signature="v",
1041
access="readwrite",
1042
byte_arrays=False):
735
1043
"""Decorators for marking methods of a DBusObjectWithProperties to
736
1044
become properties on the D-Bus.
737
1045
746
1054
# "Set" method, so we fail early here:
747
1055
if byte_arrays and signature != "ay":
748
1056
raise ValueError("Byte arrays not supported for non-'ay'"
749
" signature %r" % signature)
1057
" signature {!r}".format(signature))
1058
750
1059
def decorator(func):
751
1060
func._dbus_is_property = True
752
1061
func._dbus_interface = dbus_interface
757
1066
func._dbus_name = func._dbus_name[:-14]
758
1067
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
759
1068
return func
1069
1070
return decorator
1071
1072
1073
def dbus_interface_annotations(dbus_interface):
1074
"""Decorator for marking functions returning interface annotations
1075
1076
Usage:
1077
1078
@dbus_interface_annotations("org.example.Interface")
1079
def _foo(self): # Function name does not matter
1080
return {"org.freedesktop.DBus.Deprecated": "true",
1081
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1082
"false"}
1083
"""
1084
1085
def decorator(func):
1086
func._dbus_is_interface = True
1087
func._dbus_interface = dbus_interface
1088
func._dbus_name = dbus_interface
1089
return func
1090
1091
return decorator
1092
1093
1094
def dbus_annotations(annotations):
1095
"""Decorator to annotate D-Bus methods, signals or properties
1096
Usage:
1097
1098
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1099
"org.freedesktop.DBus.Property."
1100
"EmitsChangedSignal": "false"})
1101
@dbus_service_property("org.example.Interface", signature="b",
1102
access="r")
1103
def Property_dbus_property(self):
1104
return dbus.Boolean(False)
1105
1106
See also the DBusObjectWithAnnotations class.
1107
"""
1108
1109
def decorator(func):
1110
func._dbus_annotations = annotations
1111
return func
1112
760
1113
return decorator
761
1114
762
1115
763
1116
class DBusPropertyException(dbus.exceptions.DBusException):
764
1117
"""A base class for D-Bus property-related exceptions
765
1118
"""
766
def __unicode__(self):
767
return unicode(str(self))
1119
pass
768
1120
769
1121
770
1122
class DBusPropertyAccessException(DBusPropertyException):
779
1131
pass
780
1132
781
1133
782
class DBusObjectWithProperties(dbus.service.Object):
1134
class DBusObjectWithAnnotations(dbus.service.Object):
1135
"""A D-Bus object with annotations.
1136
1137
Classes inheriting from this can use the dbus_annotations
1138
decorator to add annotations to methods or signals.
1139
"""
1140
1141
@staticmethod
1142
def _is_dbus_thing(thing):
1143
"""Returns a function testing if an attribute is a D-Bus thing
1144
1145
If called like _is_dbus_thing("method") it returns a function
1146
suitable for use as predicate to inspect.getmembers().
1147
"""
1148
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1149
False)
1150
1151
def _get_all_dbus_things(self, thing):
1152
"""Returns a generator of (name, attribute) pairs
1153
"""
1154
return ((getattr(athing.__get__(self), "_dbus_name", name),
1155
athing.__get__(self))
1156
for cls in self.__class__.__mro__
1157
for name, athing in
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):
783
1224
"""A D-Bus object with properties.
784
1225
785
1226
Classes inheriting from this can use the dbus_service_property
787
1228
standard Get(), Set(), and GetAll() methods on the D-Bus.
788
1229
"""
789
1230
790
@staticmethod
791
def _is_dbus_property(obj):
792
return getattr(obj, "_dbus_is_property", False)
793
794
def _get_all_dbus_properties(self):
795
"""Returns a generator of (name, attribute) pairs
796
"""
797
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
798
for cls in self.__class__.__mro__
799
for name, prop in
800
inspect.getmembers(cls, self._is_dbus_property))
801
802
1231
def _get_dbus_property(self, interface_name, property_name):
803
1232
"""Returns a bound method if one exists which is a D-Bus
804
1233
property with the specified name and interface.
805
1234
"""
806
for cls in self.__class__.__mro__:
807
for name, value in (inspect.getmembers
808
(cls, self._is_dbus_property)):
1235
for cls in self.__class__.__mro__:
1236
for name, value in inspect.getmembers(
1237
cls, self._is_dbus_thing("property")):
809
1238
if (value._dbus_name == property_name
810
1239
and value._dbus_interface == interface_name):
811
1240
return value.__get__(self)
812
1241
813
1242
# No such property
814
raise DBusPropertyNotFound(self.dbus_object_path + ":"
815
+ interface_name + "."
816
+ property_name)
817
818
@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",
819
1257
out_signature="v")
820
1258
def Get(self, interface_name, property_name):
821
1259
"""Standard D-Bus property Get() method, see D-Bus standard.
839
1277
# The byte_arrays option is not supported yet on
840
1278
# signatures other than "ay".
841
1279
if prop._dbus_signature != "ay":
842
raise ValueError
843
value = dbus.ByteArray(''.join(unichr(byte)
844
for byte in value))
1280
raise ValueError("Byte arrays not supported for non-"
1281
"'ay' signature {!r}"
1282
.format(prop._dbus_signature))
1283
value = dbus.ByteArray(b''.join(chr(byte)
1284
for byte in value))
845
1285
prop(value)
846
1286
847
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1287
@dbus.service.method(dbus.PROPERTIES_IFACE,
1288
in_signature="s",
848
1289
out_signature="a{sv}")
849
1290
def GetAll(self, interface_name):
850
1291
"""Standard D-Bus property GetAll() method, see D-Bus
853
1294
Note: Will not include properties with access="write".
854
1295
"""
855
1296
properties = {}
856
for name, prop in self._get_all_dbus_properties():
1297
for name, prop in self._get_all_dbus_things("property"):
857
1298
if (interface_name
858
1299
and interface_name != prop._dbus_interface):
859
1300
# Interface non-empty but did not match
865
1306
if not hasattr(value, "variant_level"):
866
1307
properties[name] = value
867
1308
continue
868
properties[name] = type(value)(value, variant_level=
869
value.variant_level+1)
1309
properties[name] = type(value)(
1310
value, variant_level = value.variant_level + 1)
870
1311
return dbus.Dictionary(properties, signature="sv")
871
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
872
1321
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
873
1322
out_signature="s",
874
1323
path_keyword='object_path',
875
1324
connection_keyword='connection')
876
1325
def Introspect(self, object_path, connection):
877
"""Standard D-Bus method, overloaded to insert property tags.
1326
"""Overloading of standard D-Bus method.
1327
1328
Inserts property tags and interface annotation tags.
878
1329
"""
879
xmlstring = dbus.service.Object.Introspect(self, object_path,
880
connection)
1330
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1331
object_path,
1332
connection)
881
1333
try:
882
1334
document = xml.dom.minidom.parseString(xmlstring)
1335
883
1336
def make_tag(document, name, prop):
884
1337
e = document.createElement("property")
885
1338
e.setAttribute("name", name)
886
1339
e.setAttribute("type", prop._dbus_signature)
887
1340
e.setAttribute("access", prop._dbus_access)
888
1341
return e
1342
889
1343
for if_tag in document.getElementsByTagName("interface"):
1344
# Add property tags
890
1345
for tag in (make_tag(document, name, prop)
891
1346
for name, prop
892
in self._get_all_dbus_properties()
1347
in self._get_all_dbus_things("property")
893
1348
if prop._dbus_interface
894
1349
== if_tag.getAttribute("name")):
895
1350
if_tag.appendChild(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)
896
1367
# Add the names to the return values for the
897
1368
# "org.freedesktop.DBus.Properties" methods
898
1369
if (if_tag.getAttribute("name")
913
1384
except (AttributeError, xml.dom.DOMException,
914
1385
xml.parsers.expat.ExpatError) as error:
915
1386
logger.error("Failed to override Introspection method",
916
error)
917
return xmlstring
918
919
920
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):
921
1460
"""Convert a UTC datetime.datetime() to a D-Bus type."""
922
1461
if dt is None:
923
1462
return dbus.String("", variant_level = variant_level)
924
return dbus.String(dt.isoformat(),
925
variant_level=variant_level)
926
927
928
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
929
.__metaclass__):
930
"""Applied to an empty subclass of a D-Bus object, this metaclass
931
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).
932
1488
"""
933
def __new__(mcs, name, bases, attr):
934
# Go through all the base classes which could have D-Bus
935
# methods, signals, or properties in them
936
for base in (b for b in bases
937
if issubclass(b, dbus.service.Object)):
938
# Go though all attributes of the base class
939
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):
940
1497
# Ignore non-D-Bus attributes, and D-Bus attributes
941
1498
# with the wrong interface name
942
1499
if (not hasattr(attribute, "_dbus_interface")
943
or not attribute._dbus_interface
944
.startswith("se.recompile.Mandos")):
1500
or not attribute._dbus_interface.startswith(
1501
orig_interface_name)):
945
1502
continue
946
1503
# Create an alternate D-Bus interface name based on
947
1504
# the current name
948
alt_interface = (attribute._dbus_interface
949
.replace("se.recompile.Mandos",
950
"se.bsnet.fukt.Mandos"))
1505
alt_interface = attribute._dbus_interface.replace(
1506
orig_interface_name, alt_interface_name)
1507
interface_names.add(alt_interface)
951
1508
# Is this a D-Bus signal?
952
1509
if getattr(attribute, "_dbus_is_signal", False):
953
# Extract the original non-method function by
954
# black magic
955
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(
956
1514
zip(attribute.func_code.co_freevars,
957
attribute.__closure__))["func"]
958
.cell_contents)
1515
attribute.__closure__))
1516
["func"].cell_contents)
1517
else:
1518
nonmethod_func = attribute
959
1519
# Create a new, but exactly alike, function
960
1520
# object, and decorate it to be a new D-Bus signal
961
1521
# with the alternate D-Bus interface name
962
new_function = (dbus.service.signal
963
(alt_interface,
964
attribute._dbus_signature)
965
(types.FunctionType(
966
nonmethod_func.func_code,
967
nonmethod_func.func_globals,
968
nonmethod_func.func_name,
969
nonmethod_func.func_defaults,
970
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))
1539
# Copy annotations, if any
1540
try:
1541
new_function._dbus_annotations = dict(
1542
attribute._dbus_annotations)
1543
except AttributeError:
1544
pass
971
1545
# Define a creator of a function to call both the
972
# old and new functions, so both the old and new
973
# 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
974
1549
def fixscope(func1, func2):
975
1550
"""This function is a scope container to pass
976
1551
func1 and func2 to the "call_both" function
977
1552
outside of its arguments"""
1553
1554
@functools.wraps(func2)
978
1555
def call_both(*args, **kwargs):
979
1556
"""This function will emit two D-Bus
980
1557
signals by calling func1 and func2"""
981
1558
func1(*args, **kwargs)
982
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
983
1565
return call_both
984
1566
# Create the "call_both" function and add it to
985
1567
# the class
986
attr[attrname] = fixscope(attribute,
987
new_function)
1568
attr[attrname] = fixscope(attribute, new_function)
988
1569
# Is this a D-Bus method?
989
1570
elif getattr(attribute, "_dbus_is_method", False):
990
1571
# Create a new, but exactly alike, function
991
1572
# object. Decorate it to be a new D-Bus method
992
1573
# with the alternate D-Bus interface name. Add it
993
1574
# to the class.
994
attr[attrname] = (dbus.service.method
995
(alt_interface,
996
attribute._dbus_in_signature,
997
attribute._dbus_out_signature)
998
(types.FunctionType
999
(attribute.func_code,
1000
attribute.func_globals,
1001
attribute.func_name,
1002
attribute.func_defaults,
1003
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)))
1585
# Copy annotations, if any
1586
try:
1587
attr[attrname]._dbus_annotations = dict(
1588
attribute._dbus_annotations)
1589
except AttributeError:
1590
pass
1004
1591
# Is this a D-Bus property?
1005
1592
elif getattr(attribute, "_dbus_is_property", False):
1006
1593
# Create a new, but exactly alike, function
1007
1594
# object, and decorate it to be a new D-Bus
1008
1595
# property with the alternate D-Bus interface
1009
1596
# name. Add it to the class.
1010
attr[attrname] = (dbus_service_property
1011
(alt_interface,
1012
attribute._dbus_signature,
1013
attribute._dbus_access,
1014
attribute
1015
._dbus_get_args_options
1016
["byte_arrays"])
1017
(types.FunctionType
1018
(attribute.func_code,
1019
attribute.func_globals,
1020
attribute.func_name,
1021
attribute.func_defaults,
1022
attribute.func_closure)))
1023
return type.__new__(mcs, name, bases, attr)
1024
1025
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)))
1608
# Copy annotations, if any
1609
try:
1610
attr[attrname]._dbus_annotations = dict(
1611
attribute._dbus_annotations)
1612
except AttributeError:
1613
pass
1614
# Is this a D-Bus interface?
1615
elif getattr(attribute, "_dbus_is_interface", False):
1616
# Create a new, but exactly alike, function
1617
# object. Decorate it to be a new D-Bus interface
1618
# with the alternate D-Bus interface name. Add it
1619
# to the class.
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"})
1026
1654
class ClientDBus(Client, DBusObjectWithProperties):
1027
1655
"""A Client class using D-Bus
1028
1656
1032
1660
"""
1033
1661
1034
1662
runtime_expansions = (Client.runtime_expansions
1035
+ ("dbus_object_path",))
1663
+ ("dbus_object_path", ))
1664
1665
_interface = "se.recompile.Mandos.Client"
1036
1666
1037
1667
# dbus.service.Object doesn't use super(), so we can't either.
1038
1668
1039
1669
def __init__(self, bus = None, *args, **kwargs):
1040
1670
self.bus = bus
1041
1671
Client.__init__(self, *args, **kwargs)
1042
self._approvals_pending = 0
1043
1044
self._approvals_pending = 0
1045
1672
# Only now, when this client is initialized, can it show up on
1046
1673
# the D-Bus
1047
client_object_name = unicode(self.name).translate(
1674
client_object_name = str(self.name).translate(
1048
1675
{ord("."): ord("_"),
1049
1676
ord("-"): ord("_")})
1050
self.dbus_object_path = (dbus.ObjectPath
1051
("/clients/" + client_object_name))
1677
self.dbus_object_path = dbus.ObjectPath(
1678
"/clients/" + client_object_name)
1052
1679
DBusObjectWithProperties.__init__(self, self.bus,
1053
1680
self.dbus_object_path)
1054
1055
def notifychangeproperty(transform_func,
1056
dbus_name, type_func=lambda x: x,
1057
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):
1058
1687
""" Modify a variable so that it's a property which announces
1059
1688
its changes to DBus.
1060
1689
1065
1694
to the D-Bus. Default: no transform
1066
1695
variant_level: D-Bus variant level. Default: 1
1067
1696
"""
1068
attrname = "_{0}".format(dbus_name)
1697
attrname = "_{}".format(dbus_name)
1698
1069
1699
def setter(self, value):
1070
1700
if hasattr(self, "dbus_object_path"):
1071
1701
if (not hasattr(self, attrname) or
1072
1702
type_func(getattr(self, attrname, None))
1073
1703
!= type_func(value)):
1074
dbus_value = transform_func(type_func(value),
1075
variant_level
1076
=variant_level)
1077
self.PropertyChanged(dbus.String(dbus_name),
1078
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())
1079
1719
setattr(self, attrname, value)
1080
1720
1081
1721
return property(lambda self: getattr(self, attrname), setter)
1082
1722
1083
1084
1723
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1085
1724
approvals_pending = notifychangeproperty(dbus.Boolean,
1086
1725
"ApprovalPending",
1088
1727
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1089
1728
last_enabled = notifychangeproperty(datetime_to_dbus,
1090
1729
"LastEnabled")
1091
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1092
type_func = lambda checker:
1093
checker is not None)
1730
checker = notifychangeproperty(
1731
dbus.Boolean, "CheckerRunning",
1732
type_func = lambda checker: checker is not None)
1094
1733
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1095
1734
"LastCheckedOK")
1735
last_checker_status = notifychangeproperty(dbus.Int16,
1736
"LastCheckerStatus")
1096
1737
last_approval_request = notifychangeproperty(
1097
1738
datetime_to_dbus, "LastApprovalRequest")
1098
1739
approved_by_default = notifychangeproperty(dbus.Boolean,
1099
1740
"ApprovedByDefault")
1100
approval_delay = notifychangeproperty(dbus.UInt64,
1101
"ApprovalDelay",
1102
type_func =
1103
timedelta_to_milliseconds)
1741
approval_delay = notifychangeproperty(
1742
dbus.UInt64, "ApprovalDelay",
1743
type_func = lambda td: td.total_seconds() * 1000)
1104
1744
approval_duration = notifychangeproperty(
1105
1745
dbus.UInt64, "ApprovalDuration",
1106
type_func = timedelta_to_milliseconds)
1746
type_func = lambda td: td.total_seconds() * 1000)
1107
1747
host = notifychangeproperty(dbus.String, "Host")
1108
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1109
type_func =
1110
timedelta_to_milliseconds)
1748
timeout = notifychangeproperty(
1749
dbus.UInt64, "Timeout",
1750
type_func = lambda td: td.total_seconds() * 1000)
1111
1751
extended_timeout = notifychangeproperty(
1112
1752
dbus.UInt64, "ExtendedTimeout",
1113
type_func = timedelta_to_milliseconds)
1114
interval = notifychangeproperty(dbus.UInt64,
1115
"Interval",
1116
type_func =
1117
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)
1118
1757
checker_command = notifychangeproperty(dbus.String, "Checker")
1758
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1759
invalidate_only=True)
1119
1760
1120
1761
del notifychangeproperty
1121
1762
1128
1769
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1129
1770
Client.__del__(self, *args, **kwargs)
1130
1771
1131
def checker_callback(self, pid, condition, command,
1132
*args, **kwargs):
1133
self.checker_callback_tag = None
1134
self.checker = None
1135
if os.WIFEXITED(condition):
1136
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:
1137
1779
# Emit D-Bus signal
1138
1780
self.CheckerCompleted(dbus.Int16(exitstatus),
1139
dbus.Int64(condition),
1781
# This is specific to GNU libC
1782
dbus.Int64(exitstatus << 8),
1140
1783
dbus.String(command))
1141
1784
else:
1142
1785
# Emit D-Bus signal
1143
1786
self.CheckerCompleted(dbus.Int16(-1),
1144
dbus.Int64(condition),
1787
dbus.Int64(
1788
# This is specific to GNU libC
1789
(exitstatus << 8)
1790
| self.last_checker_signal),
1145
1791
dbus.String(command))
1146
1147
return Client.checker_callback(self, pid, condition, command,
1148
*args, **kwargs)
1792
return ret
1149
1793
1150
1794
def start_checker(self, *args, **kwargs):
1151
old_checker = self.checker
1152
if self.checker is not None:
1153
old_checker_pid = self.checker.pid
1154
else:
1155
old_checker_pid = None
1795
old_checker_pid = getattr(self.checker, "pid", None)
1156
1796
r = Client.start_checker(self, *args, **kwargs)
1157
1797
# Only if new checker process was started
1158
1798
if (self.checker is not None
1166
1806
return False
1167
1807
1168
1808
def approve(self, value=True):
1169
self.send_changedstate()
1170
1809
self.approved = value
1171
gobject.timeout_add(timedelta_to_milliseconds
1172
(self.approval_duration),
1173
self._reset_approved)
1174
1810
gobject.timeout_add(int(self.approval_duration.total_seconds()
1811
* 1000), self._reset_approved)
1812
self.send_changedstate()
1175
1813
1176
1814
## D-Bus methods, signals & properties
1177
_interface = "se.recompile.Mandos.Client"
1815
1816
## Interfaces
1178
1817
1179
1818
## Signals
1180
1819
1191
1830
pass
1192
1831
1193
1832
# PropertyChanged - signal
1833
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1194
1834
@dbus.service.signal(_interface, signature="sv")
1195
1835
def PropertyChanged(self, property, value):
1196
1836
"D-Bus signal"
1217
1857
"D-Bus signal"
1218
1858
return self.need_approval()
1219
1859
1220
# NeRwequest - signal
1221
@dbus.service.signal(_interface, signature="s")
1222
def NewRequest(self, ip):
1223
"""D-Bus signal
1224
Is sent after a client request a password.
1225
"""
1226
pass
1227
1228
1860
## Methods
1229
1861
1230
1862
# Approve - method
1238
1870
self.checked_ok()
1239
1871
1240
1872
# Enable - method
1873
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1241
1874
@dbus.service.method(_interface)
1242
1875
def Enable(self):
1243
1876
"D-Bus method"
1244
1877
self.enable()
1245
1878
1246
1879
# StartChecker - method
1880
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1247
1881
@dbus.service.method(_interface)
1248
1882
def StartChecker(self):
1249
1883
"D-Bus method"
1250
1884
self.start_checker()
1251
1885
1252
1886
# Disable - method
1887
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1253
1888
@dbus.service.method(_interface)
1254
1889
def Disable(self):
1255
1890
"D-Bus method"
1256
1891
self.disable()
1257
1892
1258
1893
# StopChecker - method
1894
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1259
1895
@dbus.service.method(_interface)
1260
1896
def StopChecker(self):
1261
1897
self.stop_checker()
1268
1904
return dbus.Boolean(bool(self.approvals_pending))
1269
1905
1270
1906
# ApprovedByDefault - property
1271
@dbus_service_property(_interface, signature="b",
1907
@dbus_service_property(_interface,
1908
signature="b",
1272
1909
access="readwrite")
1273
1910
def ApprovedByDefault_dbus_property(self, value=None):
1274
1911
if value is None: # get
1276
1913
self.approved_by_default = bool(value)
1277
1914
1278
1915
# ApprovalDelay - property
1279
@dbus_service_property(_interface, signature="t",
1916
@dbus_service_property(_interface,
1917
signature="t",
1280
1918
access="readwrite")
1281
1919
def ApprovalDelay_dbus_property(self, value=None):
1282
1920
if value is None: # get
1283
return dbus.UInt64(self.approval_delay_milliseconds())
1921
return dbus.UInt64(self.approval_delay.total_seconds()
1922
* 1000)
1284
1923
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1285
1924
1286
1925
# ApprovalDuration - property
1287
@dbus_service_property(_interface, signature="t",
1926
@dbus_service_property(_interface,
1927
signature="t",
1288
1928
access="readwrite")
1289
1929
def ApprovalDuration_dbus_property(self, value=None):
1290
1930
if value is None: # get
1291
return dbus.UInt64(timedelta_to_milliseconds(
1292
self.approval_duration))
1931
return dbus.UInt64(self.approval_duration.total_seconds()
1932
* 1000)
1293
1933
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1294
1934
1295
1935
# Name - property
1936
@dbus_annotations(
1937
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1296
1938
@dbus_service_property(_interface, signature="s", access="read")
1297
1939
def Name_dbus_property(self):
1298
1940
return dbus.String(self.name)
1299
1941
1300
1942
# Fingerprint - property
1943
@dbus_annotations(
1944
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1301
1945
@dbus_service_property(_interface, signature="s", access="read")
1302
1946
def Fingerprint_dbus_property(self):
1303
1947
return dbus.String(self.fingerprint)
1304
1948
1305
1949
# Host - property
1306
@dbus_service_property(_interface, signature="s",
1950
@dbus_service_property(_interface,
1951
signature="s",
1307
1952
access="readwrite")
1308
1953
def Host_dbus_property(self, value=None):
1309
1954
if value is None: # get
1310
1955
return dbus.String(self.host)
1311
self.host = unicode(value)
1956
self.host = str(value)
1312
1957
1313
1958
# Created - property
1959
@dbus_annotations(
1960
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1314
1961
@dbus_service_property(_interface, signature="s", access="read")
1315
1962
def Created_dbus_property(self):
1316
1963
return datetime_to_dbus(self.created)
1321
1968
return datetime_to_dbus(self.last_enabled)
1322
1969
1323
1970
# Enabled - property
1324
@dbus_service_property(_interface, signature="b",
1971
@dbus_service_property(_interface,
1972
signature="b",
1325
1973
access="readwrite")
1326
1974
def Enabled_dbus_property(self, value=None):
1327
1975
if value is None: # get
1332
1980
self.disable()
1333
1981
1334
1982
# LastCheckedOK - property
1335
@dbus_service_property(_interface, signature="s",
1983
@dbus_service_property(_interface,
1984
signature="s",
1336
1985
access="readwrite")
1337
1986
def LastCheckedOK_dbus_property(self, value=None):
1338
1987
if value is not None:
1340
1989
return
1341
1990
return datetime_to_dbus(self.last_checked_ok)
1342
1991
1992
# LastCheckerStatus - property
1993
@dbus_service_property(_interface, signature="n", access="read")
1994
def LastCheckerStatus_dbus_property(self):
1995
return dbus.Int16(self.last_checker_status)
1996
1343
1997
# Expires - property
1344
1998
@dbus_service_property(_interface, signature="s", access="read")
1345
1999
def Expires_dbus_property(self):
1351
2005
return datetime_to_dbus(self.last_approval_request)
1352
2006
1353
2007
# Timeout - property
1354
@dbus_service_property(_interface, signature="t",
2008
@dbus_service_property(_interface,
2009
signature="t",
1355
2010
access="readwrite")
1356
2011
def Timeout_dbus_property(self, value=None):
1357
2012
if value is None: # get
1358
return dbus.UInt64(self.timeout_milliseconds())
2013
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2014
old_timeout = self.timeout
1359
2015
self.timeout = datetime.timedelta(0, 0, 0, value)
1360
if getattr(self, "disable_initiator_tag", None) is None:
1361
return
1362
# Reschedule timeout
1363
gobject.source_remove(self.disable_initiator_tag)
1364
self.disable_initiator_tag = None
1365
self.expires = None
1366
time_to_die = timedelta_to_milliseconds((self
1367
.last_checked_ok
1368
+ self.timeout)
1369
- datetime.datetime
1370
.utcnow())
1371
if time_to_die <= 0:
1372
# The timeout has passed
1373
self.disable()
1374
else:
1375
self.expires = (datetime.datetime.utcnow()
1376
+ datetime.timedelta(milliseconds =
1377
time_to_die))
1378
self.disable_initiator_tag = (gobject.timeout_add
1379
(time_to_die, self.disable))
2016
# Reschedule disabling
2017
if self.enabled:
2018
now = datetime.datetime.utcnow()
2019
self.expires += self.timeout - old_timeout
2020
if self.expires <= now:
2021
# The timeout has passed
2022
self.disable()
2023
else:
2024
if (getattr(self, "disable_initiator_tag", None)
2025
is None):
2026
return
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)
1380
2031
1381
2032
# ExtendedTimeout - property
1382
@dbus_service_property(_interface, signature="t",
2033
@dbus_service_property(_interface,
2034
signature="t",
1383
2035
access="readwrite")
1384
2036
def ExtendedTimeout_dbus_property(self, value=None):
1385
2037
if value is None: # get
1386
return dbus.UInt64(self.extended_timeout_milliseconds())
2038
return dbus.UInt64(self.extended_timeout.total_seconds()
2039
* 1000)
1387
2040
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1388
2041
1389
2042
# Interval - property
1390
@dbus_service_property(_interface, signature="t",
2043
@dbus_service_property(_interface,
2044
signature="t",
1391
2045
access="readwrite")
1392
2046
def Interval_dbus_property(self, value=None):
1393
2047
if value is None: # get
1394
return dbus.UInt64(self.interval_milliseconds())
2048
return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
2049
self.interval = datetime.timedelta(0, 0, 0, value)
1396
2050
if getattr(self, "checker_initiator_tag", None) is None:
1397
2051
return
1398
2052
if self.enabled:
1399
2053
# Reschedule checker run
1400
2054
gobject.source_remove(self.checker_initiator_tag)
1401
self.checker_initiator_tag = (gobject.timeout_add
1402
(value, self.start_checker))
1403
self.start_checker() # Start one now, too
2055
self.checker_initiator_tag = gobject.timeout_add(
2056
value, self.start_checker)
2057
self.start_checker() # Start one now, too
1404
2058
1405
2059
# Checker - property
1406
@dbus_service_property(_interface, signature="s",
2060
@dbus_service_property(_interface,
2061
signature="s",
1407
2062
access="readwrite")
1408
2063
def Checker_dbus_property(self, value=None):
1409
2064
if value is None: # get
1410
2065
return dbus.String(self.checker_command)
1411
self.checker_command = unicode(value)
2066
self.checker_command = str(value)
1412
2067
1413
2068
# CheckerRunning - property
1414
@dbus_service_property(_interface, signature="b",
2069
@dbus_service_property(_interface,
2070
signature="b",
1415
2071
access="readwrite")
1416
2072
def CheckerRunning_dbus_property(self, value=None):
1417
2073
if value is None: # get
1422
2078
self.stop_checker()
1423
2079
1424
2080
# ObjectPath - property
2081
@dbus_annotations(
2082
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2083
"org.freedesktop.DBus.Deprecated": "true"})
1425
2084
@dbus_service_property(_interface, signature="o", access="read")
1426
2085
def ObjectPath_dbus_property(self):
1427
2086
return self.dbus_object_path # is already a dbus.ObjectPath
1428
2087
1429
2088
# Secret = property
1430
@dbus_service_property(_interface, signature="ay",
1431
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)
1432
2096
def Secret_dbus_property(self, value):
1433
self.secret = str(value)
2097
self.secret = bytes(value)
1434
2098
1435
2099
del _interface
1436
2100
1440
2104
self._pipe = child_pipe
1441
2105
self._pipe.send(('init', fpr, address))
1442
2106
if not self._pipe.recv():
1443
raise KeyError()
2107
raise KeyError(fpr)
1444
2108
1445
2109
def __getattribute__(self, name):
1446
2110
if name == '_pipe':
1450
2114
if data[0] == 'data':
1451
2115
return data[1]
1452
2116
if data[0] == 'function':
2117
1453
2118
def func(*args, **kwargs):
1454
2119
self._pipe.send(('funcall', name, args, kwargs))
1455
2120
return self._pipe.recv()[1]
2121
1456
2122
return func
1457
2123
1458
2124
def __setattr__(self, name, value):
1461
2127
self._pipe.send(('setattr', name, value))
1462
2128
1463
2129
1464
class ClientDBusTransitional(ClientDBus):
1465
__metaclass__ = AlternateDBusNamesMetaclass
1466
1467
1468
2130
class ClientHandler(socketserver.BaseRequestHandler, object):
1469
2131
"""A class to handle client connections.
1470
2132
1474
2136
def handle(self):
1475
2137
with contextlib.closing(self.server.child_pipe) as child_pipe:
1476
2138
logger.info("TCP connection from: %s",
1477
unicode(self.client_address))
2139
str(self.client_address))
1478
2140
logger.debug("Pipe FD: %d",
1479
2141
self.server.child_pipe.fileno())
1480
2142
1481
session = (gnutls.connection
1482
.ClientSession(self.request,
1483
gnutls.connection
1484
.X509Credentials()))
1485
1486
# Note: gnutls.connection.X509Credentials is really a
1487
# generic GnuTLS certificate credentials object so long as
1488
# no X.509 keys are added to it. Therefore, we can use it
1489
# here despite using OpenPGP certificates.
2143
session = gnutls.ClientSession(self.request)
1490
2144
1491
2145
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1492
2146
# "+AES-256-CBC", "+SHA1",
1496
2150
priority = self.server.gnutls_priority
1497
2151
if priority is None:
1498
2152
priority = "NORMAL"
1499
(gnutls.library.functions
1500
.gnutls_priority_set_direct(session._c_object,
1501
priority, None))
2153
gnutls.priority_set_direct(session._c_object, priority,
2154
None)
1502
2155
1503
2156
# Start communication using the Mandos protocol
1504
2157
# Get protocol number
1506
2159
logger.debug("Protocol version: %r", line)
1507
2160
try:
1508
2161
if int(line.strip().split()[0]) > 1:
1509
raise RuntimeError
2162
raise RuntimeError(line)
1510
2163
except (ValueError, IndexError, RuntimeError) as error:
1511
2164
logger.error("Unknown protocol version: %s", error)
1512
2165
return
1514
2167
# Start GnuTLS connection
1515
2168
try:
1516
2169
session.handshake()
1517
except gnutls.errors.GNUTLSError as error:
2170
except gnutls.Error as error:
1518
2171
logger.warning("Handshake failed: %s", error)
1519
2172
# Do not run session.bye() here: the session is not
1520
2173
# established. Just abandon the request.
1524
2177
approval_required = False
1525
2178
try:
1526
2179
try:
1527
fpr = self.fingerprint(self.peer_certificate
1528
(session))
1529
except (TypeError,
1530
gnutls.errors.GNUTLSError) as error:
2180
fpr = self.fingerprint(
2181
self.peer_certificate(session))
2182
except (TypeError, gnutls.Error) as error:
1531
2183
logger.warning("Bad certificate: %s", error)
1532
2184
return
1533
2185
logger.debug("Fingerprint: %s", fpr)
1538
2190
except KeyError:
1539
2191
return
1540
2192
1541
if self.server.use_dbus:
1542
# Emit D-Bus signal
1543
client.NewRequest(str(self.client_address))
1544
1545
2193
if client.approval_delay:
1546
2194
delay = client.approval_delay
1547
2195
client.approvals_pending += 1
1550
2198
while True:
1551
2199
if not client.enabled:
1552
2200
logger.info("Client %s is disabled",
1553
client.name)
2201
client.name)
1554
2202
if self.server.use_dbus:
1555
2203
# Emit D-Bus signal
1556
2204
client.Rejected("Disabled")
1565
2213
if self.server.use_dbus:
1566
2214
# Emit D-Bus signal
1567
2215
client.NeedApproval(
1568
client.approval_delay_milliseconds(),
1569
client.approved_by_default)
2216
client.approval_delay.total_seconds()
2217
* 1000, client.approved_by_default)
1570
2218
else:
1571
2219
logger.warning("Client %s was not approved",
1572
2220
client.name)
1578
2226
#wait until timeout or approved
1579
2227
time = datetime.datetime.now()
1580
2228
client.changedstate.acquire()
1581
(client.changedstate.wait
1582
(float(client.timedelta_to_milliseconds(delay)
1583
/ 1000)))
2229
client.changedstate.wait(delay.total_seconds())
1584
2230
client.changedstate.release()
1585
2231
time2 = datetime.datetime.now()
1586
2232
if (time2 - time) >= delay:
1597
2243
else:
1598
2244
delay -= time2 - time
1599
2245
1600
sent_size = 0
1601
while sent_size < len(client.secret):
1602
try:
1603
sent = session.send(client.secret[sent_size:])
1604
except gnutls.errors.GNUTLSError as error:
1605
logger.warning("gnutls send failed")
1606
return
1607
logger.debug("Sent: %d, remaining: %d",
1608
sent, len(client.secret)
1609
- (sent_size + sent))
1610
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
1611
2252
1612
2253
logger.info("Sending secret to %s", client.name)
1613
2254
# bump the timeout using extended_timeout
1614
client.checked_ok(client.extended_timeout)
2255
client.bump_timeout(client.extended_timeout)
1615
2256
if self.server.use_dbus:
1616
2257
# Emit D-Bus signal
1617
2258
client.GotSecret()
1621
2262
client.approvals_pending -= 1
1622
2263
try:
1623
2264
session.bye()
1624
except gnutls.errors.GNUTLSError as error:
1625
logger.warning("GnuTLS bye failed")
2265
except gnutls.Error as error:
2266
logger.warning("GnuTLS bye failed",
2267
exc_info=error)
1626
2268
1627
2269
@staticmethod
1628
2270
def peer_certificate(session):
1629
2271
"Return the peer's OpenPGP certificate as a bytestring"
1630
2272
# If not an OpenPGP certificate...
1631
if (gnutls.library.functions
1632
.gnutls_certificate_type_get(session._c_object)
1633
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1634
# ...do the normal thing
1635
return session.peer_certificate
2273
if (gnutls.certificate_type_get(session._c_object)
2274
!= gnutls.CRT_OPENPGP):
2275
# ...return invalid data
2276
return b""
1636
2277
list_size = ctypes.c_uint(1)
1637
cert_list = (gnutls.library.functions
1638
.gnutls_certificate_get_peers
2278
cert_list = (gnutls.certificate_get_peers
1639
2279
(session._c_object, ctypes.byref(list_size)))
1640
2280
if not bool(cert_list) and list_size.value != 0:
1641
raise gnutls.errors.GNUTLSError("error getting peer"
1642
" certificate")
2281
raise gnutls.Error("error getting peer certificate")
1643
2282
if list_size.value == 0:
1644
2283
return None
1645
2284
cert = cert_list[0]
1649
2288
def fingerprint(openpgp):
1650
2289
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1651
2290
# New GnuTLS "datum" with the OpenPGP public key
1652
datum = (gnutls.library.types
1653
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1654
ctypes.POINTER
1655
(ctypes.c_ubyte)),
1656
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)))
1657
2295
# New empty GnuTLS certificate
1658
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1659
(gnutls.library.functions
1660
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2296
crt = gnutls.openpgp_crt_t()
2297
gnutls.openpgp_crt_init(ctypes.byref(crt))
1661
2298
# Import the OpenPGP public key into the certificate
1662
(gnutls.library.functions
1663
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1664
gnutls.library.constants
1665
.GNUTLS_OPENPGP_FMT_RAW))
2299
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2300
gnutls.OPENPGP_FMT_RAW)
1666
2301
# Verify the self signature in the key
1667
2302
crtverify = ctypes.c_uint()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_verify_self(crt, 0,
1670
ctypes.byref(crtverify)))
2303
gnutls.openpgp_crt_verify_self(crt, 0,
2304
ctypes.byref(crtverify))
1671
2305
if crtverify.value != 0:
1672
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1673
raise (gnutls.errors.CertificateSecurityError
1674
("Verify failed"))
2306
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
1675
2308
# New buffer for the fingerprint
1676
2309
buf = ctypes.create_string_buffer(20)
1677
2310
buf_len = ctypes.c_size_t()
1678
2311
# Get the fingerprint from the certificate into the buffer
1679
(gnutls.library.functions
1680
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1681
ctypes.byref(buf_len)))
2312
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2313
ctypes.byref(buf_len))
1682
2314
# Deinit the certificate
1683
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2315
gnutls.openpgp_crt_deinit(crt)
1684
2316
# Convert the buffer to a Python bytestring
1685
2317
fpr = ctypes.string_at(buf, buf_len.value)
1686
2318
# Convert the bytestring to hexadecimal notation
1690
2322
1691
2323
class MultiprocessingMixIn(object):
1692
2324
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2325
1693
2326
def sub_process_main(self, request, address):
1694
2327
try:
1695
2328
self.finish_request(request, address)
1700
2333
def process_request(self, request, address):
1701
2334
"""Start a new process to process the request."""
1702
2335
proc = multiprocessing.Process(target = self.sub_process_main,
1703
args = (request,
1704
address))
2336
args = (request, address))
1705
2337
proc.start()
1706
2338
return proc
1707
2339
1708
2340
1709
2341
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1710
2342
""" adds a pipe to the MixIn """
2343
1711
2344
def process_request(self, request, client_address):
1712
2345
"""Overrides and wraps the original process_request().
1713
2346
1722
2355
1723
2356
def add_pipe(self, parent_pipe, proc):
1724
2357
"""Dummy function; override as necessary"""
1725
raise NotImplementedError
2358
raise NotImplementedError()
1726
2359
1727
2360
1728
2361
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1734
2367
interface: None or a network interface name (string)
1735
2368
use_ipv6: Boolean; to use IPv6 or not
1736
2369
"""
2370
1737
2371
def __init__(self, server_address, RequestHandlerClass,
1738
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
"""
1739
2378
self.interface = interface
1740
2379
if use_ipv6:
1741
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.
1742
2407
socketserver.TCPServer.__init__(self, server_address,
1743
2408
RequestHandlerClass)
2409
1744
2410
def server_bind(self):
1745
2411
"""This overrides the normal server_bind() function
1746
2412
to bind to an interface if one was specified, and also NOT to
1752
2418
self.interface)
1753
2419
else:
1754
2420
try:
1755
self.socket.setsockopt(socket.SOL_SOCKET,
1756
SO_BINDTODEVICE,
1757
str(self.interface
1758
+ '\0'))
2421
self.socket.setsockopt(
2422
socket.SOL_SOCKET, SO_BINDTODEVICE,
2423
(self.interface + "\0").encode("utf-8"))
1759
2424
except socket.error as error:
1760
if error[0] == errno.EPERM:
1761
logger.error("No permission to"
1762
" bind to interface %s",
1763
self.interface)
1764
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:
1765
2429
logger.error("SO_BINDTODEVICE not available;"
1766
2430
" cannot bind to interface %s",
1767
2431
self.interface)
2432
elif error.errno == errno.ENODEV:
2433
logger.error("Interface %s does not exist,"
2434
" cannot bind", self.interface)
1768
2435
else:
1769
2436
raise
1770
2437
# Only bind(2) the socket if we really need to.
1773
2440
if self.address_family == socket.AF_INET6:
1774
2441
any_address = "::" # in6addr_any
1775
2442
else:
1776
any_address = socket.INADDR_ANY
2443
any_address = "0.0.0.0" # INADDR_ANY
1777
2444
self.server_address = (any_address,
1778
2445
self.server_address[1])
1779
2446
elif not self.server_address[1]:
1780
self.server_address = (self.server_address[0],
1781
0)
2447
self.server_address = (self.server_address[0], 0)
1782
2448
# if self.interface:
1783
2449
# self.server_address = (self.server_address[0],
1784
2450
# 0, # port
1798
2464
1799
2465
Assumes a gobject.MainLoop event loop.
1800
2466
"""
2467
1801
2468
def __init__(self, server_address, RequestHandlerClass,
1802
interface=None, use_ipv6=True, clients=None,
1803
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):
1804
2475
self.enabled = False
1805
2476
self.clients = clients
1806
2477
if self.clients is None:
1810
2481
IPv6_TCPServer.__init__(self, server_address,
1811
2482
RequestHandlerClass,
1812
2483
interface = interface,
1813
use_ipv6 = use_ipv6)
2484
use_ipv6 = use_ipv6,
2485
socketfd = socketfd)
2486
1814
2487
def server_activate(self):
1815
2488
if self.enabled:
1816
2489
return socketserver.TCPServer.server_activate(self)
1820
2493
1821
2494
def add_pipe(self, parent_pipe, proc):
1822
2495
# Call "handle_ipc" for both data and EOF events
1823
gobject.io_add_watch(parent_pipe.fileno(),
1824
gobject.IO_IN | gobject.IO_HUP,
1825
functools.partial(self.handle_ipc,
1826
parent_pipe =
1827
parent_pipe,
1828
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))
1829
2502
1830
def handle_ipc(self, source, condition, parent_pipe=None,
1831
proc = None, client_object=None):
1832
condition_names = {
1833
gobject.IO_IN: "IN", # There is data to read.
1834
gobject.IO_OUT: "OUT", # Data can be written (without
1835
# blocking).
1836
gobject.IO_PRI: "PRI", # There is urgent data to read.
1837
gobject.IO_ERR: "ERR", # Error condition.
1838
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1839
# broken, usually for pipes and
1840
# sockets).
1841
}
1842
conditions_string = ' | '.join(name
1843
for cond, name in
1844
condition_names.iteritems()
1845
if cond & condition)
2503
def handle_ipc(self, source, condition,
2504
parent_pipe=None,
2505
proc = None,
2506
client_object=None):
1846
2507
# error, or the other end of multiprocessing.Pipe has closed
1847
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2508
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1848
2509
# Wait for other process to exit
1849
2510
proc.join()
1850
2511
return False
1871
2532
parent_pipe.send(False)
1872
2533
return False
1873
2534
1874
gobject.io_add_watch(parent_pipe.fileno(),
1875
gobject.IO_IN | gobject.IO_HUP,
1876
functools.partial(self.handle_ipc,
1877
parent_pipe =
1878
parent_pipe,
1879
proc = proc,
1880
client_object =
1881
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))
1882
2542
parent_pipe.send(True)
1883
2543
# remove the old hook in favor of the new above hook on
1884
2544
# same fileno
1890
2550
1891
2551
parent_pipe.send(('data', getattr(client_object,
1892
2552
funcname)(*args,
1893
**kwargs)))
2553
**kwargs)))
1894
2554
1895
2555
if command == 'getattr':
1896
2556
attrname = request[1]
1897
if callable(client_object.__getattribute__(attrname)):
1898
parent_pipe.send(('function',))
2557
if isinstance(client_object.__getattribute__(attrname),
2558
collections.Callable):
2559
parent_pipe.send(('function', ))
1899
2560
else:
1900
parent_pipe.send(('data', client_object
1901
.__getattribute__(attrname)))
2561
parent_pipe.send((
2562
'data', client_object.__getattribute__(attrname)))
1902
2563
1903
2564
if command == 'setattr':
1904
2565
attrname = request[1]
1908
2569
return True
1909
2570
1910
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
1911
2668
def string_to_delta(interval):
1912
2669
"""Parse a string and return a datetime.timedelta
1913
2670
1924
2681
>>> string_to_delta('5m 30s')
1925
2682
datetime.timedelta(0, 330)
1926
2683
"""
2684
2685
try:
2686
return rfc3339_duration_to_delta(interval)
2687
except ValueError:
2688
pass
2689
1927
2690
timevalue = datetime.timedelta(0)
1928
2691
for s in interval.split():
1929
2692
try:
1930
suffix = unicode(s[-1])
2693
suffix = s[-1]
1931
2694
value = int(s[:-1])
1932
2695
if suffix == "d":
1933
2696
delta = datetime.timedelta(value)
1940
2703
elif suffix == "w":
1941
2704
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1942
2705
else:
1943
raise ValueError("Unknown suffix %r" % suffix)
1944
except (ValueError, IndexError) as e:
2706
raise ValueError("Unknown suffix {!r}".format(suffix))
2707
except IndexError as e:
1945
2708
raise ValueError(*(e.args))
1946
2709
timevalue += delta
1947
2710
return timevalue
1960
2723
sys.exit()
1961
2724
if not noclose:
1962
2725
# Close all standard open file descriptors
1963
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2726
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1964
2727
if not stat.S_ISCHR(os.fstat(null).st_mode):
1965
2728
raise OSError(errno.ENODEV,
1966
"%s not a character device"
1967
% os.path.devnull)
2729
"{} not a character device"
2730
.format(os.devnull))
1968
2731
os.dup2(null, sys.stdin.fileno())
1969
2732
os.dup2(null, sys.stdout.fileno())
1970
2733
os.dup2(null, sys.stderr.fileno())
1979
2742
1980
2743
parser = argparse.ArgumentParser()
1981
2744
parser.add_argument("-v", "--version", action="version",
1982
version = "%%(prog)s %s" % version,
2745
version = "%(prog)s {}".format(version),
1983
2746
help="show version number and exit")
1984
2747
parser.add_argument("-i", "--interface", metavar="IF",
1985
2748
help="Bind to interface IF")
1991
2754
help="Run self-test")
1992
2755
parser.add_argument("--debug", action="store_true",
1993
2756
help="Debug mode; run in foreground and log"
1994
" to terminal")
2757
" to terminal", default=None)
1995
2758
parser.add_argument("--debuglevel", metavar="LEVEL",
1996
2759
help="Debug level for stdout output")
1997
2760
parser.add_argument("--priority", help="GnuTLS"
2004
2767
" files")
2005
2768
parser.add_argument("--no-dbus", action="store_false",
2006
2769
dest="use_dbus", help="Do not provide D-Bus"
2007
" system bus interface")
2770
" system bus interface", default=None)
2008
2771
parser.add_argument("--no-ipv6", action="store_false",
2009
dest="use_ipv6", help="Do not use IPv6")
2772
dest="use_ipv6", help="Do not use IPv6",
2773
default=None)
2010
2774
parser.add_argument("--no-restore", action="store_false",
2011
2775
dest="restore", help="Do not restore stored"
2012
" 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")
2013
2780
parser.add_argument("--statedir", metavar="DIR",
2014
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)
2015
2787
2016
2788
options = parser.parse_args()
2017
2789
2018
2790
if options.check:
2019
2791
import doctest
2020
doctest.testmod()
2021
sys.exit()
2792
fail_count, test_count = doctest.testmod()
2793
sys.exit(os.EX_OK if fail_count == 0 else 1)
2022
2794
2023
2795
# Default values for config file for server-global settings
2024
2796
server_defaults = { "interface": "",
2026
2798
"port": "",
2027
2799
"debug": "False",
2028
2800
"priority":
2029
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2801
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2802
":+SIGN-DSA-SHA256",
2030
2803
"servicename": "Mandos",
2031
2804
"use_dbus": "True",
2032
2805
"use_ipv6": "True",
2033
2806
"debuglevel": "",
2034
2807
"restore": "True",
2035
"statedir": "/var/lib/mandos"
2036
}
2808
"socket": "",
2809
"statedir": "/var/lib/mandos",
2810
"foreground": "False",
2811
"zeroconf": "True",
2812
}
2037
2813
2038
2814
# Parse config file for server-global settings
2039
2815
server_config = configparser.SafeConfigParser(server_defaults)
2040
2816
del server_defaults
2041
server_config.read(os.path.join(options.configdir,
2042
"mandos.conf"))
2817
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2043
2818
# Convert the SafeConfigParser object to a dict
2044
2819
server_settings = server_config.defaults()
2045
2820
# Use the appropriate methods on the non-string config options
2046
for option in ("debug", "use_dbus", "use_ipv6"):
2821
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2047
2822
server_settings[option] = server_config.getboolean("DEFAULT",
2048
2823
option)
2049
2824
if server_settings["port"]:
2050
2825
server_settings["port"] = server_config.getint("DEFAULT",
2051
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"])
2052
2836
del server_config
2053
2837
2054
2838
# Override the settings from the config file with command line
2055
2839
# options, if set.
2056
2840
for option in ("interface", "address", "port", "debug",
2057
"priority", "servicename", "configdir",
2058
"use_dbus", "use_ipv6", "debuglevel", "restore",
2059
"statedir"):
2841
"priority", "servicename", "configdir", "use_dbus",
2842
"use_ipv6", "debuglevel", "restore", "statedir",
2843
"socket", "foreground", "zeroconf"):
2060
2844
value = getattr(options, option)
2061
2845
if value is not None:
2062
2846
server_settings[option] = value
2063
2847
del options
2064
2848
# Force all strings to be unicode
2065
2849
for option in server_settings.keys():
2066
if type(server_settings[option]) is str:
2067
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
2068
2860
# Now we have our good server settings in "server_settings"
2069
2861
2070
2862
##################################################################
2071
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
2072
2869
# For convenience
2073
2870
debug = server_settings["debug"]
2074
2871
debuglevel = server_settings["debuglevel"]
2076
2873
use_ipv6 = server_settings["use_ipv6"]
2077
2874
stored_state_path = os.path.join(server_settings["statedir"],
2078
2875
stored_state_file)
2876
foreground = server_settings["foreground"]
2877
zeroconf = server_settings["zeroconf"]
2079
2878
2080
2879
if debug:
2081
initlogger(logging.DEBUG)
2880
initlogger(debug, logging.DEBUG)
2082
2881
else:
2083
2882
if not debuglevel:
2084
initlogger()
2883
initlogger(debug)
2085
2884
else:
2086
2885
level = getattr(logging, debuglevel.upper())
2087
initlogger(level)
2886
initlogger(debug, level)
2088
2887
2089
2888
if server_settings["servicename"] != "Mandos":
2090
syslogger.setFormatter(logging.Formatter
2091
('Mandos (%s) [%%(process)d]:'
2092
' %%(levelname)s: %%(message)s'
2093
% server_settings["servicename"]))
2889
syslogger.setFormatter(
2890
logging.Formatter('Mandos ({}) [%(process)d]:'
2891
' %(levelname)s: %(message)s'.format(
2892
server_settings["servicename"])))
2094
2893
2095
2894
# Parse config file with clients
2096
client_config = configparser.SafeConfigParser(Client.client_defaults)
2895
client_config = configparser.SafeConfigParser(Client
2896
.client_defaults)
2097
2897
client_config.read(os.path.join(server_settings["configdir"],
2098
2898
"clients.conf"))
2099
2899
2100
2900
global mandos_dbus_service
2101
2901
mandos_dbus_service = None
2102
2902
2103
tcp_server = MandosServer((server_settings["address"],
2104
server_settings["port"]),
2105
ClientHandler,
2106
interface=(server_settings["interface"]
2107
or None),
2108
use_ipv6=use_ipv6,
2109
gnutls_priority=
2110
server_settings["priority"],
2111
use_dbus=use_dbus)
2112
if not debug:
2113
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
2114
2919
try:
2115
pidfile = open(pidfilename, "w")
2116
except IOError:
2117
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)
2118
2924
2119
try:
2120
uid = pwd.getpwnam("_mandos").pw_uid
2121
gid = pwd.getpwnam("_mandos").pw_gid
2122
except KeyError:
2925
for name, group in (("_mandos", "_mandos"),
2926
("mandos", "mandos"),
2927
("nobody", "nogroup")):
2123
2928
try:
2124
uid = pwd.getpwnam("mandos").pw_uid
2125
gid = pwd.getpwnam("mandos").pw_gid
2929
uid = pwd.getpwnam(name).pw_uid
2930
gid = pwd.getpwnam(group).pw_gid
2931
break
2126
2932
except KeyError:
2127
try:
2128
uid = pwd.getpwnam("nobody").pw_uid
2129
gid = pwd.getpwnam("nobody").pw_gid
2130
except KeyError:
2131
uid = 65534
2132
gid = 65534
2933
continue
2934
else:
2935
uid = 65534
2936
gid = 65534
2133
2937
try:
2134
2938
os.setgid(gid)
2135
2939
os.setuid(uid)
2136
2940
except OSError as error:
2137
if error[0] != errno.EPERM:
2138
raise error
2941
if error.errno != errno.EPERM:
2942
raise
2139
2943
2140
2944
if debug:
2141
2945
# Enable all possible GnuTLS debugging
2142
2946
2143
2947
# "Use a log level over 10 to enable all debugging options."
2144
2948
# - GnuTLS manual
2145
gnutls.library.functions.gnutls_global_set_log_level(11)
2949
gnutls.global_set_log_level(11)
2146
2950
2147
@gnutls.library.types.gnutls_log_func
2951
@gnutls.log_func
2148
2952
def debug_gnutls(level, string):
2149
2953
logger.debug("GnuTLS: %s", string[:-1])
2150
2954
2151
(gnutls.library.functions
2152
.gnutls_global_set_log_function(debug_gnutls))
2955
gnutls.global_set_log_function(debug_gnutls)
2153
2956
2154
2957
# Redirect stdin so all checkers get /dev/null
2155
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2958
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
2959
os.dup2(null, sys.stdin.fileno())
2157
2960
if null > 2:
2158
2961
os.close(null)
2159
else:
2160
# No console logging
2161
logger.removeHandler(console)
2162
2962
2163
2963
# Need to fork before connecting to D-Bus
2164
if not debug:
2964
if not foreground:
2165
2965
# Close all input and output, do double fork, etc.
2166
2966
daemon()
2167
2967
2968
# multiprocessing will use threads, so before we use gobject we
2969
# need to inform gobject that threads will be used.
2168
2970
gobject.threads_init()
2169
2971
2170
2972
global main_loop
2171
2973
# From the Avahi example code
2172
DBusGMainLoop(set_as_default=True )
2974
DBusGMainLoop(set_as_default=True)
2173
2975
main_loop = gobject.MainLoop()
2174
2976
bus = dbus.SystemBus()
2175
2977
# End of Avahi example code
2176
2978
if use_dbus:
2177
2979
try:
2178
2980
bus_name = dbus.service.BusName("se.recompile.Mandos",
2179
bus, do_not_queue=True)
2180
old_bus_name = (dbus.service.BusName
2181
("se.bsnet.fukt.Mandos", bus,
2182
do_not_queue=True))
2183
except dbus.exceptions.NameExistsException as e:
2184
logger.error(unicode(e) + ", disabling D-Bus")
2981
bus,
2982
do_not_queue=True)
2983
old_bus_name = dbus.service.BusName(
2984
"se.bsnet.fukt.Mandos", bus,
2985
do_not_queue=True)
2986
except dbus.exceptions.DBusException as e:
2987
logger.error("Disabling D-Bus:", exc_info=e)
2185
2988
use_dbus = False
2186
2989
server_settings["use_dbus"] = False
2187
2990
tcp_server.use_dbus = False
2188
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2189
service = AvahiServiceToSyslog(name =
2190
server_settings["servicename"],
2191
servicetype = "_mandos._tcp",
2192
protocol = protocol, bus = bus)
2193
if server_settings["interface"]:
2194
service.interface = (if_nametoindex
2195
(str(server_settings["interface"])))
2991
if zeroconf:
2992
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2993
service = AvahiServiceToSyslog(
2994
name = server_settings["servicename"],
2995
servicetype = "_mandos._tcp",
2996
protocol = protocol,
2997
bus = bus)
2998
if server_settings["interface"]:
2999
service.interface = if_nametoindex(
3000
server_settings["interface"].encode("utf-8"))
2196
3001
2197
3002
global multiprocessing_manager
2198
3003
multiprocessing_manager = multiprocessing.Manager()
2199
3004
2200
3005
client_class = Client
2201
3006
if use_dbus:
2202
client_class = functools.partial(ClientDBusTransitional,
2203
bus = bus)
3007
client_class = functools.partial(ClientDBus, bus = bus)
2204
3008
2205
3009
client_settings = Client.config_parser(client_config)
2206
3010
old_client_settings = {}
2207
3011
clients_data = {}
2208
3012
3013
# This is used to redirect stdout and stderr for checker processes
3014
global wnull
3015
wnull = open(os.devnull, "w") # A writable /dev/null
3016
# Only used if server is running in foreground but not in debug
3017
# mode
3018
if debug or not foreground:
3019
wnull.close()
3020
2209
3021
# Get client data and settings from last running state.
2210
3022
if server_settings["restore"]:
2211
3023
try:
2212
3024
with open(stored_state_path, "rb") as stored_state:
2213
clients_data, old_client_settings = (pickle.load
2214
(stored_state))
3025
clients_data, old_client_settings = pickle.load(
3026
stored_state)
2215
3027
os.remove(stored_state_path)
2216
3028
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2218
.format(e))
2219
if e.errno != errno.ENOENT:
3029
if e.errno == errno.ENOENT:
3030
logger.warning("Could not load persistent state:"
3031
" {}".format(os.strerror(e.errno)))
3032
else:
3033
logger.critical("Could not load persistent state:",
3034
exc_info=e)
2220
3035
raise
2221
3036
except EOFError as e:
2222
3037
logger.warning("Could not load persistent state: "
2223
"EOFError: {0}".format(e))
3038
"EOFError:",
3039
exc_info=e)
2224
3040
2225
3041
with PGPEngine() as pgp:
2226
for client_name, client in clients_data.iteritems():
3042
for client_name, client in clients_data.items():
3043
# Skip removed clients
3044
if client_name not in client_settings:
3045
continue
3046
2227
3047
# Decide which value to use after restoring saved state.
2228
3048
# We have three different values: Old config file,
2229
3049
# new config file, and saved state.
2234
3054
# For each value in new config, check if it
2235
3055
# differs from the old config value (Except for
2236
3056
# the "secret" attribute)
2237
if (name != "secret" and
2238
value != old_client_settings[client_name]
2239
[name]):
3057
if (name != "secret"
3058
and (value !=
3059
old_client_settings[client_name][name])):
2240
3060
client[name] = value
2241
3061
except KeyError:
2242
3062
pass
2243
3063
2244
3064
# Clients who has passed its expire date can still be
2245
# enabled if its last checker was successful. Clients
2246
# whose checker failed before we stored its state is
2247
# assumed to have failed all checkers during downtime.
3065
# enabled if its last checker was successful. A Client
3066
# whose checker succeeded before we stored its state is
3067
# assumed to have successfully run all checkers during
3068
# downtime.
2248
3069
if client["enabled"]:
2249
3070
if datetime.datetime.utcnow() >= client["expires"]:
2250
3071
if not client["last_checked_ok"]:
2251
3072
logger.warning(
2252
"disabling client {0} - Client never "
2253
"performed a successfull checker"
2254
.format(client["name"]))
3073
"disabling client {} - Client never "
3074
"performed a successful checker".format(
3075
client_name))
2255
3076
client["enabled"] = False
2256
3077
elif client["last_checker_status"] != 0:
2257
3078
logger.warning(
2258
"disabling client {0} - Client "
2259
"last checker failed with error code {1}"
2260
.format(client["name"],
2261
client["last_checker_status"]))
3079
"disabling client {} - Client last"
3080
" checker failed with error code"
3081
" {}".format(
3082
client_name,
3083
client["last_checker_status"]))
2262
3084
client["enabled"] = False
2263
3085
else:
2264
client["expires"] = (datetime.datetime
2265
.utcnow()
2266
+ client["timeout"])
2267
3086
client["expires"] = (
3087
datetime.datetime.utcnow()
3088
+ client["timeout"])
3089
logger.debug("Last checker succeeded,"
3090
" keeping {} enabled".format(
3091
client_name))
2268
3092
try:
2269
client["secret"] = (
2270
pgp.decrypt(client["encrypted_secret"],
2271
client_settings[client_name]
2272
["secret"]))
3093
client["secret"] = pgp.decrypt(
3094
client["encrypted_secret"],
3095
client_settings[client_name]["secret"])
2273
3096
except PGPError:
2274
3097
# If decryption fails, we use secret from new settings
2275
logger.debug("Failed to decrypt {0} old secret"
2276
.format(client_name))
2277
client["secret"] = (
2278
client_settings[client_name]["secret"])
2279
3098
logger.debug("Failed to decrypt {} old secret".format(
3099
client_name))
3100
client["secret"] = (client_settings[client_name]
3101
["secret"])
2280
3102
2281
3103
# Add/remove clients based on new changes made to config
2282
for client_name in set(old_client_settings) - set(client_settings):
3104
for client_name in (set(old_client_settings)
3105
- set(client_settings)):
2283
3106
del clients_data[client_name]
2284
for client_name in set(client_settings) - set(old_client_settings):
3107
for client_name in (set(client_settings)
3108
- set(old_client_settings)):
2285
3109
clients_data[client_name] = client_settings[client_name]
2286
2287
# Create clients all clients
2288
for client_name, client in clients_data.iteritems():
3110
3111
# Create all client objects
3112
for client_name, client in clients_data.items():
2289
3113
tcp_server.clients[client_name] = client_class(
2290
name = client_name, settings = client)
3114
name = client_name,
3115
settings = client,
3116
server_settings = server_settings)
2291
3117
2292
3118
if not tcp_server.clients:
2293
3119
logger.warning("No clients defined")
2294
2295
if not debug:
2296
try:
2297
with pidfile:
2298
pid = os.getpid()
2299
pidfile.write(str(pid) + "\n".encode("utf-8"))
2300
del pidfile
2301
except IOError:
2302
logger.error("Could not write to file %r with PID %d",
2303
pidfilename, pid)
2304
except NameError:
2305
# "pidfile" was never created
2306
pass
3120
3121
if not foreground:
3122
if pidfile is not None:
3123
pid = os.getpid()
3124
try:
3125
with pidfile:
3126
print(pid, file=pidfile)
3127
except IOError:
3128
logger.error("Could not write to file %r with PID %d",
3129
pidfilename, pid)
3130
del pidfile
2307
3131
del pidfilename
2308
signal.signal(signal.SIGINT, signal.SIG_IGN)
2309
3132
2310
3133
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2311
3134
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2312
3135
2313
3136
if use_dbus:
2314
class MandosDBusService(dbus.service.Object):
3137
3138
@alternate_dbus_interfaces(
3139
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3140
class MandosDBusService(DBusObjectWithObjectManager):
2315
3141
"""A D-Bus proxy object"""
3142
2316
3143
def __init__(self):
2317
3144
dbus.service.Object.__init__(self, bus, "/")
3145
2318
3146
_interface = "se.recompile.Mandos"
2319
3147
2320
3148
@dbus.service.signal(_interface, signature="o")
2327
3155
"D-Bus signal"
2328
3156
pass
2329
3157
3158
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3159
"true"})
2330
3160
@dbus.service.signal(_interface, signature="os")
2331
3161
def ClientRemoved(self, objpath, name):
2332
3162
"D-Bus signal"
2333
3163
pass
2334
3164
3165
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3166
"true"})
2335
3167
@dbus.service.method(_interface, out_signature="ao")
2336
3168
def GetAllClients(self):
2337
3169
"D-Bus method"
2338
return dbus.Array(c.dbus_object_path
2339
for c in
3170
return dbus.Array(c.dbus_object_path for c in
2340
3171
tcp_server.clients.itervalues())
2341
3172
3173
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3174
"true"})
2342
3175
@dbus.service.method(_interface,
2343
3176
out_signature="a{oa{sv}}")
2344
3177
def GetAllClientsWithProperties(self):
2345
3178
"D-Bus method"
2346
3179
return dbus.Dictionary(
2347
((c.dbus_object_path, c.GetAll(""))
2348
for c in tcp_server.clients.itervalues()),
3180
{ c.dbus_object_path: c.GetAll(
3181
"se.recompile.Mandos.Client")
3182
for c in tcp_server.clients.itervalues() },
2349
3183
signature="oa{sv}")
2350
3184
2351
3185
@dbus.service.method(_interface, in_signature="o")
2355
3189
if c.dbus_object_path == object_path:
2356
3190
del tcp_server.clients[c.name]
2357
3191
c.remove_from_connection()
2358
# Don't signal anything except ClientRemoved
3192
# Don't signal the disabling
2359
3193
c.disable(quiet=True)
2360
# Emit D-Bus signal
2361
self.ClientRemoved(object_path, c.name)
3194
# Emit D-Bus signal for removal
3195
self.client_removed_signal(c)
2362
3196
return
2363
3197
raise KeyError(object_path)
2364
3198
2365
3199
del _interface
3200
3201
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3202
out_signature = "a{oa{sa{sv}}}")
3203
def GetManagedObjects(self):
3204
"""D-Bus method"""
3205
return dbus.Dictionary(
3206
{ client.dbus_object_path:
3207
dbus.Dictionary(
3208
{ interface: client.GetAll(interface)
3209
for interface in
3210
client._get_all_interface_names()})
3211
for client in tcp_server.clients.values()})
3212
3213
def client_added_signal(self, client):
3214
"""Send the new standard signal and the old signal"""
3215
if use_dbus:
3216
# New standard signal
3217
self.InterfacesAdded(
3218
client.dbus_object_path,
3219
dbus.Dictionary(
3220
{ interface: client.GetAll(interface)
3221
for interface in
3222
client._get_all_interface_names()}))
3223
# Old signal
3224
self.ClientAdded(client.dbus_object_path)
3225
3226
def client_removed_signal(self, client):
3227
"""Send the new standard signal and the old signal"""
3228
if use_dbus:
3229
# New standard signal
3230
self.InterfacesRemoved(
3231
client.dbus_object_path,
3232
client._get_all_interface_names())
3233
# Old signal
3234
self.ClientRemoved(client.dbus_object_path,
3235
client.name)
2366
3236
2367
class MandosDBusServiceTransitional(MandosDBusService):
2368
__metaclass__ = AlternateDBusNamesMetaclass
2369
mandos_dbus_service = MandosDBusServiceTransitional()
3237
mandos_dbus_service = MandosDBusService()
2370
3238
2371
3239
def cleanup():
2372
3240
"Cleanup function; run on exit"
2373
service.cleanup()
3241
if zeroconf:
3242
service.cleanup()
2374
3243
2375
3244
multiprocessing.active_children()
3245
wnull.close()
2376
3246
if not (tcp_server.clients or client_settings):
2377
3247
return
2378
3248
2389
3259
2390
3260
# A list of attributes that can not be pickled
2391
3261
# + secret.
2392
exclude = set(("bus", "changedstate", "secret",
2393
"checker"))
2394
for name, typ in (inspect.getmembers
2395
(dbus.service.Object)):
3262
exclude = { "bus", "changedstate", "secret",
3263
"checker", "server_settings" }
3264
for name, typ in inspect.getmembers(dbus.service
3265
.Object):
2396
3266
exclude.add(name)
2397
3267
2398
3268
client_dict["encrypted_secret"] = (client
2405
3275
del client_settings[client.name]["secret"]
2406
3276
2407
3277
try:
2408
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2409
prefix="clients-",
2410
dir=os.path.dirname
2411
(stored_state_path))
2412
with os.fdopen(tempfd, "wb") as stored_state:
3278
with tempfile.NamedTemporaryFile(
3279
mode='wb',
3280
suffix=".pickle",
3281
prefix='clients-',
3282
dir=os.path.dirname(stored_state_path),
3283
delete=False) as stored_state:
2413
3284
pickle.dump((clients, client_settings), stored_state)
3285
tempname = stored_state.name
2414
3286
os.rename(tempname, stored_state_path)
2415
3287
except (IOError, OSError) as e:
2416
logger.warning("Could not save persistent state: {0}"
2417
.format(e))
2418
if e.errno not in set((errno.ENOENT, errno.EACCES,
2419
errno.EEXIST)):
3288
if not debug:
3289
try:
3290
os.remove(tempname)
3291
except NameError:
3292
pass
3293
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3294
logger.warning("Could not save persistent state: {}"
3295
.format(os.strerror(e.errno)))
3296
else:
3297
logger.warning("Could not save persistent state:",
3298
exc_info=e)
2420
3299
raise
2421
3300
2422
3301
# Delete all clients, and settings from config
2424
3303
name, client = tcp_server.clients.popitem()
2425
3304
if use_dbus:
2426
3305
client.remove_from_connection()
2427
# Don't signal anything except ClientRemoved
3306
# Don't signal the disabling
2428
3307
client.disable(quiet=True)
3308
# Emit D-Bus signal for removal
2429
3309
if use_dbus:
2430
# Emit D-Bus signal
2431
mandos_dbus_service.ClientRemoved(client
2432
.dbus_object_path,
2433
client.name)
3310
mandos_dbus_service.client_removed_signal(client)
2434
3311
client_settings.clear()
2435
3312
2436
3313
atexit.register(cleanup)
2437
3314
2438
3315
for client in tcp_server.clients.itervalues():
2439
3316
if use_dbus:
2440
# Emit D-Bus signal
2441
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3317
# Emit D-Bus signal for adding
3318
mandos_dbus_service.client_added_signal(client)
2442
3319
# Need to initiate checking of clients
2443
3320
if client.enabled:
2444
3321
client.init_checker()
2447
3324
tcp_server.server_activate()
2448
3325
2449
3326
# Find out what port we got
2450
service.port = tcp_server.socket.getsockname()[1]
3327
if zeroconf:
3328
service.port = tcp_server.socket.getsockname()[1]
2451
3329
if use_ipv6:
2452
3330
logger.info("Now listening on address %r, port %d,"
2453
" flowinfo %d, scope_id %d"
2454
% tcp_server.socket.getsockname())
3331
" flowinfo %d, scope_id %d",
3332
*tcp_server.socket.getsockname())
2455
3333
else: # IPv4
2456
logger.info("Now listening on address %r, port %d"
2457
% tcp_server.socket.getsockname())
3334
logger.info("Now listening on address %r, port %d",
3335
*tcp_server.socket.getsockname())
2458
3336
2459
3337
#service.interface = tcp_server.socket.getsockname()[3]
2460
3338
2461
3339
try:
2462
# From the Avahi example code
2463
try:
2464
service.activate()
2465
except dbus.exceptions.DBusException as error:
2466
logger.critical("DBusException: %s", error)
2467
cleanup()
2468
sys.exit(1)
2469
# End of Avahi example code
3340
if zeroconf:
3341
# From the Avahi example code
3342
try:
3343
service.activate()
3344
except dbus.exceptions.DBusException as error:
3345
logger.critical("D-Bus Exception", exc_info=error)
3346
cleanup()
3347
sys.exit(1)
3348
# End of Avahi example code
2470
3349
2471
3350
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2472
3351
lambda *args, **kwargs:
2476
3355
logger.debug("Starting main loop")
2477
3356
main_loop.run()
2478
3357
except AvahiError as error:
2479
logger.critical("AvahiError: %s", error)
3358
logger.critical("Avahi Error", exc_info=error)
2480
3359
cleanup()
2481
3360
sys.exit(1)
2482
3361
except KeyboardInterrupt:
2487
3366
# Must run before the D-Bus bus name gets deregistered
2488
3367
cleanup()
2489
3368
3369
2490
3370
if __name__ == '__main__':
2491
3371
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0