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