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