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