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