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