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