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