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