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