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