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