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