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