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