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