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