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