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