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