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