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