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