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