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