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