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