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