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