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