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