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