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