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