/mandos/trunk : revision 24.1.34

6

# This program is partly derived from an example program for an Avahi

7

# service publisher, downloaded from

8

# <http://avahi.org/wiki/PythonPublishExample>. This includes the

9

# following functions: "AvahiService.add", "AvahiService.remove",

10

# "server_state_changed", "entry_group_state_changed", and some lines

11

# in "main".

9

# methods "add" and "remove" in the "AvahiService" class, the

10

# "server_state_changed" and "entry_group_state_changed" functions,

11

# and some lines in "main".

12

#

13

# Everything else is

14

61

from dbus.mainloop.glib import DBusGMainLoop

62

import ctypes

63

64

# Brief description of the operation of this program:

65

#

66

# This server announces itself as a Zeroconf service. Connecting

67

# clients use the TLS protocol, with the unusual quirk that this

68

# server program acts as a TLS "client" while a connecting client acts

69

# as a TLS "server". The client (acting as a TLS "server") must

70

# supply an OpenPGP certificate, and the fingerprint of this

71

# certificate is used by this server to look up (in a list read from a

72

# file at start time) which binary blob to give the client. No other

73

# authentication or authorization is done by this server.

74

64

version = "1.0"

75

65

76

66

logger = logging.Logger('mandos')

77

67

syslogger = logging.handlers.SysLogHandler\

78

(facility = logging.handlers.SysLogHandler.LOG_DAEMON)

68

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

69

address = "/dev/log")

79

70

syslogger.setFormatter(logging.Formatter\

80

('%(levelname)s: %(message)s'))

71

('Mandos: %(levelname)s: %(message)s'))

81

72

logger.addHandler(syslogger)

82

del syslogger

83

73

84

74

85

75

class AvahiError(Exception):

96

86

97

87

98

88

class AvahiService(object):

99

"""

89

"""An Avahi (Zeroconf) service.

90

Attributes:

100

91

interface: integer; avahi.IF_UNSPEC or an interface index.

101

92

Used to optionally bind to the specified interface.

102

name = string; Example: "Mandos"

103

type = string; Example: "_mandos._tcp".

104

See <http://www.dns-sd.org/ServiceTypes.html>

105

port = integer; what port to announce

106

TXT = list of strings; TXT record for the service

107

domain = string; Domain to publish on, default to .local if empty.

108

host = string; Host to publish records for, default to localhost

109

if empty.

110

max_renames = integer; maximum number of renames

111

rename_count = integer; counter so we only rename after collisions

112

a sensible number of times

93

name: string; Example: 'Mandos'

94

type: string; Example: '_mandos._tcp'.

95

See <http://www.dns-sd.org/ServiceTypes.html>

96

port: integer; what port to announce

97

TXT: list of strings; TXT record for the service

98

domain: string; Domain to publish on, default to .local if empty.

99

host: string; Host to publish records for, default is localhost

100

max_renames: integer; maximum number of renames

101

rename_count: integer; counter so we only rename after collisions

102

a sensible number of times

113

103

"""

114

104

def __init__(self, interface = avahi.IF_UNSPEC, name = None,

115

105

type = None, port = None, TXT = None, domain = "",

116

host = "", max_renames = 12):

117

"""An Avahi (Zeroconf) service. """

106

host = "", max_renames = 32768):

118

107

self.interface = interface

119

108

self.name = name

120

109

self.type = type

133

122

u" retries, exiting.", rename_count)

134

123

raise AvahiServiceError("Too many renames")

135

124

name = server.GetAlternativeServiceName(name)

136

logger.notice(u"Changing name to %r ...", name)

125

logger.error(u"Changing name to %r ...", name)

126

syslogger.setFormatter(logging.Formatter\

127

('Mandos (%s): %%(levelname)s:'

128

' %%(message)s' % name))

137

129

self.remove()

138

130

self.add()

139

131

self.rename_count += 1

175

167

fingerprint: string (40 or 32 hexadecimal digits); used to

176

168

uniquely identify the client

177

169

secret: bytestring; sent verbatim (over TLS) to client

178

fqdn: string (FQDN); available for use by the checker command

170

host: string; available for use by the checker command

179

171

created: datetime.datetime(); object creation, not client host

180

172

last_checked_ok: datetime.datetime() or None if not yet checked OK

181

173

timeout: datetime.timedelta(); How long from last_checked_ok

221

213

interval = property(lambda self: self._interval,

222

214

_set_interval)

223

215

del _set_interval

224

def __init__(self, name=None, stop_hook=None, fingerprint=None,

225

secret=None, secfile=None, fqdn=None, timeout=None,

226

interval=-1, checker=None):

227

"""Note: the 'checker' argument sets the 'checker_command'

228

attribute and not the 'checker' attribute.."""

216

def __init__(self, name = None, stop_hook=None, config={}):

217

"""Note: the 'checker' key in 'config' sets the

218

'checker_command' attribute and *not* the 'checker'

219

attribute."""

229

220

self.name = name

230

221

logger.debug(u"Creating client %r", self.name)

231

# Uppercase and remove spaces from fingerprint

232

# for later comparison purposes with return value of

233

# the fingerprint() function

234

self.fingerprint = fingerprint.upper().replace(u" ", u"")

222

# Uppercase and remove spaces from fingerprint for later

223

# comparison purposes with return value from the fingerprint()

224

# function

225

self.fingerprint = config["fingerprint"].upper()\

226

.replace(u" ", u"")

235

227

logger.debug(u" Fingerprint: %s", self.fingerprint)

236

if secret:

237

self.secret = secret.decode(u"base64")

238

elif secfile:

239

sf = open(secfile)

228

if "secret" in config:

229

self.secret = config["secret"].decode(u"base64")

230

elif "secfile" in config:

231

sf = open(config["secfile"])

240

232

self.secret = sf.read()

241

233

sf.close()

242

234

else:

243

235

raise TypeError(u"No secret or secfile for client %s"

244

236

% self.name)

245

self.fqdn = fqdn

237

self.host = config.get("host", "")

246

238

self.created = datetime.datetime.now()

247

239

self.last_checked_ok = None

248

self.timeout = string_to_delta(timeout)

249

self.interval = string_to_delta(interval)

240

self.timeout = string_to_delta(config["timeout"])

241

self.interval = string_to_delta(config["interval"])

250

242

self.stop_hook = stop_hook

251

243

self.checker = None

252

244

self.checker_initiator_tag = None

253

245

self.stop_initiator_tag = None

254

246

self.checker_callback_tag = None

255

self.check_command = checker

247

self.check_command = config["checker"]

256

248

def start(self):

257

249

"""Start this client's checker and timeout hooks"""

258

250

# Schedule a new checker to be started an 'interval' from now,

271

263

The possibility that a client might be restarted is left open,

272

264

but not currently used."""

273

265

# If this client doesn't have a secret, it is already stopped.

274

if self.secret:

275

logger.debug(u"Stopping client %s", self.name)

266

if hasattr(self, "secret") and self.secret:

267

logger.info(u"Stopping client %s", self.name)

276

268

self.secret = None

277

269

else:

278

270

return False

297

289

self.checker = None

298

290

if os.WIFEXITED(condition) \

299

291

and (os.WEXITSTATUS(condition) == 0):

300

logger.debug(u"Checker for %(name)s succeeded",

301

vars(self))

292

logger.info(u"Checker for %(name)s succeeded",

293

vars(self))

302

294

self.last_checked_ok = now

303

295

gobject.source_remove(self.stop_initiator_tag)

304

296

self.stop_initiator_tag = gobject.timeout_add\

308

300

logger.warning(u"Checker for %(name)s crashed?",

309

301

vars(self))

310

302

else:

311

logger.debug(u"Checker for %(name)s failed",

312

vars(self))

303

logger.info(u"Checker for %(name)s failed",

304

vars(self))

313

305

def start_checker(self):

314

306

"""Start a new checker subprocess if one is not running.

315

307

If a checker already exists, leave it running and do

325

317

if self.checker is None:

326

318

try:

327

319

# In case check_command has exactly one % operator

328

command = self.check_command % self.fqdn

320

command = self.check_command % self.host

329

321

except TypeError:

330

322

# Escape attributes for the shell

331

323

escaped_attrs = dict((key, re.escape(str(val)))

338

330

u' %s', self.check_command, error)

339

331

return True # Try again later

340

332

try:

341

logger.debug(u"Starting checker %r for %s",

342

command, self.name)

333

logger.info(u"Starting checker %r for %s",

334

command, self.name)

343

335

self.checker = subprocess.Popen(command,

344

336

close_fds=True,

345

337

shell=True, cwd="/")

358

350

self.checker_callback_tag = None

359

351

if getattr(self, "checker", None) is None:

360

352

return

361

logger.debug("Stopping checker for %(name)s", vars(self))

353

logger.debug(u"Stopping checker for %(name)s", vars(self))

362

354

try:

363

355

os.kill(self.checker.pid, signal.SIGTERM)

364

356

#os.sleep(0.5)

396

388

397

389

def fingerprint(openpgp):

398

390

"Convert an OpenPGP bytestring to a hexdigit fingerprint string"

399

# New empty GnuTLS certificate

400

crt = gnutls.library.types.gnutls_openpgp_crt_t()

401

gnutls.library.functions.gnutls_openpgp_crt_init\

402

(ctypes.byref(crt))

403

391

# New GnuTLS "datum" with the OpenPGP public key

404

392

datum = gnutls.library.types.gnutls_datum_t\

405

393

(ctypes.cast(ctypes.c_char_p(openpgp),

406

394

ctypes.POINTER(ctypes.c_ubyte)),

407

395

ctypes.c_uint(len(openpgp)))

396

# New empty GnuTLS certificate

397

crt = gnutls.library.types.gnutls_openpgp_crt_t()

398

gnutls.library.functions.gnutls_openpgp_crt_init\

399

(ctypes.byref(crt))

408

400

# Import the OpenPGP public key into the certificate

409

ret = gnutls.library.functions.gnutls_openpgp_crt_import\

410

(crt,

411

ctypes.byref(datum),

412

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

401

gnutls.library.functions.gnutls_openpgp_crt_import\

402

(crt, ctypes.byref(datum),

403

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

413

404

# New buffer for the fingerprint

414

405

buffer = ctypes.create_string_buffer(20)

415

406

buffer_length = ctypes.c_size_t()

431

422

Note: This will run in its own forked process."""

432

423

433

424

def handle(self):

434

logger.debug(u"TCP connection from: %s",

425

logger.info(u"TCP connection from: %s",

435

426

unicode(self.client_address))

436

427

session = gnutls.connection.ClientSession\

437

428

(self.request, gnutls.connection.X509Credentials())

429

430

line = self.request.makefile().readline()

431

logger.debug(u"Protocol version: %r", line)

432

try:

433

if int(line.strip().split()[0]) > 1:

434

raise RuntimeError

435

except (ValueError, IndexError, RuntimeError), error:

436

logger.error(u"Unknown protocol version: %s", error)

437

return

438

439

# Note: gnutls.connection.X509Credentials is really a generic

439

440

# GnuTLS certificate credentials object so long as no X.509

440

441

# keys are added to it. Therefore, we can use it here despite

453

454

try:

454

455

session.handshake()

455

456

except gnutls.errors.GNUTLSError, error:

456

logger.debug(u"Handshake failed: %s", error)

457

logger.warning(u"Handshake failed: %s", error)

457

458

# Do not run session.bye() here: the session is not

458

459

# established. Just abandon the request.

459

460

return

460

461

try:

461

462

fpr = fingerprint(peer_certificate(session))

462

463

except (TypeError, gnutls.errors.GNUTLSError), error:

463

logger.debug(u"Bad certificate: %s", error)

464

logger.warning(u"Bad certificate: %s", error)

464

465

session.bye()

465

466

return

466

467

logger.debug(u"Fingerprint: %s", fpr)

470

471

client = c

471

472

break

472

473

if not client:

473

logger.debug(u"Client not found for fingerprint: %s", fpr)

474

logger.warning(u"Client not found for fingerprint: %s",

475

fpr)

474

476

session.bye()

475

477

return

476

478

# Have to check if client.still_valid(), since it is possible

477

479

# that the client timed out while establishing the GnuTLS

478

480

# session.

479

481

if not client.still_valid():

480

logger.debug(u"Client %(name)s is invalid", vars(client))

482

logger.warning(u"Client %(name)s is invalid",

483

vars(client))

481

484

session.bye()

482

485

return

483

486

sent_size = 0

518

521

self.settings["interface"])

519

522

except socket.error, error:

520

523

if error[0] == errno.EPERM:

521

logger.warning(u"No permission to"

522

u" bind to interface %s",

523

self.settings["interface"])

524

logger.error(u"No permission to"

525

u" bind to interface %s",

526

self.settings["interface"])

524

527

else:

525

528

raise error

526

529

# Only bind(2) the socket if we really need to.

529

532

in6addr_any = "::"

530

533

self.server_address = (in6addr_any,

531

534

self.server_address[1])

532

elif self.server_address[1] is None:

535

elif not self.server_address[1]:

533

536

self.server_address = (self.server_address[0],

534

537

0)

538

# if self.settings["interface"]:

539

# self.server_address = (self.server_address[0],

540

# 0, # port

541

# 0, # flowinfo

542

# if_nametoindex

543

# (self.settings

544

# ["interface"]))

535

545

return super(type(self), self).server_bind()

536

546

537

547

572

582

def server_state_changed(state):

573

583

"""Derived from the Avahi example code"""

574

584

if state == avahi.SERVER_COLLISION:

575

logger.warning(u"Server name collision")

585

logger.error(u"Server name collision")

576

586

service.remove()

577

587

elif state == avahi.SERVER_RUNNING:

578

588

service.add()

592

602

unicode(error))

593

603

raise AvahiGroupError("State changed: %s", str(error))

594

604

595

def if_nametoindex(interface, _func=[None]):

605

def if_nametoindex(interface):

596

606

"""Call the C function if_nametoindex(), or equivalent"""

597

if _func[0] is not None:

598

return _func[0](interface)

607

global if_nametoindex

599

608

try:

600

609

if "ctypes.util" not in sys.modules:

601

610

import ctypes.util

602

while True:

603

try:

604

libc = ctypes.cdll.LoadLibrary\

605

(ctypes.util.find_library("c"))

606

_func[0] = libc.if_nametoindex

607

return _func[0](interface)

608

except IOError, e:

609

if e != errno.EINTR:

610

raise

611

if_nametoindex = ctypes.cdll.LoadLibrary\

612

(ctypes.util.find_library("c")).if_nametoindex

611

613

except (OSError, AttributeError):

612

614

if "struct" not in sys.modules:

613

615

import struct

614

616

if "fcntl" not in sys.modules:

615

617

import fcntl

616

def the_hard_way(interface):

618

def if_nametoindex(interface):

617

619

"Get an interface index the hard way, i.e. using fcntl()"

618

620

SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h

619

621

s = socket.socket()

622

624

s.close()

623

625

interface_index = struct.unpack("I", ifreq[16:20])[0]

624

626

return interface_index

625

_func[0] = the_hard_way

626

return _func[0](interface)

627

628

629

def daemon(nochdir, noclose):

627

return if_nametoindex(interface)

628

629

630

def daemon(nochdir = False, noclose = False):

630

631

"""See daemon(3). Standard BSD Unix function.

631

632

This should really exist as os.daemon, but it doesn't (yet)."""

632

633

if os.fork():

634

635

os.setsid()

635

636

if not nochdir:

636

637

os.chdir("/")

638

if os.fork():

639

sys.exit()

637

640

if not noclose:

638

641

# Close all standard open file descriptors

639

642

null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)

651

654

global main_loop_started

652

655

main_loop_started = False

653

656

654

parser = OptionParser()

657

parser = OptionParser(version = "Mandos server %s" % version)

655

658

parser.add_option("-i", "--interface", type="string",

656

659

metavar="IF", help="Bind to interface IF")

657

660

parser.add_option("-a", "--address", type="string",

660

663

help="Port number to receive requests on")

661

664

parser.add_option("--check", action="store_true", default=False,

662

665

help="Run self-test")

663

parser.add_option("--debug", action="store_true", default=False,

666

parser.add_option("--debug", action="store_true",

664

667

help="Debug mode; run in foreground and log to"

665

668

" terminal")

666

669

parser.add_option("--priority", type="string", help="GnuTLS"

691

694

# Parse config file for server-global settings

692

695

server_config = ConfigParser.SafeConfigParser(server_defaults)

693

696

del server_defaults

694

server_config.read(os.path.join(options.configdir, "server.conf"))

697

server_config.read(os.path.join(options.configdir, "mandos.conf"))

695

698

server_section = "server"

696

699

# Convert the SafeConfigParser object to a dict

697

700

server_settings = dict(server_config.items(server_section))

710

713

del options

711

714

# Now we have our good server settings in "server_settings"

712

715

716

debug = server_settings["debug"]

717

718

if not debug:

719

syslogger.setLevel(logging.WARNING)

720

721

if server_settings["servicename"] != "Mandos":

722

syslogger.setFormatter(logging.Formatter\

723

('Mandos (%s): %%(levelname)s:'

724

' %%(message)s'

725

% server_settings["servicename"]))

726

713

727

# Parse config file with clients

714

728

client_defaults = { "timeout": "1h",

715

729

"interval": "5m",

716

"checker": "fping -q -- %%(fqdn)s",

730

"checker": "fping -q -- %%(host)s",

717

731

}

718

732

client_config = ConfigParser.SafeConfigParser(client_defaults)

719

733

client_config.read(os.path.join(server_settings["configdir"],

737

751

avahi.DBUS_INTERFACE_SERVER )

738

752

# End of Avahi example code

739

753

740

debug = server_settings["debug"]

741

742

754

if debug:

743

755

console = logging.StreamHandler()

744

756

# console.setLevel(logging.DEBUG)

751

763

def remove_from_clients(client):

752

764

clients.remove(client)

753

765

if not clients:

754

logger.debug(u"No clients left, exiting")

766

logger.critical(u"No clients left, exiting")

755

767

sys.exit()

756

768

757

clients.update(Set(Client(name=section,

769

clients.update(Set(Client(name = section,

758

770

stop_hook = remove_from_clients,

759

**(dict(client_config\

760

.items(section))))

771

config

772

= dict(client_config.items(section)))

761

773

for section in client_config.sections()))

774

if not clients:

775

logger.critical(u"No clients defined")

776

sys.exit(1)

762

777

763

778

if not debug:

764

daemon(False, False)

779

daemon()

780

781

pidfilename = "/var/run/mandos/mandos.pid"

782

pid = os.getpid()

783

try:

784

pidfile = open(pidfilename, "w")

785

pidfile.write(str(pid) + "\n")

786

pidfile.close()

787

del pidfile

788

except IOError, err:

789

logger.error(u"Could not write %s file with PID %d",

790

pidfilename, os.getpid())

765

791

766

792

def cleanup():

767

793

"Cleanup function; run on exit"

794

820

clients=clients)

795

821

# Find out what port we got

796

822

service.port = tcp_server.socket.getsockname()[1]

797

logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"

798

u" scope_id %d" % tcp_server.socket.getsockname())

823

logger.info(u"Now listening on address %r, port %d, flowinfo %d,"

824

u" scope_id %d" % tcp_server.socket.getsockname())

799

825

800

826

#service.interface = tcp_server.socket.getsockname()[3]

801

827

814

840

tcp_server.handle_request\

815

841

(*args[2:], **kwargs) or True)

816

842

817

logger.debug("Starting main loop")

843

logger.debug(u"Starting main loop")

818

844

main_loop_started = True

819

845

main_loop.run()

820

846

except AvahiError, error: