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