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