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