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