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