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