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