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