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