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