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