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