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