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