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