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