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