/mandos/trunk : revision 24.1.14

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

# 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".

9

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

10

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

11

# in "main".

12

#

13

# Everything else is

14

61

from dbus.mainloop.glib import DBusGMainLoop

62

import ctypes

63

64

version = "1.0"

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

65

75

66

76

logger = logging.Logger('mandos')

67

77

syslogger = logging.handlers.SysLogHandler\

68

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

69

address = "/dev/log")

78

(facility = logging.handlers.SysLogHandler.LOG_DAEMON)

70

79

syslogger.setFormatter(logging.Formatter\

71

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

80

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

72

81

logger.addHandler(syslogger)

82

del syslogger

73

83

74

84

75

85

class AvahiError(Exception):

86

96

87

97

88

98

class AvahiService(object):

89

"""An Avahi (Zeroconf) service.

90

Attributes:

99

"""

91

100

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

92

101

Used to optionally bind to the specified interface.

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

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

103

113

"""

104

114

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

105

115

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

106

host = "", max_renames = 32768):

116

host = "", max_renames = 12):

117

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

107

118

self.interface = interface

108

119

self.name = name

109

120

self.type = type

122

133

u" retries, exiting.", rename_count)

123

134

raise AvahiServiceError("Too many renames")

124

135

name = server.GetAlternativeServiceName(name)

125

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

126

syslogger.setFormatter(logging.Formatter\

127

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

128

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

136

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

129

137

self.remove()

130

138

self.add()

131

139

self.rename_count += 1

167

175

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

168

176

uniquely identify the client

169

177

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

170

host: string; available for use by the checker command

178

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

171

179

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

172

180

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

173

181

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

213

221

interval = property(lambda self: self._interval,

214

222

_set_interval)

215

223

del _set_interval

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."""

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.."""

220

229

self.name = name

221

230

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

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"")

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"")

227

235

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

228

if "secret" in config:

229

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

230

elif "secfile" in config:

231

sf = open(config["secfile"])

236

if secret:

237

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

238

elif secfile:

239

sf = open(secfile)

232

240

self.secret = sf.read()

233

241

sf.close()

234

242

else:

235

243

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

236

244

% self.name)

237

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

245

self.fqdn = fqdn

238

246

self.created = datetime.datetime.now()

239

247

self.last_checked_ok = None

240

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

241

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

248

self.timeout = string_to_delta(timeout)

249

self.interval = string_to_delta(interval)

242

250

self.stop_hook = stop_hook

243

251

self.checker = None

244

252

self.checker_initiator_tag = None

245

253

self.stop_initiator_tag = None

246

254

self.checker_callback_tag = None

247

self.check_command = config["checker"]

255

self.check_command = checker

248

256

def start(self):

249

257

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

250

258

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

263

271

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

264

272

but not currently used."""

265

273

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

266

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

267

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

274

if self.secret:

275

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

268

276

self.secret = None

269

277

else:

270

278

return False

289

297

self.checker = None

290

298

if os.WIFEXITED(condition) \

291

299

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

292

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

293

vars(self))

300

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

301

vars(self))

294

302

self.last_checked_ok = now

295

303

gobject.source_remove(self.stop_initiator_tag)

296

304

self.stop_initiator_tag = gobject.timeout_add\

300

308

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

301

309

vars(self))

302

310

else:

303

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

304

vars(self))

311

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

312

vars(self))

305

313

def start_checker(self):

306

314

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

307

315

If a checker already exists, leave it running and do

317

325

if self.checker is None:

318

326

try:

319

327

# In case check_command has exactly one % operator

320

command = self.check_command % self.host

328

command = self.check_command % self.fqdn

321

329

except TypeError:

322

330

# Escape attributes for the shell

323

331

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

330

338

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

331

339

return True # Try again later

332

340

try:

333

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

334

command, self.name)

341

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

342

command, self.name)

335

343

self.checker = subprocess.Popen(command,

336

344

close_fds=True,

337

345

shell=True, cwd="/")

350

358

self.checker_callback_tag = None

351

359

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

352

360

return

353

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

361

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

354

362

try:

355

363

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

356

364

#os.sleep(0.5)

388

396

389

397

def fingerprint(openpgp):

390

398

"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))

391

403

# New GnuTLS "datum" with the OpenPGP public key

392

404

datum = gnutls.library.types.gnutls_datum_t\

393

405

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

394

406

ctypes.POINTER(ctypes.c_ubyte)),

395

407

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))

400

408

# Import the OpenPGP public key into the certificate

401

gnutls.library.functions.gnutls_openpgp_crt_import\

402

(crt, ctypes.byref(datum),

403

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

409

ret = gnutls.library.functions.gnutls_openpgp_crt_import\

410

(crt,

411

ctypes.byref(datum),

412

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

404

413

# New buffer for the fingerprint

405

414

buffer = ctypes.create_string_buffer(20)

406

415

buffer_length = ctypes.c_size_t()

422

431

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

423

432

424

433

def handle(self):

425

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

434

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

426

435

unicode(self.client_address))

427

session = gnutls.connection.ClientSession\

428

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

429

436

430

437

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

431

438

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

432

439

try:

436

443

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

437

444

return

438

445

446

session = gnutls.connection.ClientSession\

447

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

439

448

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

440

449

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

441

450

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

454

463

try:

455

464

session.handshake()

456

465

except gnutls.errors.GNUTLSError, error:

457

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

466

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

458

467

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

459

468

# established. Just abandon the request.

460

469

return

461

470

try:

462

471

fpr = fingerprint(peer_certificate(session))

463

472

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

464

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

473

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

465

474

session.bye()

466

475

return

467

476

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

471

480

client = c

472

481

break

473

482

if not client:

474

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

475

fpr)

483

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

476

484

session.bye()

477

485

return

478

486

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

479

487

# that the client timed out while establishing the GnuTLS

480

488

# session.

481

489

if not client.still_valid():

482

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

483

vars(client))

490

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

484

491

session.bye()

485

492

return

486

493

sent_size = 0

521

528

self.settings["interface"])

522

529

except socket.error, error:

523

530

if error[0] == errno.EPERM:

524

logger.error(u"No permission to"

525

u" bind to interface %s",

526

self.settings["interface"])

531

logger.warning(u"No permission to"

532

u" bind to interface %s",

533

self.settings["interface"])

527

534

else:

528

535

raise error

529

536

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

532

539

in6addr_any = "::"

533

540

self.server_address = (in6addr_any,

534

541

self.server_address[1])

535

elif not self.server_address[1]:

542

elif self.server_address[1] is None:

536

543

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

537

544

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"]))

545

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

546

547

582

def server_state_changed(state):

583

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

584

if state == avahi.SERVER_COLLISION:

585

logger.error(u"Server name collision")

585

logger.warning(u"Server name collision")

586

service.remove()

587

elif state == avahi.SERVER_RUNNING:

588

service.add()

627

return if_nametoindex(interface)

628

629

630

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

630

def daemon(nochdir, noclose):

631

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

632

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

633

if os.fork():

635

os.setsid()

636

if not nochdir:

637

os.chdir("/")

638

if os.fork():

639

sys.exit()

640

638

if not noclose:

641

639

# Close all standard open file descriptors

642

640

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

654

652

global main_loop_started

655

653

main_loop_started = False

656

654

657

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

655

parser = OptionParser()

658

656

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

659

657

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

660

658

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

663

661

help="Port number to receive requests on")

664

662

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

665

663

help="Run self-test")

666

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

664

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

667

665

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

668

666

" terminal")

669

667

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

694

692

# Parse config file for server-global settings

695

693

server_config = ConfigParser.SafeConfigParser(server_defaults)

696

694

del server_defaults

697

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

695

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

698

696

server_section = "server"

699

697

# Convert the SafeConfigParser object to a dict

700

698

server_settings = dict(server_config.items(server_section))

713

711

del options

714

712

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

715

713

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

727

714

# Parse config file with clients

728

715

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

729

716

"interval": "5m",

730

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

717

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

731

718

}

732

719

client_config = ConfigParser.SafeConfigParser(client_defaults)

733

720

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

751

738

avahi.DBUS_INTERFACE_SERVER )

752

739

# End of Avahi example code

753

740

741

debug = server_settings["debug"]

742

754

743

if debug:

755

744

console = logging.StreamHandler()

756

745

# console.setLevel(logging.DEBUG)

763

752

def remove_from_clients(client):

764

753

clients.remove(client)

765

754

if not clients:

766

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

755

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

767

756

sys.exit()

768

757

769

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

758

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

770

759

stop_hook = remove_from_clients,

771

config

772

= dict(client_config.items(section)))

760

**(dict(client_config\

761

.items(section))))

773

762

for section in client_config.sections()))

774

if not clients:

775

logger.critical(u"No clients defined")

776

sys.exit(1)

777

763

778

764

if not debug:

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

daemon(False, False)

791

766

792

767

def cleanup():

793

768

"Cleanup function; run on exit"

820

795

clients=clients)

821

796

# Find out what port we got

822

797

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

823

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

824

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

798

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

799

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

825

800

826

801

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

827

802

840

815

tcp_server.handle_request\

841

816

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

842

817

843

logger.debug(u"Starting main loop")

818

logger.debug("Starting main loop")

844

819

main_loop_started = True

845

820

main_loop.run()

846

821

except AvahiError, error: