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