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