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