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