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