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