/mandos/release : revision 24.1.32

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

75

64

76

65

logger = logging.Logger('mandos')

77

66

syslogger = logging.handlers.SysLogHandler\

78

(facility = logging.handlers.SysLogHandler.LOG_DAEMON)

67

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

68

address = "/dev/log")

79

69

syslogger.setFormatter(logging.Formatter\

80

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

70

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

81

71

logger.addHandler(syslogger)

82

del syslogger

83

72

84

73

85

74

class AvahiError(Exception):

96

85

97

86

98

87

class AvahiService(object):

99

"""

88

"""An Avahi (Zeroconf) service.

89

Attributes:

100

90

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

101

91

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

92

name: string; Example: 'Mandos'

93

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

94

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

95

port: integer; what port to announce

96

TXT: list of strings; TXT record for the service

97

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

98

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

99

max_renames: integer; maximum number of renames

100

rename_count: integer; counter so we only rename after collisions

101

a sensible number of times

113

102

"""

114

103

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

115

104

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

116

host = "", max_renames = 12):

117

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

105

host = "", max_renames = 32768):

118

106

self.interface = interface

119

107

self.name = name

120

108

self.type = type

133

121

u" retries, exiting.", rename_count)

134

122

raise AvahiServiceError("Too many renames")

135

123

name = server.GetAlternativeServiceName(name)

136

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

124

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

125

syslogger.setFormatter(logging.Formatter\

126

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

127

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

137

128

self.remove()

138

129

self.add()

139

130

self.rename_count += 1

175

166

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

176

167

uniquely identify the client

177

168

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

178

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

169

host: string; available for use by the checker command

179

170

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

180

171

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

181

172

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

221

212

interval = property(lambda self: self._interval,

222

213

_set_interval)

223

214

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

215

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

216

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

217

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

218

attribute."""

229

219

self.name = name

230

220

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

221

# Uppercase and remove spaces from fingerprint for later

222

# comparison purposes with return value from the fingerprint()

223

# function

224

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

225

.replace(u" ", u"")

235

226

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

236

if secret:

237

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

238

elif secfile:

239

sf = open(secfile)

227

if "secret" in config:

228

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

229

elif "secfile" in config:

230

sf = open(config["secfile"])

240

231

self.secret = sf.read()

241

232

sf.close()

242

233

else:

243

234

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

244

235

% self.name)

245

self.fqdn = fqdn

236

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

246

237

self.created = datetime.datetime.now()

247

238

self.last_checked_ok = None

248

self.timeout = string_to_delta(timeout)

249

self.interval = string_to_delta(interval)

239

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

240

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

250

241

self.stop_hook = stop_hook

251

242

self.checker = None

252

243

self.checker_initiator_tag = None

253

244

self.stop_initiator_tag = None

254

245

self.checker_callback_tag = None

255

self.check_command = checker

246

self.check_command = config["checker"]

256

247

def start(self):

257

248

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

258

249

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

271

262

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

272

263

but not currently used."""

273

264

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

265

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

266

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

276

267

self.secret = None

277

268

else:

278

269

return False

297

288

self.checker = None

298

289

if os.WIFEXITED(condition) \

299

290

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

300

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

301

vars(self))

291

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

292

vars(self))

302

293

self.last_checked_ok = now

303

294

gobject.source_remove(self.stop_initiator_tag)

304

295

self.stop_initiator_tag = gobject.timeout_add\

308

299

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

309

300

vars(self))

310

301

else:

311

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

312

vars(self))

302

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

303

vars(self))

313

304

def start_checker(self):

314

305

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

315

306

If a checker already exists, leave it running and do

325

316

if self.checker is None:

326

317

try:

327

318

# In case check_command has exactly one % operator

328

command = self.check_command % self.fqdn

319

command = self.check_command % self.host

329

320

except TypeError:

330

321

# Escape attributes for the shell

331

322

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

338

329

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

339

330

return True # Try again later

340

331

try:

341

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

342

command, self.name)

332

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

333

command, self.name)

343

334

self.checker = subprocess.Popen(command,

344

335

close_fds=True,

345

336

shell=True, cwd="/")

358

349

self.checker_callback_tag = None

359

350

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

360

351

return

361

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

352

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

362

353

try:

363

354

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

364

355

#os.sleep(0.5)

396

387

397

388

def fingerprint(openpgp):

398

389

"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

390

# New GnuTLS "datum" with the OpenPGP public key

404

391

datum = gnutls.library.types.gnutls_datum_t\

405

392

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

406

393

ctypes.POINTER(ctypes.c_ubyte)),

407

394

ctypes.c_uint(len(openpgp)))

395

# New empty GnuTLS certificate

396

crt = gnutls.library.types.gnutls_openpgp_crt_t()

397

gnutls.library.functions.gnutls_openpgp_crt_init\

398

(ctypes.byref(crt))

408

399

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

400

gnutls.library.functions.gnutls_openpgp_crt_import\

401

(crt, ctypes.byref(datum),

402

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

413

403

# New buffer for the fingerprint

414

404

buffer = ctypes.create_string_buffer(20)

415

405

buffer_length = ctypes.c_size_t()

431

421

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

432

422

433

423

def handle(self):

434

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

424

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

435

425

unicode(self.client_address))

436

426

session = gnutls.connection.ClientSession\

437

427

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

428

429

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

430

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

431

try:

432

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

433

raise RuntimeError

434

except (ValueError, IndexError, RuntimeError), error:

435

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

436

return

437

438

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

439

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

440

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

453

try:

454

session.handshake()

455

except gnutls.errors.GNUTLSError, error:

456

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

456

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

457

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

458

# established. Just abandon the request.

459

return

460

try:

461

fpr = fingerprint(peer_certificate(session))

462

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

463

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

463

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

464

session.bye()

465

return

466

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

470

client = c

471

break

472

if not client:

473

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

473

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

474

fpr)

474

475

session.bye()

475

476

return

476

477

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

477

478

# that the client timed out while establishing the GnuTLS

478

479

# session.

479

480

if not client.still_valid():

480

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

481

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

482

vars(client))

481

483

session.bye()

482

484

return

483

485

sent_size = 0

518

520

self.settings["interface"])

519

521

except socket.error, error:

520

522

if error[0] == errno.EPERM:

521

logger.warning(u"No permission to"

522

u" bind to interface %s",

523

self.settings["interface"])

523

logger.error(u"No permission to"

524

u" bind to interface %s",

525

self.settings["interface"])

524

526

else:

525

527

raise error

526

528

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

529

531

in6addr_any = "::"

530

532

self.server_address = (in6addr_any,

531

533

self.server_address[1])

532

elif self.server_address[1] is None:

534

elif not self.server_address[1]:

533

535

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

534

536

0)

537

# if self.settings["interface"]:

538

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

539

# 0, # port

540

# 0, # flowinfo

541

# if_nametoindex

542

# (self.settings

543

# ["interface"]))

535

544

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

536

545

537

546

572

581

def server_state_changed(state):

573

582

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

574

583

if state == avahi.SERVER_COLLISION:

575

logger.warning(u"Server name collision")

584

logger.error(u"Server name collision")

576

585

service.remove()

577

586

elif state == avahi.SERVER_RUNNING:

578

587

service.add()

592

601

unicode(error))

593

602

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

594

603

595

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

604

def if_nametoindex(interface):

596

605

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

597

if _func[0] is not None:

598

return _func[0](interface)

606

global if_nametoindex

599

607

try:

600

608

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

601

609

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

610

if_nametoindex = ctypes.cdll.LoadLibrary\

611

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

611

612

except (OSError, AttributeError):

612

613

if "struct" not in sys.modules:

613

614

import struct

614

615

if "fcntl" not in sys.modules:

615

616

import fcntl

616

def the_hard_way(interface):

617

def if_nametoindex(interface):

617

618

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

618

619

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

619

620

s = socket.socket()

622

623

s.close()

623

624

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

624

625

return interface_index

625

_func[0] = the_hard_way

626

return _func[0](interface)

627

628

629

def daemon(nochdir, noclose):

626

return if_nametoindex(interface)

627

628

629

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

630

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

631

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

632

if os.fork():

634

os.setsid()

635

if not nochdir:

636

os.chdir("/")

637

if os.fork():

638

sys.exit()

637

639

if not noclose:

638

640

# Close all standard open file descriptors

639

641

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

660

662

help="Port number to receive requests on")

661

663

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

662

664

help="Run self-test")

663

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

665

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

664

666

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

665

667

" terminal")

666

668

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

691

693

# Parse config file for server-global settings

692

694

server_config = ConfigParser.SafeConfigParser(server_defaults)

693

695

del server_defaults

694

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

696

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

695

697

server_section = "server"

696

698

# Convert the SafeConfigParser object to a dict

697

699

server_settings = dict(server_config.items(server_section))

710

712

del options

711

713

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

712

714

715

debug = server_settings["debug"]

716

717

if not debug:

718

syslogger.setLevel(logging.WARNING)

719

720

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

721

syslogger.setFormatter(logging.Formatter\

722

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

723

' %%(message)s'

724

% server_settings["servicename"]))

725

713

726

# Parse config file with clients

714

727

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

715

728

"interval": "5m",

716

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

729

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

717

730

}

718

731

client_config = ConfigParser.SafeConfigParser(client_defaults)

719

732

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

737

750

avahi.DBUS_INTERFACE_SERVER )

738

751

# End of Avahi example code

739

752

740

debug = server_settings["debug"]

741

742

753

if debug:

743

754

console = logging.StreamHandler()

744

755

# console.setLevel(logging.DEBUG)

751

762

def remove_from_clients(client):

752

763

clients.remove(client)

753

764

if not clients:

754

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

765

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

755

766

sys.exit()

756

767

757

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

768

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

758

769

stop_hook = remove_from_clients,

759

**(dict(client_config\

760

.items(section))))

770

config

771

= dict(client_config.items(section)))

761

772

for section in client_config.sections()))

773

if not clients:

774

logger.critical(u"No clients defined")

775

sys.exit(1)

762

776

763

777

if not debug:

764

daemon(False, False)

778

daemon()

779

780

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

781

pid = os.getpid()

782

try:

783

pidfile = open(pidfilename, "w")

784

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

785

pidfile.close()

786

del pidfile

787

except IOError, err:

788

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

789

pidfilename, os.getpid())

765

790

766

791

def cleanup():

767

792

"Cleanup function; run on exit"

794

819

clients=clients)

795

820

# Find out what port we got

796

821

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

822

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

823

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

799

824

800

825

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

801

826

814

839

tcp_server.handle_request\

815

840

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

816

841

817

logger.debug("Starting main loop")

842

logger.debug(u"Starting main loop")

818

843

main_loop_started = True

819

844

main_loop.run()

820

845

except AvahiError, error: