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