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