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 237.4.25
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.25
- Committer: Teddy Hogeborn
- Date: 2012-01-08 10:12:18 UTC
- mfrom: (553 trunk)
- mto: (237.4.29 release)
- mto: This revision was merged to the branch mainline in revision 554.
- Revision ID: teddy@recompile.se-20120108101218-h6yp0akairb23436
merge from trunk
- 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.1"
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
903
415
last_checked_ok: 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
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
418
checker, or None.
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"])
986
501
client["checker_command"] = section["checker"]
987
502
client["last_approval_request"] = None
988
503
client["last_checked_ok"] = None
989
client["last_checker_status"] = -2
990
504
client["last_checker_status"] = None
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
1119
def checked_ok(self):
1120
"""Assert that the client has been seen, alive and well."""
1121
self.last_checked_ok = datetime.datetime.utcnow()
1122
self.last_checker_status = 0
1123
self.last_checker_signal = None
1124
self.bump_timeout()
1125
1126
def bump_timeout(self, timeout=None):
1127
"""Bump up the timeout for this client."""
626
logger.warning("Checker for %(name)s crashed?",
627
vars(self))
628
629
def checked_ok(self, timeout=None):
630
"""Bump up the timeout for this client.
631
632
This should only be called when the client has been seen,
633
alive and well.
634
"""
1128
635
if timeout is None:
1129
636
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
1130
638
if self.disable_initiator_tag is not None:
1131
GLib.source_remove(self.disable_initiator_tag)
1132
self.disable_initiator_tag = None
639
gobject.source_remove(self.disable_initiator_tag)
1133
640
if getattr(self, "enabled", False):
1134
self.disable_initiator_tag = GLib.timeout_add(
1135
int(timeout.total_seconds() * 1000), self.disable)
641
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
1136
644
self.expires = datetime.datetime.utcnow() + timeout
1137
645
1138
646
def need_approval(self):
1139
647
self.last_approval_request = datetime.datetime.utcnow()
1140
648
1141
649
def start_checker(self):
1142
650
"""Start a new checker subprocess if one is not running.
1143
651
1144
652
If a checker already exists, leave it running and do
1145
653
nothing."""
1146
654
# 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
655
# did that, then if a checker (for some reason) started
656
# running slowly and taking more than 'interval' time, the
657
# client would inevitably timeout, since no checker would get
658
# a chance to run to completion. If we instead leave running
1151
659
# checkers alone, the checker would have to take more time
1152
660
# than 'timeout' for the client to be disabled, which is as it
1153
661
# 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
662
663
# If a checker exists, make sure it is not a zombie
664
try:
665
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
666
except (AttributeError, OSError) as error:
667
if (isinstance(error, OSError)
668
and error.errno != errno.ECHILD):
669
raise error
670
else:
671
if pid:
672
logger.warning("Checker was a zombie")
673
gobject.source_remove(self.checker_callback_tag)
674
self.checker_callback(pid, status,
675
self.current_checker_command)
1159
676
# Start a new checker if needed
1160
677
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
678
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
679
# In case checker_command has exactly one % operator
680
command = self.checker_command % self.host
681
except TypeError:
682
# Escape attributes for the shell
683
escaped_attrs = dict(
684
(attr,
685
re.escape(unicode(str(getattr(self, attr, "")),
686
errors=
687
'replace')))
688
for attr in
689
self.runtime_expansions)
690
691
try:
692
command = self.checker_command % escaped_attrs
693
except TypeError as error:
694
logger.error('Could not format string "%s":'
695
' %s', self.checker_command, error)
696
return True # Try again later
1171
697
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
698
try:
699
logger.info("Starting checker %r for %s",
700
command, self.name)
701
# We don't need to redirect stdout and stderr, since
702
# in normal mode, that is already done by daemon(),
703
# and in debug mode we don't want to. (Stdin is
704
# always replaced by /dev/null.)
705
self.checker = subprocess.Popen(command,
706
close_fds=True,
707
shell=True, cwd="/")
708
self.checker_callback_tag = (gobject.child_watch_add
709
(self.checker.pid,
710
self.checker_callback,
711
data=command))
712
# The checker may have completed before the gobject
713
# watch was added. Check for this.
714
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
715
if pid:
716
gobject.source_remove(self.checker_callback_tag)
717
self.checker_callback(pid, status, command)
718
except OSError as error:
719
logger.error("Failed to start subprocess: %s",
720
error)
721
# Re-run this periodically if run by gobject.timeout_add
1198
722
return True
1199
723
1200
724
def stop_checker(self):
1201
725
"""Force the checker process, if any, to stop."""
1202
726
if self.checker_callback_tag:
1203
GLib.source_remove(self.checker_callback_tag)
727
gobject.source_remove(self.checker_callback_tag)
1204
728
self.checker_callback_tag = None
1205
729
if getattr(self, "checker", None) is None:
1206
730
return
1207
log.debug("Stopping checker for %(name)s", vars(self))
1208
self.checker.terminate()
731
logger.debug("Stopping checker for %(name)s", vars(self))
732
try:
733
os.kill(self.checker.pid, signal.SIGTERM)
734
#time.sleep(0.5)
735
#if self.checker.poll() is None:
736
# os.kill(self.checker.pid, signal.SIGKILL)
737
except OSError as error:
738
if error.errno != errno.ESRCH: # No such process
739
raise
1209
740
self.checker = None
1210
741
1211
742
1212
def dbus_service_property(dbus_interface,
1213
signature="v",
1214
access="readwrite",
1215
byte_arrays=False):
743
def dbus_service_property(dbus_interface, signature="v",
744
access="readwrite", byte_arrays=False):
1216
745
"""Decorators for marking methods of a DBusObjectWithProperties to
1217
746
become properties on the D-Bus.
1218
747
1219
748
The decorated method will be called with no arguments by "Get"
1220
749
and with one argument by "Set".
1221
750
1222
751
The parameters, where they are supported, are the same as
1223
752
dbus.service.method, except there is only "signature", since the
1224
753
type from Get() and the type sent to Set() is the same.
1227
756
# "Set" method, so we fail early here:
1228
757
if byte_arrays and signature != "ay":
1229
758
raise ValueError("Byte arrays not supported for non-'ay'"
1230
" signature {!r}".format(signature))
1231
759
" signature %r" % signature)
1232
760
def decorator(func):
1233
761
func._dbus_is_property = True
1234
762
func._dbus_interface = dbus_interface
1237
765
func._dbus_name = func.__name__
1238
766
if func._dbus_name.endswith("_dbus_property"):
1239
767
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
768
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
769
return func
1286
770
return decorator
1287
771
1288
772
1289
773
class DBusPropertyException(dbus.exceptions.DBusException):
1290
774
"""A base class for D-Bus property-related exceptions
1291
775
"""
1292
pass
776
def __unicode__(self):
777
return unicode(str(self))
1293
778
1294
779
1295
780
class DBusPropertyAccessException(DBusPropertyException):
1304
789
pass
1305
790
1306
791
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):
792
class DBusObjectWithProperties(dbus.service.Object):
1397
793
"""A D-Bus object with properties.
1398
794
1399
795
Classes inheriting from this can use the dbus_service_property
1400
796
decorator to expose methods as D-Bus properties. It exposes the
1401
797
standard Get(), Set(), and GetAll() methods on the D-Bus.
1402
798
"""
1403
799
800
@staticmethod
801
def _is_dbus_property(obj):
802
return getattr(obj, "_dbus_is_property", False)
803
804
def _get_all_dbus_properties(self):
805
"""Returns a generator of (name, attribute) pairs
806
"""
807
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
808
for cls in self.__class__.__mro__
809
for name, prop in
810
inspect.getmembers(cls, self._is_dbus_property))
811
1404
812
def _get_dbus_property(self, interface_name, property_name):
1405
813
"""Returns a bound method if one exists which is a D-Bus
1406
814
property with the specified name and interface.
1407
815
"""
1408
for cls in self.__class__.__mro__:
1409
for name, value in inspect.getmembers(
1410
cls, self._is_dbus_thing("property")):
816
for cls in self.__class__.__mro__:
817
for name, value in (inspect.getmembers
818
(cls, self._is_dbus_property)):
1411
819
if (value._dbus_name == property_name
1412
820
and value._dbus_interface == interface_name):
1413
821
return value.__get__(self)
1414
822
1415
823
# 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",
824
raise DBusPropertyNotFound(self.dbus_object_path + ":"
825
+ interface_name + "."
826
+ property_name)
827
828
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1430
829
out_signature="v")
1431
830
def Get(self, interface_name, property_name):
1432
831
"""Standard D-Bus property Get() method, see D-Bus standard.
1438
837
if not hasattr(value, "variant_level"):
1439
838
return value
1440
839
return type(value)(value, variant_level=value.variant_level+1)
1441
840
1442
841
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1443
842
def Set(self, interface_name, property_name, value):
1444
843
"""Standard D-Bus property Set() method, see D-Bus standard.
1450
849
# The byte_arrays option is not supported yet on
1451
850
# signatures other than "ay".
1452
851
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))
852
raise ValueError
853
value = dbus.ByteArray(b''.join(chr(byte)
854
for byte in value))
1457
855
prop(value)
1458
1459
@dbus.service.method(dbus.PROPERTIES_IFACE,
1460
in_signature="s",
856
857
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1461
858
out_signature="a{sv}")
1462
859
def GetAll(self, interface_name):
1463
860
"""Standard D-Bus property GetAll() method, see D-Bus
1464
861
standard.
1465
862
1466
863
Note: Will not include properties with access="write".
1467
864
"""
1468
865
properties = {}
1469
for name, prop in self._get_all_dbus_things("property"):
866
for name, prop in self._get_all_dbus_properties():
1470
867
if (interface_name
1471
868
and interface_name != prop._dbus_interface):
1472
869
# Interface non-empty but did not match
1478
875
if not hasattr(value, "variant_level"):
1479
876
properties[name] = value
1480
877
continue
1481
properties[name] = type(value)(
1482
value, variant_level=value.variant_level + 1)
878
properties[name] = type(value)(value, variant_level=
879
value.variant_level+1)
1483
880
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
881
1493
882
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1494
883
out_signature="s",
1495
path_keyword="object_path",
1496
connection_keyword="connection")
884
path_keyword='object_path',
885
connection_keyword='connection')
1497
886
def Introspect(self, object_path, connection):
1498
"""Overloading of standard D-Bus method.
1499
1500
Inserts property tags and interface annotation tags.
887
"""Standard D-Bus method, overloaded to insert property tags.
1501
888
"""
1502
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1503
object_path,
1504
connection)
889
xmlstring = dbus.service.Object.Introspect(self, object_path,
890
connection)
1505
891
try:
1506
892
document = xml.dom.minidom.parseString(xmlstring)
1507
1508
893
def make_tag(document, name, prop):
1509
894
e = document.createElement("property")
1510
895
e.setAttribute("name", name)
1511
896
e.setAttribute("type", prop._dbus_signature)
1512
897
e.setAttribute("access", prop._dbus_access)
1513
898
return e
1514
1515
899
for if_tag in document.getElementsByTagName("interface"):
1516
# Add property tags
1517
900
for tag in (make_tag(document, name, prop)
1518
901
for name, prop
1519
in self._get_all_dbus_things("property")
902
in self._get_all_dbus_properties()
1520
903
if prop._dbus_interface
1521
904
== if_tag.getAttribute("name")):
1522
905
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
906
# Add the names to the return values for the
1540
907
# "org.freedesktop.DBus.Properties" methods
1541
908
if (if_tag.getAttribute("name")
1555
922
document.unlink()
1556
923
except (AttributeError, xml.dom.DOMException,
1557
924
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):
925
logger.error("Failed to override Introspection method",
926
error)
927
return xmlstring
928
929
930
def datetime_to_dbus (dt, variant_level=0):
1635
931
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1636
932
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).
933
return dbus.String("", variant_level = variant_level)
934
return dbus.String(dt.isoformat(),
935
variant_level=variant_level)
936
937
938
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
939
.__metaclass__):
940
"""Applied to an empty subclass of a D-Bus object, this metaclass
941
will add additional D-Bus attributes matching a certain pattern.
1663
942
"""
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):
943
def __new__(mcs, name, bases, attr):
944
# Go through all the base classes which could have D-Bus
945
# methods, signals, or properties in them
946
for base in (b for b in bases
947
if issubclass(b, dbus.service.Object)):
948
# Go though all attributes of the base class
949
for attrname, attribute in inspect.getmembers(base):
1672
950
# Ignore non-D-Bus attributes, and D-Bus attributes
1673
951
# with the wrong interface name
1674
952
if (not hasattr(attribute, "_dbus_interface")
1675
or not attribute._dbus_interface.startswith(
1676
orig_interface_name)):
953
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1677
955
continue
1678
956
# Create an alternate D-Bus interface name based on
1679
957
# the current name
1680
alt_interface = attribute._dbus_interface.replace(
1681
orig_interface_name, alt_interface_name)
1682
interface_names.add(alt_interface)
958
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1683
961
# Is this a D-Bus signal?
1684
962
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(
963
# Extract the original non-method function by
964
# black magic
965
nonmethod_func = (dict(
1689
966
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)
967
attribute.__closure__))["func"]
968
.cell_contents)
1697
969
# Create a new, but exactly alike, function
1698
970
# object, and decorate it to be a new D-Bus signal
1699
971
# 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
972
new_function = (dbus.service.signal
973
(alt_interface,
974
attribute._dbus_signature)
975
(types.FunctionType(
976
nonmethod_func.func_code,
977
nonmethod_func.func_globals,
978
nonmethod_func.func_name,
979
nonmethod_func.func_defaults,
980
nonmethod_func.func_closure)))
1711
981
# 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
982
# old and new functions, so both the old and new
983
# signals gets sent when the function is called
1715
984
def fixscope(func1, func2):
1716
985
"""This function is a scope container to pass
1717
986
func1 and func2 to the "call_both" function
1718
987
outside of its arguments"""
1719
1720
@functools.wraps(func2)
1721
988
def call_both(*args, **kwargs):
1722
989
"""This function will emit two D-Bus
1723
990
signals by calling func1 and func2"""
1724
991
func1(*args, **kwargs)
1725
992
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
993
return call_both
1733
994
# Create the "call_both" function and add it to
1734
995
# the class
1735
attr[attrname] = fixscope(attribute, new_function)
996
attr[attrname] = fixscope(attribute,
997
new_function)
1736
998
# Is this a D-Bus method?
1737
999
elif getattr(attribute, "_dbus_is_method", False):
1738
1000
# Create a new, but exactly alike, function
1739
1001
# object. Decorate it to be a new D-Bus method
1740
1002
# with the alternate D-Bus interface name. Add it
1741
1003
# 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
1004
attr[attrname] = (dbus.service.method
1005
(alt_interface,
1006
attribute._dbus_in_signature,
1007
attribute._dbus_out_signature)
1008
(types.FunctionType
1009
(attribute.func_code,
1010
attribute.func_globals,
1011
attribute.func_name,
1012
attribute.func_defaults,
1013
attribute.func_closure)))
1754
1014
# Is this a D-Bus property?
1755
1015
elif getattr(attribute, "_dbus_is_property", False):
1756
1016
# Create a new, but exactly alike, function
1757
1017
# object, and decorate it to be a new D-Bus
1758
1018
# property with the alternate D-Bus interface
1759
1019
# 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"})
1020
attr[attrname] = (dbus_service_property
1021
(alt_interface,
1022
attribute._dbus_signature,
1023
attribute._dbus_access,
1024
attribute
1025
._dbus_get_args_options
1026
["byte_arrays"])
1027
(types.FunctionType
1028
(attribute.func_code,
1029
attribute.func_globals,
1030
attribute.func_name,
1031
attribute.func_defaults,
1032
attribute.func_closure)))
1033
return type.__new__(mcs, name, bases, attr)
1034
1035
1812
1036
class ClientDBus(Client, DBusObjectWithProperties):
1813
1037
"""A Client class using D-Bus
1814
1038
1815
1039
Attributes:
1816
1040
dbus_object_path: dbus.ObjectPath
1817
1041
bus: dbus.SystemBus()
1818
1042
"""
1819
1043
1820
1044
runtime_expansions = (Client.runtime_expansions
1821
+ ("dbus_object_path", ))
1822
1823
_interface = "se.recompile.Mandos.Client"
1824
1045
+ ("dbus_object_path",))
1046
1825
1047
# dbus.service.Object doesn't use super(), so we can't either.
1826
1827
def __init__(self, bus=None, *args, **kwargs):
1048
1049
def __init__(self, bus = None, *args, **kwargs):
1828
1050
self.bus = bus
1829
1051
Client.__init__(self, *args, **kwargs)
1830
1052
# Only now, when this client is initialized, can it show up on
1831
1053
# the D-Bus
1832
client_object_name = str(self.name).translate(
1054
client_object_name = unicode(self.name).translate(
1833
1055
{ord("."): ord("_"),
1834
1056
ord("-"): ord("_")})
1835
self.dbus_object_path = dbus.ObjectPath(
1836
"/clients/" + client_object_name)
1057
self.dbus_object_path = (dbus.ObjectPath
1058
("/clients/" + client_object_name))
1837
1059
DBusObjectWithProperties.__init__(self, self.bus,
1838
1060
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):
1061
1062
def notifychangeproperty(transform_func,
1063
dbus_name, type_func=lambda x: x,
1064
variant_level=1):
1845
1065
""" Modify a variable so that it's a property which announces
1846
1066
its changes to DBus.
1847
1067
1848
1068
transform_fun: Function that takes a value and a variant_level
1849
1069
and transforms it to a D-Bus type.
1850
1070
dbus_name: D-Bus name of the variable
1852
1072
to the D-Bus. Default: no transform
1853
1073
variant_level: D-Bus variant level. Default: 1
1854
1074
"""
1855
attrname = "_{}".format(dbus_name)
1856
1075
attrname = "_{0}".format(dbus_name)
1857
1076
def setter(self, value):
1858
1077
if hasattr(self, "dbus_object_path"):
1859
1078
if (not hasattr(self, attrname) or
1860
1079
type_func(getattr(self, attrname, None))
1861
1080
!= 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())
1081
dbus_value = transform_func(type_func(value),
1082
variant_level
1083
=variant_level)
1084
self.PropertyChanged(dbus.String(dbus_name),
1085
dbus_value)
1877
1086
setattr(self, attrname, value)
1878
1087
1879
1088
return property(lambda self: getattr(self, attrname), setter)
1880
1089
1090
1881
1091
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1882
1092
approvals_pending = notifychangeproperty(dbus.Boolean,
1883
1093
"ApprovalPending",
1884
type_func=bool)
1094
type_func = bool)
1885
1095
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1886
1096
last_enabled = notifychangeproperty(datetime_to_dbus,
1887
1097
"LastEnabled")
1888
checker = notifychangeproperty(
1889
dbus.Boolean, "CheckerRunning",
1890
type_func=lambda checker: checker is not None)
1098
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1099
type_func = lambda checker:
1100
checker is not None)
1891
1101
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1892
1102
"LastCheckedOK")
1893
last_checker_status = notifychangeproperty(dbus.Int16,
1894
"LastCheckerStatus")
1895
1103
last_approval_request = notifychangeproperty(
1896
1104
datetime_to_dbus, "LastApprovalRequest")
1897
1105
approved_by_default = notifychangeproperty(dbus.Boolean,
1898
1106
"ApprovedByDefault")
1899
approval_delay = notifychangeproperty(
1900
dbus.UInt64, "ApprovalDelay",
1901
type_func=lambda td: td.total_seconds() * 1000)
1107
approval_delay = notifychangeproperty(dbus.UInt64,
1108
"ApprovalDelay",
1109
type_func =
1110
timedelta_to_milliseconds)
1902
1111
approval_duration = notifychangeproperty(
1903
1112
dbus.UInt64, "ApprovalDuration",
1904
type_func=lambda td: td.total_seconds() * 1000)
1113
type_func = timedelta_to_milliseconds)
1905
1114
host = notifychangeproperty(dbus.String, "Host")
1906
timeout = notifychangeproperty(
1907
dbus.UInt64, "Timeout",
1908
type_func=lambda td: td.total_seconds() * 1000)
1115
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1116
type_func =
1117
timedelta_to_milliseconds)
1909
1118
extended_timeout = notifychangeproperty(
1910
1119
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)
1120
type_func = timedelta_to_milliseconds)
1121
interval = notifychangeproperty(dbus.UInt64,
1122
"Interval",
1123
type_func =
1124
timedelta_to_milliseconds)
1915
1125
checker_command = notifychangeproperty(dbus.String, "Checker")
1916
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1917
invalidate_only=True)
1918
1126
1919
1127
del notifychangeproperty
1920
1128
1921
1129
def __del__(self, *args, **kwargs):
1922
1130
try:
1923
1131
self.remove_from_connection()
1926
1134
if hasattr(DBusObjectWithProperties, "__del__"):
1927
1135
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1928
1136
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:
1137
1138
def checker_callback(self, pid, condition, command,
1139
*args, **kwargs):
1140
self.checker_callback_tag = None
1141
self.checker = None
1142
if os.WIFEXITED(condition):
1143
exitstatus = os.WEXITSTATUS(condition)
1937
1144
# Emit D-Bus signal
1938
1145
self.CheckerCompleted(dbus.Int16(exitstatus),
1939
# This is specific to GNU libC
1940
dbus.Int64(exitstatus << 8),
1146
dbus.Int64(condition),
1941
1147
dbus.String(command))
1942
1148
else:
1943
1149
# Emit D-Bus signal
1944
1150
self.CheckerCompleted(dbus.Int16(-1),
1945
dbus.Int64(
1946
# This is specific to GNU libC
1947
(exitstatus << 8)
1948
| self.last_checker_signal),
1151
dbus.Int64(condition),
1949
1152
dbus.String(command))
1950
return ret
1951
1153
1154
return Client.checker_callback(self, pid, condition, command,
1155
*args, **kwargs)
1156
1952
1157
def start_checker(self, *args, **kwargs):
1953
old_checker_pid = getattr(self.checker, "pid", None)
1158
old_checker = self.checker
1159
if self.checker is not None:
1160
old_checker_pid = self.checker.pid
1161
else:
1162
old_checker_pid = None
1954
1163
r = Client.start_checker(self, *args, **kwargs)
1955
1164
# Only if new checker process was started
1956
1165
if (self.checker is not None
1958
1167
# Emit D-Bus signal
1959
1168
self.CheckerStarted(self.current_checker_command)
1960
1169
return r
1961
1170
1962
1171
def _reset_approved(self):
1963
1172
self.approved = None
1964
1173
return False
1965
1174
1966
1175
def approve(self, value=True):
1176
self.send_changedstate()
1967
1177
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
1178
gobject.timeout_add(timedelta_to_milliseconds
1179
(self.approval_duration),
1180
self._reset_approved)
1181
1182
1183
## D-Bus methods, signals & properties
1184
_interface = "se.recompile.Mandos.Client"
1185
1186
## Signals
1187
1978
1188
# CheckerCompleted - signal
1979
1189
@dbus.service.signal(_interface, signature="nxs")
1980
1190
def CheckerCompleted(self, exitcode, waitstatus, command):
1981
1191
"D-Bus signal"
1982
1192
pass
1983
1193
1984
1194
# CheckerStarted - signal
1985
1195
@dbus.service.signal(_interface, signature="s")
1986
1196
def CheckerStarted(self, command):
1987
1197
"D-Bus signal"
1988
1198
pass
1989
1199
1990
1200
# PropertyChanged - signal
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1992
1201
@dbus.service.signal(_interface, signature="sv")
1993
1202
def PropertyChanged(self, property, value):
1994
1203
"D-Bus signal"
1995
1204
pass
1996
1205
1997
1206
# GotSecret - signal
1998
1207
@dbus.service.signal(_interface)
1999
1208
def GotSecret(self):
2002
1211
server to mandos-client
2003
1212
"""
2004
1213
pass
2005
1214
2006
1215
# Rejected - signal
2007
1216
@dbus.service.signal(_interface, signature="s")
2008
1217
def Rejected(self, reason):
2009
1218
"D-Bus signal"
2010
1219
pass
2011
1220
2012
1221
# NeedApproval - signal
2013
1222
@dbus.service.signal(_interface, signature="tb")
2014
1223
def NeedApproval(self, timeout, default):
2015
1224
"D-Bus signal"
2016
1225
return self.need_approval()
2017
2018
# Methods
2019
1226
1227
## Methods
1228
2020
1229
# Approve - method
2021
1230
@dbus.service.method(_interface, in_signature="b")
2022
1231
def Approve(self, value):
2023
1232
self.approve(value)
2024
1233
2025
1234
# CheckedOK - method
2026
1235
@dbus.service.method(_interface)
2027
1236
def CheckedOK(self):
2028
1237
self.checked_ok()
2029
1238
2030
1239
# Enable - method
2031
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2032
1240
@dbus.service.method(_interface)
2033
1241
def Enable(self):
2034
1242
"D-Bus method"
2035
1243
self.enable()
2036
1244
2037
1245
# StartChecker - method
2038
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2039
1246
@dbus.service.method(_interface)
2040
1247
def StartChecker(self):
2041
1248
"D-Bus method"
2042
1249
self.start_checker()
2043
1250
2044
1251
# Disable - method
2045
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2046
1252
@dbus.service.method(_interface)
2047
1253
def Disable(self):
2048
1254
"D-Bus method"
2049
1255
self.disable()
2050
1256
2051
1257
# StopChecker - method
2052
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2053
1258
@dbus.service.method(_interface)
2054
1259
def StopChecker(self):
2055
1260
self.stop_checker()
2056
2057
# Properties
2058
1261
1262
## Properties
1263
2059
1264
# ApprovalPending - property
2060
1265
@dbus_service_property(_interface, signature="b", access="read")
2061
1266
def ApprovalPending_dbus_property(self):
2062
1267
return dbus.Boolean(bool(self.approvals_pending))
2063
1268
2064
1269
# ApprovedByDefault - property
2065
@dbus_service_property(_interface,
2066
signature="b",
1270
@dbus_service_property(_interface, signature="b",
2067
1271
access="readwrite")
2068
1272
def ApprovedByDefault_dbus_property(self, value=None):
2069
1273
if value is None: # get
2070
1274
return dbus.Boolean(self.approved_by_default)
2071
1275
self.approved_by_default = bool(value)
2072
1276
2073
1277
# ApprovalDelay - property
2074
@dbus_service_property(_interface,
2075
signature="t",
1278
@dbus_service_property(_interface, signature="t",
2076
1279
access="readwrite")
2077
1280
def ApprovalDelay_dbus_property(self, value=None):
2078
1281
if value is None: # get
2079
return dbus.UInt64(self.approval_delay.total_seconds()
2080
* 1000)
1282
return dbus.UInt64(self.approval_delay_milliseconds())
2081
1283
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2082
1284
2083
1285
# ApprovalDuration - property
2084
@dbus_service_property(_interface,
2085
signature="t",
1286
@dbus_service_property(_interface, signature="t",
2086
1287
access="readwrite")
2087
1288
def ApprovalDuration_dbus_property(self, value=None):
2088
1289
if value is None: # get
2089
return dbus.UInt64(self.approval_duration.total_seconds()
2090
* 1000)
1290
return dbus.UInt64(timedelta_to_milliseconds(
1291
self.approval_duration))
2091
1292
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2092
1293
2093
1294
# Name - property
2094
@dbus_annotations(
2095
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2096
1295
@dbus_service_property(_interface, signature="s", access="read")
2097
1296
def Name_dbus_property(self):
2098
1297
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
1298
2107
1299
# Fingerprint - property
2108
@dbus_annotations(
2109
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2110
1300
@dbus_service_property(_interface, signature="s", access="read")
2111
1301
def Fingerprint_dbus_property(self):
2112
1302
return dbus.String(self.fingerprint)
2113
1303
2114
1304
# Host - property
2115
@dbus_service_property(_interface,
2116
signature="s",
1305
@dbus_service_property(_interface, signature="s",
2117
1306
access="readwrite")
2118
1307
def Host_dbus_property(self, value=None):
2119
1308
if value is None: # get
2120
1309
return dbus.String(self.host)
2121
self.host = str(value)
2122
1310
self.host = unicode(value)
1311
2123
1312
# Created - property
2124
@dbus_annotations(
2125
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2126
1313
@dbus_service_property(_interface, signature="s", access="read")
2127
1314
def Created_dbus_property(self):
2128
1315
return datetime_to_dbus(self.created)
2129
1316
2130
1317
# LastEnabled - property
2131
1318
@dbus_service_property(_interface, signature="s", access="read")
2132
1319
def LastEnabled_dbus_property(self):
2133
1320
return datetime_to_dbus(self.last_enabled)
2134
1321
2135
1322
# Enabled - property
2136
@dbus_service_property(_interface,
2137
signature="b",
1323
@dbus_service_property(_interface, signature="b",
2138
1324
access="readwrite")
2139
1325
def Enabled_dbus_property(self, value=None):
2140
1326
if value is None: # get
2143
1329
self.enable()
2144
1330
else:
2145
1331
self.disable()
2146
1332
2147
1333
# LastCheckedOK - property
2148
@dbus_service_property(_interface,
2149
signature="s",
1334
@dbus_service_property(_interface, signature="s",
2150
1335
access="readwrite")
2151
1336
def LastCheckedOK_dbus_property(self, value=None):
2152
1337
if value is not None:
2153
1338
self.checked_ok()
2154
1339
return
2155
1340
return datetime_to_dbus(self.last_checked_ok)
2156
2157
# LastCheckerStatus - property
2158
@dbus_service_property(_interface, signature="n", access="read")
2159
def LastCheckerStatus_dbus_property(self):
2160
return dbus.Int16(self.last_checker_status)
2161
1341
2162
1342
# Expires - property
2163
1343
@dbus_service_property(_interface, signature="s", access="read")
2164
1344
def Expires_dbus_property(self):
2165
1345
return datetime_to_dbus(self.expires)
2166
1346
2167
1347
# LastApprovalRequest - property
2168
1348
@dbus_service_property(_interface, signature="s", access="read")
2169
1349
def LastApprovalRequest_dbus_property(self):
2170
1350
return datetime_to_dbus(self.last_approval_request)
2171
1351
2172
1352
# Timeout - property
2173
@dbus_service_property(_interface,
2174
signature="t",
1353
@dbus_service_property(_interface, signature="t",
2175
1354
access="readwrite")
2176
1355
def Timeout_dbus_property(self, value=None):
2177
1356
if value is None: # get
2178
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2179
old_timeout = self.timeout
1357
return dbus.UInt64(self.timeout_milliseconds())
2180
1358
self.timeout = datetime.timedelta(0, 0, 0, value)
2181
# Reschedule disabling
1359
# Reschedule timeout
2182
1360
if self.enabled:
2183
1361
now = datetime.datetime.utcnow()
2184
self.expires += self.timeout - old_timeout
2185
if self.expires <= now:
1362
time_to_die = timedelta_to_milliseconds(
1363
(self.last_checked_ok + self.timeout) - now)
1364
if time_to_die <= 0:
2186
1365
# The timeout has passed
2187
1366
self.disable()
2188
1367
else:
1368
self.expires = (now +
1369
datetime.timedelta(milliseconds =
1370
time_to_die))
2189
1371
if (getattr(self, "disable_initiator_tag", None)
2190
1372
is None):
2191
1373
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
1374
gobject.source_remove(self.disable_initiator_tag)
1375
self.disable_initiator_tag = (gobject.timeout_add
1376
(time_to_die,
1377
self.disable))
1378
2197
1379
# ExtendedTimeout - property
2198
@dbus_service_property(_interface,
2199
signature="t",
1380
@dbus_service_property(_interface, signature="t",
2200
1381
access="readwrite")
2201
1382
def ExtendedTimeout_dbus_property(self, value=None):
2202
1383
if value is None: # get
2203
return dbus.UInt64(self.extended_timeout.total_seconds()
2204
* 1000)
1384
return dbus.UInt64(self.extended_timeout_milliseconds())
2205
1385
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2206
1386
2207
1387
# Interval - property
2208
@dbus_service_property(_interface,
2209
signature="t",
1388
@dbus_service_property(_interface, signature="t",
2210
1389
access="readwrite")
2211
1390
def Interval_dbus_property(self, value=None):
2212
1391
if value is None: # get
2213
return dbus.UInt64(self.interval.total_seconds() * 1000)
1392
return dbus.UInt64(self.interval_milliseconds())
2214
1393
self.interval = datetime.timedelta(0, 0, 0, value)
2215
1394
if getattr(self, "checker_initiator_tag", None) is None:
2216
1395
return
2217
1396
if self.enabled:
2218
1397
# 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
1398
gobject.source_remove(self.checker_initiator_tag)
1399
self.checker_initiator_tag = (gobject.timeout_add
1400
(value, self.start_checker))
1401
self.start_checker() # Start one now, too
1402
2224
1403
# Checker - property
2225
@dbus_service_property(_interface,
2226
signature="s",
1404
@dbus_service_property(_interface, signature="s",
2227
1405
access="readwrite")
2228
1406
def Checker_dbus_property(self, value=None):
2229
1407
if value is None: # get
2230
1408
return dbus.String(self.checker_command)
2231
self.checker_command = str(value)
2232
1409
self.checker_command = unicode(value)
1410
2233
1411
# CheckerRunning - property
2234
@dbus_service_property(_interface,
2235
signature="b",
1412
@dbus_service_property(_interface, signature="b",
2236
1413
access="readwrite")
2237
1414
def CheckerRunning_dbus_property(self, value=None):
2238
1415
if value is None: # get
2241
1418
self.start_checker()
2242
1419
else:
2243
1420
self.stop_checker()
2244
1421
2245
1422
# ObjectPath - property
2246
@dbus_annotations(
2247
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2248
"org.freedesktop.DBus.Deprecated": "true"})
2249
1423
@dbus_service_property(_interface, signature="o", access="read")
2250
1424
def ObjectPath_dbus_property(self):
2251
return self.dbus_object_path # is already a dbus.ObjectPath
2252
1425
return self.dbus_object_path # is already a dbus.ObjectPath
1426
2253
1427
# 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)
1428
@dbus_service_property(_interface, signature="ay",
1429
access="write", byte_arrays=True)
2261
1430
def Secret_dbus_property(self, value):
2262
self.secret = bytes(value)
2263
1431
self.secret = str(value)
1432
2264
1433
del _interface
2265
1434
2266
1435
2267
class ProxyClient:
2268
def __init__(self, child_pipe, key_id, fpr, address):
1436
class ProxyClient(object):
1437
def __init__(self, child_pipe, fpr, address):
2269
1438
self._pipe = child_pipe
2270
self._pipe.send(("init", key_id, fpr, address))
1439
self._pipe.send(('init', fpr, address))
2271
1440
if not self._pipe.recv():
2272
raise KeyError(key_id or fpr)
2273
1441
raise KeyError()
1442
2274
1443
def __getattribute__(self, name):
2275
if name == "_pipe":
1444
if name == '_pipe':
2276
1445
return super(ProxyClient, self).__getattribute__(name)
2277
self._pipe.send(("getattr", name))
1446
self._pipe.send(('getattr', name))
2278
1447
data = self._pipe.recv()
2279
if data[0] == "data":
1448
if data[0] == 'data':
2280
1449
return data[1]
2281
if data[0] == "function":
2282
1450
if data[0] == 'function':
2283
1451
def func(*args, **kwargs):
2284
self._pipe.send(("funcall", name, args, kwargs))
1452
self._pipe.send(('funcall', name, args, kwargs))
2285
1453
return self._pipe.recv()[1]
2286
2287
1454
return func
2288
1455
2289
1456
def __setattr__(self, name, value):
2290
if name == "_pipe":
1457
if name == '_pipe':
2291
1458
return super(ProxyClient, self).__setattr__(name, value)
2292
self._pipe.send(("setattr", name, value))
1459
self._pipe.send(('setattr', name, value))
1460
1461
1462
class ClientDBusTransitional(ClientDBus):
1463
__metaclass__ = AlternateDBusNamesMetaclass
2293
1464
2294
1465
2295
1466
class ClientHandler(socketserver.BaseRequestHandler, object):
2296
1467
"""A class to handle client connections.
2297
1468
2298
1469
Instantiated once for each connection to handle it.
2299
1470
Note: This will run in its own forked process."""
2300
1471
2301
1472
def handle(self):
2302
1473
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"))
1474
logger.info("TCP connection from: %s",
1475
unicode(self.client_address))
1476
logger.debug("Pipe FD: %d",
1477
self.server.child_pipe.fileno())
1478
1479
session = (gnutls.connection
1480
.ClientSession(self.request,
1481
gnutls.connection
1482
.X509Credentials()))
1483
1484
# Note: gnutls.connection.X509Credentials is really a
1485
# generic GnuTLS certificate credentials object so long as
1486
# no X.509 keys are added to it. Therefore, we can use it
1487
# here despite using OpenPGP certificates.
1488
1489
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1490
# "+AES-256-CBC", "+SHA1",
1491
# "+COMP-NULL", "+CTYPE-OPENPGP",
1492
# "+DHE-DSS"))
2313
1493
# Use a fallback default, since this MUST be set.
2314
1494
priority = self.server.gnutls_priority
2315
1495
if priority is None:
2316
1496
priority = "NORMAL"
2317
gnutls.priority_set_direct(session,
2318
priority.encode("utf-8"), None)
2319
1497
(gnutls.library.functions
1498
.gnutls_priority_set_direct(session._c_object,
1499
priority, None))
1500
2320
1501
# Start communication using the Mandos protocol
2321
1502
# Get protocol number
2322
1503
line = self.request.makefile().readline()
2323
log.debug("Protocol version: %r", line)
1504
logger.debug("Protocol version: %r", line)
2324
1505
try:
2325
1506
if int(line.strip().split()[0]) > 1:
2326
raise RuntimeError(line)
1507
raise RuntimeError
2327
1508
except (ValueError, IndexError, RuntimeError) as error:
2328
log.error("Unknown protocol version: %s", error)
1509
logger.error("Unknown protocol version: %s", error)
2329
1510
return
2330
1511
2331
1512
# Start GnuTLS connection
2332
1513
try:
2333
1514
session.handshake()
2334
except gnutls.Error as error:
2335
log.warning("Handshake failed: %s", error)
1515
except gnutls.errors.GNUTLSError as error:
1516
logger.warning("Handshake failed: %s", error)
2336
1517
# Do not run session.bye() here: the session is not
2337
1518
# established. Just abandon the request.
2338
1519
return
2339
log.debug("Handshake succeeded")
2340
1520
logger.debug("Handshake succeeded")
1521
2341
1522
approval_required = False
2342
1523
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,
1524
try:
1525
fpr = self.fingerprint(self.peer_certificate
1526
(session))
1527
except (TypeError,
1528
gnutls.errors.GNUTLSError) as error:
1529
logger.warning("Bad certificate: %s", error)
1530
return
1531
logger.debug("Fingerprint: %s", fpr)
1532
1533
try:
1534
client = ProxyClient(child_pipe, fpr,
2367
1535
self.client_address)
2368
1536
except KeyError:
2369
1537
return
2370
1538
2371
1539
if client.approval_delay:
2372
1540
delay = client.approval_delay
2373
1541
client.approvals_pending += 1
2374
1542
approval_required = True
2375
1543
2376
1544
while True:
2377
1545
if not client.enabled:
2378
log.info("Client %s is disabled", client.name)
1546
logger.info("Client %s is disabled",
1547
client.name)
2379
1548
if self.server.use_dbus:
2380
1549
# Emit D-Bus signal
2381
1550
client.Rejected("Disabled")
2382
1551
return
2383
1552
2384
1553
if client.approved or not client.approval_delay:
2385
# We are approved or approval is disabled
1554
#We are approved or approval is disabled
2386
1555
break
2387
1556
elif client.approved is None:
2388
log.info("Client %s needs approval",
2389
client.name)
1557
logger.info("Client %s needs approval",
1558
client.name)
2390
1559
if self.server.use_dbus:
2391
1560
# Emit D-Bus signal
2392
1561
client.NeedApproval(
2393
client.approval_delay.total_seconds()
2394
* 1000, client.approved_by_default)
1562
client.approval_delay_milliseconds(),
1563
client.approved_by_default)
2395
1564
else:
2396
log.warning("Client %s was not approved",
2397
client.name)
1565
logger.warning("Client %s was not approved",
1566
client.name)
2398
1567
if self.server.use_dbus:
2399
1568
# Emit D-Bus signal
2400
1569
client.Rejected("Denied")
2401
1570
return
2402
2403
# wait until timeout or approved
1571
1572
#wait until timeout or approved
2404
1573
time = datetime.datetime.now()
2405
1574
client.changedstate.acquire()
2406
client.changedstate.wait(delay.total_seconds())
1575
(client.changedstate.wait
1576
(float(client.timedelta_to_milliseconds(delay)
1577
/ 1000)))
2407
1578
client.changedstate.release()
2408
1579
time2 = datetime.datetime.now()
2409
1580
if (time2 - time) >= delay:
2410
1581
if not client.approved_by_default:
2411
log.warning("Client %s timed out while"
2412
" waiting for approval",
2413
client.name)
1582
logger.warning("Client %s timed out while"
1583
" waiting for approval",
1584
client.name)
2414
1585
if self.server.use_dbus:
2415
1586
# Emit D-Bus signal
2416
1587
client.Rejected("Approval timed out")
2419
1590
break
2420
1591
else:
2421
1592
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)
1593
1594
sent_size = 0
1595
while sent_size < len(client.secret):
1596
try:
1597
sent = session.send(client.secret[sent_size:])
1598
except gnutls.errors.GNUTLSError as error:
1599
logger.warning("gnutls send failed")
1600
return
1601
logger.debug("Sent: %d, remaining: %d",
1602
sent, len(client.secret)
1603
- (sent_size + sent))
1604
sent_size += sent
1605
1606
logger.info("Sending secret to %s", client.name)
2430
1607
# bump the timeout using extended_timeout
2431
client.bump_timeout(client.extended_timeout)
1608
client.checked_ok(client.extended_timeout)
2432
1609
if self.server.use_dbus:
2433
1610
# Emit D-Bus signal
2434
1611
client.GotSecret()
2435
1612
2436
1613
finally:
2437
1614
if approval_required:
2438
1615
client.approvals_pending -= 1
2439
1616
try:
2440
1617
session.bye()
2441
except gnutls.Error as error:
2442
log.warning("GnuTLS bye failed", exc_info=error)
2443
1618
except gnutls.errors.GNUTLSError as error:
1619
logger.warning("GnuTLS bye failed")
1620
2444
1621
@staticmethod
2445
1622
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""
1623
"Return the peer's OpenPGP certificate as a bytestring"
1624
# If not an OpenPGP certificate...
1625
if (gnutls.library.functions
1626
.gnutls_certificate_type_get(session._c_object)
1627
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1628
# ...do the normal thing
1629
return session.peer_certificate
2462
1630
list_size = ctypes.c_uint(1)
2463
cert_list = (gnutls.certificate_get_peers
2464
(session, ctypes.byref(list_size)))
1631
cert_list = (gnutls.library.functions
1632
.gnutls_certificate_get_peers
1633
(session._c_object, ctypes.byref(list_size)))
2465
1634
if not bool(cert_list) and list_size.value != 0:
2466
raise gnutls.Error("error getting peer certificate")
1635
raise gnutls.errors.GNUTLSError("error getting peer"
1636
" certificate")
2467
1637
if list_size.value == 0:
2468
1638
return None
2469
1639
cert = cert_list[0]
2470
1640
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
1641
2507
1642
@staticmethod
2508
1643
def fingerprint(openpgp):
2509
1644
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2510
1645
# 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)))
1646
datum = (gnutls.library.types
1647
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1648
ctypes.POINTER
1649
(ctypes.c_ubyte)),
1650
ctypes.c_uint(len(openpgp))))
2515
1651
# New empty GnuTLS certificate
2516
crt = gnutls.openpgp_crt_t()
2517
gnutls.openpgp_crt_init(ctypes.byref(crt))
1652
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1653
(gnutls.library.functions
1654
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2518
1655
# Import the OpenPGP public key into the certificate
2519
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2520
gnutls.OPENPGP_FMT_RAW)
1656
(gnutls.library.functions
1657
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1658
gnutls.library.constants
1659
.GNUTLS_OPENPGP_FMT_RAW))
2521
1660
# Verify the self signature in the key
2522
1661
crtverify = ctypes.c_uint()
2523
gnutls.openpgp_crt_verify_self(crt, 0,
2524
ctypes.byref(crtverify))
1662
(gnutls.library.functions
1663
.gnutls_openpgp_crt_verify_self(crt, 0,
1664
ctypes.byref(crtverify)))
2525
1665
if crtverify.value != 0:
2526
gnutls.openpgp_crt_deinit(crt)
2527
raise gnutls.CertificateSecurityError(code
2528
=crtverify.value)
1666
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1667
raise (gnutls.errors.CertificateSecurityError
1668
("Verify failed"))
2529
1669
# New buffer for the fingerprint
2530
1670
buf = ctypes.create_string_buffer(20)
2531
1671
buf_len = ctypes.c_size_t()
2532
1672
# Get the fingerprint from the certificate into the buffer
2533
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2534
ctypes.byref(buf_len))
1673
(gnutls.library.functions
1674
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1675
ctypes.byref(buf_len)))
2535
1676
# Deinit the certificate
2536
gnutls.openpgp_crt_deinit(crt)
1677
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2537
1678
# Convert the buffer to a Python bytestring
2538
1679
fpr = ctypes.string_at(buf, buf_len.value)
2539
1680
# Convert the bytestring to hexadecimal notation
2541
1682
return hex_fpr
2542
1683
2543
1684
2544
class MultiprocessingMixIn:
1685
class MultiprocessingMixIn(object):
2545
1686
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2546
2547
1687
def sub_process_main(self, request, address):
2548
1688
try:
2549
1689
self.finish_request(request, address)
2550
1690
except Exception:
2551
1691
self.handle_error(request, address)
2552
1692
self.close_request(request)
2553
1693
2554
1694
def process_request(self, request, address):
2555
1695
"""Start a new process to process the request."""
2556
proc = multiprocessing.Process(target=self.sub_process_main,
2557
args=(request, address))
1696
proc = multiprocessing.Process(target = self.sub_process_main,
1697
args = (request,
1698
address))
2558
1699
proc.start()
2559
1700
return proc
2560
1701
2561
1702
2562
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1703
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2563
1704
""" adds a pipe to the MixIn """
2564
2565
1705
def process_request(self, request, client_address):
2566
1706
"""Overrides and wraps the original process_request().
2567
1707
2568
1708
This function creates a new pipe in self.pipe
2569
1709
"""
2570
1710
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2571
1711
2572
1712
proc = MultiprocessingMixIn.process_request(self, request,
2573
1713
client_address)
2574
1714
self.child_pipe.close()
2575
1715
self.add_pipe(parent_pipe, proc)
2576
1716
2577
1717
def add_pipe(self, parent_pipe, proc):
2578
1718
"""Dummy function; override as necessary"""
2579
raise NotImplementedError()
1719
raise NotImplementedError
2580
1720
2581
1721
2582
1722
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2583
socketserver.TCPServer):
2584
"""IPv6-capable TCP server. Accepts None as address and/or port
2585
1723
socketserver.TCPServer, object):
1724
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1725
2586
1726
Attributes:
2587
1727
enabled: Boolean; whether this server is activated yet
2588
1728
interface: None or a network interface name (string)
2589
1729
use_ipv6: Boolean; to use IPv6 or not
2590
1730
"""
2591
2592
1731
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
"""
1732
interface=None, use_ipv6=True):
2599
1733
self.interface = interface
2600
1734
if use_ipv6:
2601
1735
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
1736
socketserver.TCPServer.__init__(self, server_address,
2630
1737
RequestHandlerClass)
2631
2632
1738
def server_bind(self):
2633
1739
"""This overrides the normal server_bind() function
2634
1740
to bind to an interface if one was specified, and also NOT to
2635
1741
bind to an address or port if they were not specified."""
2636
global SO_BINDTODEVICE
2637
1742
if self.interface is not None:
2638
1743
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
1744
logger.error("SO_BINDTODEVICE does not exist;"
1745
" cannot bind to interface %s",
1746
self.interface)
1747
else:
1748
try:
1749
self.socket.setsockopt(socket.SOL_SOCKET,
1750
SO_BINDTODEVICE,
1751
str(self.interface
1752
+ '\0'))
1753
except socket.error as error:
1754
if error[0] == errno.EPERM:
1755
logger.error("No permission to"
1756
" bind to interface %s",
1757
self.interface)
1758
elif error[0] == errno.ENOPROTOOPT:
1759
logger.error("SO_BINDTODEVICE not available;"
1760
" cannot bind to interface %s",
1761
self.interface)
1762
else:
1763
raise
2659
1764
# Only bind(2) the socket if we really need to.
2660
1765
if self.server_address[0] or self.server_address[1]:
2661
if self.server_address[1]:
2662
self.allow_reuse_address = True
2663
1766
if not self.server_address[0]:
2664
1767
if self.address_family == socket.AF_INET6:
2665
any_address = "::" # in6addr_any
1768
any_address = "::" # in6addr_any
2666
1769
else:
2667
any_address = "0.0.0.0" # INADDR_ANY
1770
any_address = socket.INADDR_ANY
2668
1771
self.server_address = (any_address,
2669
1772
self.server_address[1])
2670
1773
elif not self.server_address[1]:
2671
self.server_address = (self.server_address[0], 0)
1774
self.server_address = (self.server_address[0],
1775
0)
2672
1776
# if self.interface:
2673
1777
# self.server_address = (self.server_address[0],
2674
1778
# 0, # port
2680
1784
2681
1785
class MandosServer(IPv6_TCPServer):
2682
1786
"""Mandos server.
2683
1787
2684
1788
Attributes:
2685
1789
clients: set of Client objects
2686
1790
gnutls_priority GnuTLS priority string
2687
1791
use_dbus: Boolean; to emit D-Bus signals or not
2688
2689
Assumes a GLib.MainLoop event loop.
1792
1793
Assumes a gobject.MainLoop event loop.
2690
1794
"""
2691
2692
1795
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):
1796
interface=None, use_ipv6=True, clients=None,
1797
gnutls_priority=None, use_dbus=True):
2699
1798
self.enabled = False
2700
1799
self.clients = clients
2701
1800
if self.clients is None:
2704
1803
self.gnutls_priority = gnutls_priority
2705
1804
IPv6_TCPServer.__init__(self, server_address,
2706
1805
RequestHandlerClass,
2707
interface=interface,
2708
use_ipv6=use_ipv6,
2709
socketfd=socketfd)
2710
1806
interface = interface,
1807
use_ipv6 = use_ipv6)
2711
1808
def server_activate(self):
2712
1809
if self.enabled:
2713
1810
return socketserver.TCPServer.server_activate(self)
2714
1811
2715
1812
def enable(self):
2716
1813
self.enabled = True
2717
1814
2718
1815
def add_pipe(self, parent_pipe, proc):
2719
1816
# 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):
1817
gobject.io_add_watch(parent_pipe.fileno(),
1818
gobject.IO_IN | gobject.IO_HUP,
1819
functools.partial(self.handle_ipc,
1820
parent_pipe =
1821
parent_pipe,
1822
proc = proc))
1823
1824
def handle_ipc(self, source, condition, parent_pipe=None,
1825
proc = None, client_object=None):
1826
condition_names = {
1827
gobject.IO_IN: "IN", # There is data to read.
1828
gobject.IO_OUT: "OUT", # Data can be written (without
1829
# blocking).
1830
gobject.IO_PRI: "PRI", # There is urgent data to read.
1831
gobject.IO_ERR: "ERR", # Error condition.
1832
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1833
# broken, usually for pipes and
1834
# sockets).
1835
}
1836
conditions_string = ' | '.join(name
1837
for cond, name in
1838
condition_names.iteritems()
1839
if cond & condition)
2731
1840
# error, or the other end of multiprocessing.Pipe has closed
2732
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1841
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2733
1842
# Wait for other process to exit
2734
1843
proc.join()
2735
1844
return False
2736
1845
2737
1846
# Read a request from the child
2738
1847
request = parent_pipe.recv()
2739
1848
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:
1849
1850
if command == 'init':
1851
fpr = request[1]
1852
address = request[2]
1853
1854
for c in self.clients.itervalues():
1855
if c.fingerprint == fpr:
2754
1856
client = c
2755
1857
break
2756
1858
else:
2757
log.info("Client not found for key ID: %s, address:"
2758
" %s", key_id or fpr, address)
1859
logger.info("Client not found for fingerprint: %s, ad"
1860
"dress: %s", fpr, address)
2759
1861
if self.use_dbus:
2760
1862
# Emit D-Bus signal
2761
mandos_dbus_service.ClientNotFound(key_id or fpr,
1863
mandos_dbus_service.ClientNotFound(fpr,
2762
1864
address[0])
2763
1865
parent_pipe.send(False)
2764
1866
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))
1867
1868
gobject.io_add_watch(parent_pipe.fileno(),
1869
gobject.IO_IN | gobject.IO_HUP,
1870
functools.partial(self.handle_ipc,
1871
parent_pipe =
1872
parent_pipe,
1873
proc = proc,
1874
client_object =
1875
client))
2773
1876
parent_pipe.send(True)
2774
1877
# remove the old hook in favor of the new above hook on
2775
1878
# same fileno
2776
1879
return False
2777
if command == "funcall":
1880
if command == 'funcall':
2778
1881
funcname = request[1]
2779
1882
args = request[2]
2780
1883
kwargs = request[3]
2781
2782
parent_pipe.send(("data", getattr(client_object,
1884
1885
parent_pipe.send(('data', getattr(client_object,
2783
1886
funcname)(*args,
2784
**kwargs)))
2785
2786
if command == "getattr":
1887
**kwargs)))
1888
1889
if command == 'getattr':
2787
1890
attrname = request[1]
2788
if isinstance(client_object.__getattribute__(attrname),
2789
collections.abc.Callable):
2790
parent_pipe.send(("function", ))
1891
if callable(client_object.__getattribute__(attrname)):
1892
parent_pipe.send(('function',))
2791
1893
else:
2792
parent_pipe.send((
2793
"data", client_object.__getattribute__(attrname)))
2794
2795
if command == "setattr":
1894
parent_pipe.send(('data', client_object
1895
.__getattribute__(attrname)))
1896
1897
if command == 'setattr':
2796
1898
attrname = request[1]
2797
1899
value = request[2]
2798
1900
setattr(client_object, attrname, value)
2799
1901
2800
1902
return True
2801
1903
2802
1904
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
1905
def string_to_delta(interval):
2905
1906
"""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
1907
1908
>>> string_to_delta('7d')
1909
datetime.timedelta(7)
1910
>>> string_to_delta('60s')
1911
datetime.timedelta(0, 60)
1912
>>> string_to_delta('60m')
1913
datetime.timedelta(0, 3600)
1914
>>> string_to_delta('24h')
1915
datetime.timedelta(1)
1916
>>> string_to_delta('1w')
1917
datetime.timedelta(7)
1918
>>> string_to_delta('5m 30s')
1919
datetime.timedelta(0, 330)
2919
1920
"""
2920
2921
try:
2922
return rfc3339_duration_to_delta(interval)
2923
except ValueError:
2924
pass
2925
2926
1921
timevalue = datetime.timedelta(0)
2927
1922
for s in interval.split():
2928
1923
try:
2929
suffix = s[-1]
1924
suffix = unicode(s[-1])
2930
1925
value = int(s[:-1])
2931
1926
if suffix == "d":
2932
1927
delta = datetime.timedelta(value)
2939
1934
elif suffix == "w":
2940
1935
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2941
1936
else:
2942
raise ValueError("Unknown suffix {!r}".format(suffix))
2943
except IndexError as e:
1937
raise ValueError("Unknown suffix %r" % suffix)
1938
except (ValueError, IndexError) as e:
2944
1939
raise ValueError(*(e.args))
2945
1940
timevalue += delta
2946
1941
return timevalue
2947
1942
2948
1943
2949
def daemon(nochdir=False, noclose=False):
1944
def daemon(nochdir = False, noclose = False):
2950
1945
"""See daemon(3). Standard BSD Unix function.
2951
1946
2952
1947
This should really exist as os.daemon, but it doesn't (yet)."""
2953
1948
if os.fork():
2954
1949
sys.exit()
2959
1954
sys.exit()
2960
1955
if not noclose:
2961
1956
# Close all standard open file descriptors
2962
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1957
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2963
1958
if not stat.S_ISCHR(os.fstat(null).st_mode):
2964
1959
raise OSError(errno.ENODEV,
2965
"{} not a character device"
2966
.format(os.devnull))
1960
"%s not a character device"
1961
% os.path.devnull)
2967
1962
os.dup2(null, sys.stdin.fileno())
2968
1963
os.dup2(null, sys.stdout.fileno())
2969
1964
os.dup2(null, sys.stderr.fileno())
2972
1967
2973
1968
2974
1969
def main():
2975
1970
2976
1971
##################################################################
2977
1972
# Parsing of options, both command line and config file
2978
1973
2979
1974
parser = argparse.ArgumentParser()
2980
1975
parser.add_argument("-v", "--version", action="version",
2981
version="%(prog)s {}".format(version),
1976
version = "%%(prog)s %s" % version,
2982
1977
help="show version number and exit")
2983
1978
parser.add_argument("-i", "--interface", metavar="IF",
2984
1979
help="Bind to interface IF")
2990
1985
help="Run self-test")
2991
1986
parser.add_argument("--debug", action="store_true",
2992
1987
help="Debug mode; run in foreground and log"
2993
" to terminal", default=None)
1988
" to terminal")
2994
1989
parser.add_argument("--debuglevel", metavar="LEVEL",
2995
1990
help="Debug level for stdout output")
2996
1991
parser.add_argument("--priority", help="GnuTLS"
3003
1998
" files")
3004
1999
parser.add_argument("--no-dbus", action="store_false",
3005
2000
dest="use_dbus", help="Do not provide D-Bus"
3006
" system bus interface", default=None)
2001
" system bus interface")
3007
2002
parser.add_argument("--no-ipv6", action="store_false",
3008
dest="use_ipv6", help="Do not use IPv6",
3009
default=None)
2003
dest="use_ipv6", help="Do not use IPv6")
3010
2004
parser.add_argument("--no-restore", action="store_false",
3011
2005
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")
2006
" state")
3016
2007
parser.add_argument("--statedir", metavar="DIR",
3017
2008
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
2009
3024
2010
options = parser.parse_args()
3025
2011
2012
if options.check:
2013
import doctest
2014
doctest.testmod()
2015
sys.exit()
2016
3026
2017
# 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
2018
server_defaults = { "interface": "",
2019
"address": "",
2020
"port": "",
2021
"debug": "False",
2022
"priority":
2023
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2024
"servicename": "Mandos",
2025
"use_dbus": "True",
2026
"use_ipv6": "True",
2027
"debuglevel": "",
2028
"restore": "True",
2029
"statedir": "/var/lib/mandos"
2030
}
2031
3050
2032
# Parse config file for server-global settings
3051
server_config = configparser.ConfigParser(server_defaults)
2033
server_config = configparser.SafeConfigParser(server_defaults)
3052
2034
del server_defaults
3053
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3054
# Convert the ConfigParser object to a dict
2035
server_config.read(os.path.join(options.configdir,
2036
"mandos.conf"))
2037
# Convert the SafeConfigParser object to a dict
3055
2038
server_settings = server_config.defaults()
3056
2039
# Use the appropriate methods on the non-string config options
3057
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3058
"foreground", "zeroconf"):
2040
for option in ("debug", "use_dbus", "use_ipv6"):
3059
2041
server_settings[option] = server_config.getboolean("DEFAULT",
3060
2042
option)
3061
2043
if server_settings["port"]:
3062
2044
server_settings["port"] = server_config.getint("DEFAULT",
3063
2045
"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
2046
del server_config
3074
2047
3075
2048
# Override the settings from the config file with command line
3076
2049
# options, if set.
3077
2050
for option in ("interface", "address", "port", "debug",
3078
"priority", "servicename", "configdir", "use_dbus",
3079
"use_ipv6", "debuglevel", "restore", "statedir",
3080
"socket", "foreground", "zeroconf"):
2051
"priority", "servicename", "configdir",
2052
"use_dbus", "use_ipv6", "debuglevel", "restore",
2053
"statedir"):
3081
2054
value = getattr(options, option)
3082
2055
if value is not None:
3083
2056
server_settings[option] = value
3084
2057
del options
3085
2058
# Force all strings to be unicode
3086
2059
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
2060
if type(server_settings[option]) is str:
2061
server_settings[option] = unicode(server_settings[option])
3097
2062
# Now we have our good server settings in "server_settings"
3098
2063
3099
2064
##################################################################
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
2065
3106
2066
# For convenience
3107
2067
debug = server_settings["debug"]
3108
2068
debuglevel = server_settings["debuglevel"]
3110
2070
use_ipv6 = server_settings["use_ipv6"]
3111
2071
stored_state_path = os.path.join(server_settings["statedir"],
3112
2072
stored_state_file)
3113
foreground = server_settings["foreground"]
3114
zeroconf = server_settings["zeroconf"]
3115
2073
3116
2074
if debug:
3117
2075
initlogger(debug, logging.DEBUG)
3118
2076
else:
3121
2079
else:
3122
2080
level = getattr(logging, debuglevel.upper())
3123
2081
initlogger(debug, level)
3124
2082
3125
2083
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
2084
syslogger.setFormatter(logging.Formatter
2085
('Mandos (%s) [%%(process)d]:'
2086
' %%(levelname)s: %%(message)s'
2087
% server_settings["servicename"]))
2088
3131
2089
# Parse config file with clients
3132
client_config = configparser.ConfigParser(Client.client_defaults)
2090
client_config = configparser.SafeConfigParser(Client
2091
.client_defaults)
3133
2092
client_config.read(os.path.join(server_settings["configdir"],
3134
2093
"clients.conf"))
3135
2094
3136
2095
global mandos_dbus_service
3137
2096
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
2097
2098
tcp_server = MandosServer((server_settings["address"],
2099
server_settings["port"]),
2100
ClientHandler,
2101
interface=(server_settings["interface"]
2102
or None),
2103
use_ipv6=use_ipv6,
2104
gnutls_priority=
2105
server_settings["priority"],
2106
use_dbus=use_dbus)
2107
if not debug:
2108
pidfilename = "/var/run/mandos.pid"
2109
try:
2110
pidfile = open(pidfilename, "w")
2111
except IOError:
2112
logger.error("Could not open file %r", pidfilename)
2113
2114
try:
2115
uid = pwd.getpwnam("_mandos").pw_uid
2116
gid = pwd.getpwnam("_mandos").pw_gid
2117
except KeyError:
2118
try:
2119
uid = pwd.getpwnam("mandos").pw_uid
2120
gid = pwd.getpwnam("mandos").pw_gid
3168
2121
except KeyError:
3169
continue
3170
else:
3171
uid = 65534
3172
gid = 65534
2122
try:
2123
uid = pwd.getpwnam("nobody").pw_uid
2124
gid = pwd.getpwnam("nobody").pw_gid
2125
except KeyError:
2126
uid = 65534
2127
gid = 65534
3173
2128
try:
3174
2129
os.setgid(gid)
3175
2130
os.setuid(uid)
3176
log.debug("Did setuid/setgid to %s:%s", uid, gid)
3177
2131
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
2132
if error[0] != errno.EPERM:
2133
raise error
2134
3183
2135
if debug:
3184
2136
# Enable all possible GnuTLS debugging
3185
2137
3186
2138
# "Use a log level over 10 to enable all debugging options."
3187
2139
# - GnuTLS manual
3188
gnutls.global_set_log_level(11)
3189
3190
@gnutls.log_func
2140
gnutls.library.functions.gnutls_global_set_log_level(11)
2141
2142
@gnutls.library.types.gnutls_log_func
3191
2143
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
2144
logger.debug("GnuTLS: %s", string[:-1])
2145
2146
(gnutls.library.functions
2147
.gnutls_global_set_log_function(debug_gnutls))
2148
3197
2149
# Redirect stdin so all checkers get /dev/null
3198
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2150
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3199
2151
os.dup2(null, sys.stdin.fileno())
3200
2152
if null > 2:
3201
2153
os.close(null)
3202
2154
3203
2155
# Need to fork before connecting to D-Bus
3204
if not foreground:
2156
if not debug:
3205
2157
# Close all input and output, do double fork, etc.
3206
2158
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
2159
2160
gobject.threads_init()
2161
3213
2162
global main_loop
3214
2163
# From the Avahi example code
3215
DBusGMainLoop(set_as_default=True)
3216
main_loop = GLib.MainLoop()
2164
DBusGMainLoop(set_as_default=True )
2165
main_loop = gobject.MainLoop()
3217
2166
bus = dbus.SystemBus()
3218
2167
# End of Avahi example code
3219
2168
if use_dbus:
3220
2169
try:
3221
2170
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)
2171
bus, do_not_queue=True)
2172
old_bus_name = (dbus.service.BusName
2173
("se.bsnet.fukt.Mandos", bus,
2174
do_not_queue=True))
2175
except dbus.exceptions.NameExistsException as e:
2176
logger.error(unicode(e) + ", disabling D-Bus")
3229
2177
use_dbus = False
3230
2178
server_settings["use_dbus"] = False
3231
2179
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
2180
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2181
service = AvahiServiceToSyslog(name =
2182
server_settings["servicename"],
2183
servicetype = "_mandos._tcp",
2184
protocol = protocol, bus = bus)
2185
if server_settings["interface"]:
2186
service.interface = (if_nametoindex
2187
(str(server_settings["interface"])))
2188
3243
2189
global multiprocessing_manager
3244
2190
multiprocessing_manager = multiprocessing.Manager()
3245
2191
3246
2192
client_class = Client
3247
2193
if use_dbus:
3248
client_class = functools.partial(ClientDBus, bus=bus)
3249
2194
client_class = functools.partial(ClientDBusTransitional,
2195
bus = bus)
2196
3250
2197
client_settings = Client.config_parser(client_config)
3251
2198
old_client_settings = {}
3252
2199
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
2200
3262
2201
# Get client data and settings from last running state.
3263
2202
if server_settings["restore"]:
3264
2203
try:
3265
2204
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"))
2205
clients_data, old_client_settings = (pickle.load
2206
(stored_state))
3316
2207
os.remove(stored_state_path)
3317
2208
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)
2209
logger.warning("Could not load persistent state: {0}"
2210
.format(e))
2211
if e.errno != errno.ENOENT:
3324
2212
raise
3325
2213
except EOFError as e:
3326
log.warning("Could not load persistent state: EOFError:",
3327
exc_info=e)
3328
2214
logger.warning("Could not load persistent state: "
2215
"EOFError: {0}".format(e))
2216
3329
2217
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
2218
for client_name, client in clients_data.iteritems():
3335
2219
# Decide which value to use after restoring saved state.
3336
2220
# We have three different values: Old config file,
3337
2221
# new config file, and saved state.
3342
2226
# For each value in new config, check if it
3343
2227
# differs from the old config value (Except for
3344
2228
# the "secret" attribute)
3345
if (name != "secret"
3346
and (value !=
3347
old_client_settings[client_name][name])):
2229
if (name != "secret" and
2230
value != old_client_settings[client_name]
2231
[name]):
3348
2232
client[name] = value
3349
2233
except KeyError:
3350
2234
pass
3351
2235
3352
2236
# Clients who has passed its expire date can still be
3353
# enabled if its last checker was successful. A Client
2237
# enabled if its last checker was successful. Clients
3354
2238
# whose checker succeeded before we stored its state is
3355
2239
# assumed to have successfully run all checkers during
3356
2240
# downtime.
3357
2241
if client["enabled"]:
3358
2242
if datetime.datetime.utcnow() >= client["expires"]:
3359
2243
if not client["last_checked_ok"]:
3360
log.warning("disabling client %s - Client"
3361
" never performed a successful"
3362
" checker", client_name)
2244
logger.warning(
2245
"disabling client {0} - Client never "
2246
"performed a successful checker"
2247
.format(client_name))
3363
2248
client["enabled"] = False
3364
2249
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"])
2250
logger.warning(
2251
"disabling client {0} - Client "
2252
"last checker failed with error code {1}"
2253
.format(client_name,
2254
client["last_checker_status"]))
3369
2255
client["enabled"] = False
3370
2256
else:
3371
client["expires"] = (
3372
datetime.datetime.utcnow()
3373
+ client["timeout"])
3374
log.debug("Last checker succeeded, keeping %s"
3375
" enabled", client_name)
2257
client["expires"] = (datetime.datetime
2258
.utcnow()
2259
+ client["timeout"])
2260
logger.debug("Last checker succeeded,"
2261
" keeping {0} enabled"
2262
.format(client_name))
3376
2263
try:
3377
client["secret"] = pgp.decrypt(
3378
client["encrypted_secret"],
3379
client_settings[client_name]["secret"])
2264
client["secret"] = (
2265
pgp.decrypt(client["encrypted_secret"],
2266
client_settings[client_name]
2267
["secret"]))
3380
2268
except PGPError:
3381
2269
# 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"])
2270
logger.debug("Failed to decrypt {0} old secret"
2271
.format(client_name))
2272
client["secret"] = (
2273
client_settings[client_name]["secret"])
3386
2274
2275
3387
2276
# Add/remove clients based on new changes made to config
3388
2277
for client_name in (set(old_client_settings)
3389
2278
- set(client_settings)):
3393
2282
clients_data[client_name] = client_settings[client_name]
3394
2283
3395
2284
# Create all client objects
3396
for client_name, client in clients_data.items():
2285
for client_name, client in clients_data.iteritems():
3397
2286
tcp_server.clients[client_name] = client_class(
3398
name=client_name,
3399
settings=client,
3400
server_settings=server_settings)
3401
2287
name = client_name, settings = client)
2288
3402
2289
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
2290
logger.warning("No clients defined")
2291
2292
if not debug:
2293
try:
2294
with pidfile:
2295
pid = os.getpid()
2296
pidfile.write(str(pid) + "\n".encode("utf-8"))
2297
del pidfile
2298
except IOError:
2299
logger.error("Could not write to file %r with PID %d",
2300
pidfilename, pid)
2301
except NameError:
2302
# "pidfile" was never created
2303
pass
3415
2304
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
2305
signal.signal(signal.SIGINT, signal.SIG_IGN)
2306
2307
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2308
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2309
3421
2310
if use_dbus:
3422
3423
@alternate_dbus_interfaces(
3424
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3425
class MandosDBusService(DBusObjectWithObjectManager):
2311
class MandosDBusService(dbus.service.Object):
3426
2312
"""A D-Bus proxy object"""
3427
3428
2313
def __init__(self):
3429
2314
dbus.service.Object.__init__(self, bus, "/")
3430
3431
2315
_interface = "se.recompile.Mandos"
3432
2316
3433
2317
@dbus.service.signal(_interface, signature="o")
3434
2318
def ClientAdded(self, objpath):
3435
2319
"D-Bus signal"
3436
2320
pass
3437
2321
3438
2322
@dbus.service.signal(_interface, signature="ss")
3439
def ClientNotFound(self, key_id, address):
2323
def ClientNotFound(self, fingerprint, address):
3440
2324
"D-Bus signal"
3441
2325
pass
3442
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3444
"true"})
2326
3445
2327
@dbus.service.signal(_interface, signature="os")
3446
2328
def ClientRemoved(self, objpath, name):
3447
2329
"D-Bus signal"
3448
2330
pass
3449
3450
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3451
"true"})
2331
3452
2332
@dbus.service.method(_interface, out_signature="ao")
3453
2333
def GetAllClients(self):
3454
2334
"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"})
2335
return dbus.Array(c.dbus_object_path
2336
for c in
2337
tcp_server.clients.itervalues())
2338
3460
2339
@dbus.service.method(_interface,
3461
2340
out_signature="a{oa{sv}}")
3462
2341
def GetAllClientsWithProperties(self):
3463
2342
"D-Bus method"
3464
2343
return dbus.Dictionary(
3465
{c.dbus_object_path: c.GetAll(
3466
"se.recompile.Mandos.Client")
3467
for c in tcp_server.clients.values()},
2344
((c.dbus_object_path, c.GetAll(""))
2345
for c in tcp_server.clients.itervalues()),
3468
2346
signature="oa{sv}")
3469
2347
3470
2348
@dbus.service.method(_interface, in_signature="o")
3471
2349
def RemoveClient(self, object_path):
3472
2350
"D-Bus method"
3473
for c in tcp_server.clients.values():
2351
for c in tcp_server.clients.itervalues():
3474
2352
if c.dbus_object_path == object_path:
3475
2353
del tcp_server.clients[c.name]
3476
2354
c.remove_from_connection()
3477
# Don't signal the disabling
2355
# Don't signal anything except ClientRemoved
3478
2356
c.disable(quiet=True)
3479
# Emit D-Bus signal for removal
3480
self.client_removed_signal(c)
2357
# Emit D-Bus signal
2358
self.ClientRemoved(object_path, c.name)
3481
2359
return
3482
2360
raise KeyError(object_path)
3483
2361
3484
2362
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
2363
2364
class MandosDBusServiceTransitional(MandosDBusService):
2365
__metaclass__ = AlternateDBusNamesMetaclass
2366
mandos_dbus_service = MandosDBusServiceTransitional()
2367
3529
2368
def cleanup():
3530
2369
"Cleanup function; run on exit"
3531
if zeroconf:
3532
service.cleanup()
3533
3534
mp.active_children()
3535
wn.close()
2370
service.cleanup()
2371
2372
multiprocessing.active_children()
3536
2373
if not (tcp_server.clients or client_settings):
3537
2374
return
3538
2375
3539
2376
# Store client before exiting. Secrets are encrypted with key
3540
2377
# based on what config file has. If config file is
3541
2378
# removed/edited, old secret will thus be unrecovable.
3542
2379
clients = {}
3543
2380
with PGPEngine() as pgp:
3544
for client in tcp_server.clients.values():
2381
for client in tcp_server.clients.itervalues():
3545
2382
key = client_settings[client.name]["secret"]
3546
2383
client.encrypted_secret = pgp.encrypt(client.secret,
3547
2384
key)
3548
2385
client_dict = {}
3549
2386
3550
2387
# A list of attributes that can not be pickled
3551
2388
# + secret.
3552
exclude = {"bus", "changedstate", "secret",
3553
"checker", "server_settings"}
3554
for name, typ in inspect.getmembers(dbus.service
3555
.Object):
2389
exclude = set(("bus", "changedstate", "secret",
2390
"checker"))
2391
for name, typ in (inspect.getmembers
2392
(dbus.service.Object)):
3556
2393
exclude.add(name)
3557
2394
3558
2395
client_dict["encrypted_secret"] = (client
3559
2396
.encrypted_secret)
3560
2397
for attr in client.client_structure:
3561
2398
if attr not in exclude:
3562
2399
client_dict[attr] = getattr(client, attr)
3563
2400
3564
2401
clients[client.name] = client_dict
3565
2402
del client_settings[client.name]["secret"]
3566
2403
3567
2404
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
2405
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2406
prefix="clients-",
2407
dir=os.path.dirname
2408
(stored_state_path))
2409
with os.fdopen(tempfd, "wb") as stored_state:
2410
pickle.dump((clients, client_settings), stored_state)
3577
2411
os.rename(tempname, stored_state_path)
3578
2412
except (IOError, OSError) as e:
2413
logger.warning("Could not save persistent state: {0}"
2414
.format(e))
3579
2415
if not debug:
3580
2416
try:
3581
2417
os.remove(tempname)
3582
2418
except NameError:
3583
2419
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
2420
if e.errno not in set((errno.ENOENT, errno.EACCES,
2421
errno.EEXIST)):
2422
raise e
2423
3592
2424
# Delete all clients, and settings from config
3593
2425
while tcp_server.clients:
3594
2426
name, client = tcp_server.clients.popitem()
3595
2427
if use_dbus:
3596
2428
client.remove_from_connection()
3597
# Don't signal the disabling
2429
# Don't signal anything except ClientRemoved
3598
2430
client.disable(quiet=True)
3599
# Emit D-Bus signal for removal
3600
2431
if use_dbus:
3601
mandos_dbus_service.client_removed_signal(client)
2432
# Emit D-Bus signal
2433
mandos_dbus_service.ClientRemoved(client
2434
.dbus_object_path,
2435
client.name)
3602
2436
client_settings.clear()
3603
2437
3604
2438
atexit.register(cleanup)
3605
3606
for client in tcp_server.clients.values():
2439
2440
for client in tcp_server.clients.itervalues():
3607
2441
if use_dbus:
3608
# Emit D-Bus signal for adding
3609
mandos_dbus_service.client_added_signal(client)
2442
# Emit D-Bus signal
2443
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3610
2444
# Need to initiate checking of clients
3611
2445
if client.enabled:
3612
2446
client.init_checker()
3613
2447
3614
2448
tcp_server.enable()
3615
2449
tcp_server.server_activate()
3616
2450
3617
2451
# Find out what port we got
3618
if zeroconf:
3619
service.port = tcp_server.socket.getsockname()[1]
2452
service.port = tcp_server.socket.getsockname()[1]
3620
2453
if use_ipv6:
3621
log.info("Now listening on address %r, port %d, flowinfo %d,"
3622
" scope_id %d", *tcp_server.socket.getsockname())
2454
logger.info("Now listening on address %r, port %d,"
2455
" flowinfo %d, scope_id %d"
2456
% tcp_server.socket.getsockname())
3623
2457
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
2458
logger.info("Now listening on address %r, port %d"
2459
% tcp_server.socket.getsockname())
2460
2461
#service.interface = tcp_server.socket.getsockname()[3]
2462
3629
2463
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")
2464
# From the Avahi example code
2465
try:
2466
service.activate()
2467
except dbus.exceptions.DBusException as error:
2468
logger.critical("DBusException: %s", error)
2469
cleanup()
2470
sys.exit(1)
2471
# End of Avahi example code
2472
2473
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2474
lambda *args, **kwargs:
2475
(tcp_server.handle_request
2476
(*args[2:], **kwargs) or True))
2477
2478
logger.debug("Starting main loop")
3647
2479
main_loop.run()
3648
2480
except AvahiError as error:
3649
log.critical("Avahi Error", exc_info=error)
2481
logger.critical("AvahiError: %s", error)
3650
2482
cleanup()
3651
2483
sys.exit(1)
3652
2484
except KeyboardInterrupt:
3653
2485
if debug:
3654
2486
print("", file=sys.stderr)
3655
log.debug("Server received KeyboardInterrupt")
3656
log.debug("Server exiting")
2487
logger.debug("Server received KeyboardInterrupt")
2488
logger.debug("Server exiting")
3657
2489
# Must run before the D-Bus bus name gets deregistered
3658
2490
cleanup()
3659
2491
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 ((process-result
3714
# (let ((inhibit-read-only t))
3715
# (process-file-shell-command
3716
# (funcall get-command-line extra) nil "*Test*"))))
3717
# (and (numberp process-result)
3718
# (= process-result 0))))
3719
# get-command-line:
3720
# (lambda (&optional extra)
3721
# (let ((quoted-script
3722
# (shell-quote-argument (funcall get-script-name))))
3723
# (format
3724
# (concat "%s --check" (if extra " --prefix=atest" ""))
3725
# quoted-script)))
3726
# get-script-name:
3727
# (lambda ()
3728
# (if (fboundp 'file-local-name)
3729
# (file-local-name (buffer-file-name))
3730
# (or (file-remote-p (buffer-file-name) 'localname)
3731
# (buffer-file-name))))
3732
# remove-test-window:
3733
# (lambda ()
3734
# (let ((test-window (get-buffer-window "*Test*")))
3735
# (if test-window (delete-window test-window))))
3736
# show-test-buffer-in-test-window:
3737
# (lambda ()
3738
# (when (not (get-buffer-window-list "*Test*"))
3739
# (setq next-error-last-buffer (get-buffer "*Test*"))
3740
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3741
# (display-buffer-overriding-action
3742
# `((display-buffer-in-side-window) (side . ,side)
3743
# (window-height . fit-window-to-buffer)
3744
# (window-width . fit-window-to-buffer))))
3745
# (display-buffer "*Test*"))))
3746
# eval:
3747
# (progn
3748
# (let* ((run-extra-tests (lambda () (interactive)
3749
# (funcall run-tests t)))
3750
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3751
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3752
# (setq minor-mode-overriding-map-alist
3753
# (cons `(run-tests . ,outer-keymap)
3754
# minor-mode-overriding-map-alist)))
3755
# (add-hook 'after-save-hook run-tests 90 t))
3756
# End:
2492
if __name__ == '__main__':
2493
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0