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