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