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