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