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