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