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