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