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