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