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