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