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