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