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