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