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