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