/mandos/trunk : revision 396

1

#!/usr/bin/python

2

# -*- mode: python; coding: utf-8 -*-

3

#

4

# Mandos Monitor - Control and monitor the Mandos server

5

#

6

7

8

#

9

# This program is free software: you can redistribute it and/or modify

10

# it under the terms of the GNU General Public License as published by

11

# the Free Software Foundation, either version 3 of the License, or

12

# (at your option) any later version.

13

#

14

# This program is distributed in the hope that it will be useful,

15

# but WITHOUT ANY WARRANTY; without even the implied warranty of

16

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

17

# GNU General Public License for more details.

18

#

19

# You should have received a copy of the GNU General Public License

20

# along with this program. If not, see <http://www.gnu.org/licenses/>.

21

#

22

# Contact the authors at <mandos@fukt.bsnet.se>.

23

#

24

25

from __future__ import division, absolute_import, print_function, unicode_literals

26

27

import sys

28

import os

29

import signal

30

31

import datetime

32

33

import urwid.curses_display

34

import urwid

35

36

from dbus.mainloop.glib import DBusGMainLoop

37

import gobject

38

39

import dbus

40

41

import UserList

42

43

import locale

44

45

locale.setlocale(locale.LC_ALL, '')

46

47

import logging

48

logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)

49

50

# Some useful constants

51

domain = 'se.bsnet.fukt'

52

server_interface = domain + '.Mandos'

53

client_interface = domain + '.Mandos.Client'

54

version = "1.2.3"

55

56

# Always run in monochrome mode

57

urwid.curses_display.curses.has_colors = lambda : False

58

59

# Urwid doesn't support blinking, but we want it. Since we have no

60

# use for underline on its own, we make underline also always blink.

61

urwid.curses_display.curses.A_UNDERLINE |= (

62

urwid.curses_display.curses.A_BLINK)

63

64

def isoformat_to_datetime(iso):

65

"Parse an ISO 8601 date string to a datetime.datetime()"

66

if not iso:

67

return None

68

d, t = iso.split("T", 1)

69

year, month, day = d.split("-", 2)

70

hour, minute, second = t.split(":", 2)

71

second, fraction = divmod(float(second), 1)

72

return datetime.datetime(int(year),

73

int(month),

74

int(day),

75

int(hour),

76

int(minute),

77

int(second), # Whole seconds

78

int(fraction*1000000)) # Microseconds

79

80

class MandosClientPropertyCache(object):

81

"""This wraps a Mandos Client D-Bus proxy object, caches the

82

properties and calls a hook function when any of them are

83

changed.

84

"""

85

def __init__(self, proxy_object=None, *args, **kwargs):

86

self.proxy = proxy_object # Mandos Client proxy object

87

88

self.properties = dict()

89

self.proxy.connect_to_signal("PropertyChanged",

90

self.property_changed,

91

client_interface,

92

byte_arrays=True)

93

94

self.properties.update(

95

self.proxy.GetAll(client_interface,

96

dbus_interface = dbus.PROPERTIES_IFACE))

97

98

#XXX This break good super behaviour!

99

# super(MandosClientPropertyCache, self).__init__(

100

# *args, **kwargs)

101

102

def property_changed(self, property=None, value=None):

103

"""This is called whenever we get a PropertyChanged signal

104

It updates the changed property in the "properties" dict.

105

"""

106

# Update properties dict with new value

107

self.properties[property] = value

108

109

110

class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):

111

"""A Mandos Client which is visible on the screen.

112

"""

113

114

def __init__(self, server_proxy_object=None, update_hook=None,

115

delete_hook=None, logger=None, *args, **kwargs):

116

# Called on update

117

self.update_hook = update_hook

118

# Called on delete

119

self.delete_hook = delete_hook

120

# Mandos Server proxy object

121

self.server_proxy_object = server_proxy_object

122

# Logger

123

self.logger = logger

124

125

self._update_timer_callback_tag = None

126

self._update_timer_callback_lock = 0

127

self.last_checker_failed = False

128

129

# The widget shown normally

130

self._text_widget = urwid.Text("")

131

# The widget shown when we have focus

132

self._focus_text_widget = urwid.Text("")

133

super(MandosClientWidget, self).__init__(

134

update_hook=update_hook, delete_hook=delete_hook,

135

*args, **kwargs)

136

self.update()

137

self.opened = False

138

139

last_checked_ok = isoformat_to_datetime(self.properties

140

["LastCheckedOK"])

141

if last_checked_ok is None:

142

self.last_checker_failed = True

143

else:

144

self.last_checker_failed = ((datetime.datetime.utcnow()

145

- last_checked_ok)

146

> datetime.timedelta

147

(milliseconds=

148

self.properties

149

["Interval"]))

150

151

if self.last_checker_failed:

152

self.using_timer(True)

153

154

if self.need_approval:

155

self.using_timer(True)

156

157

self.proxy.connect_to_signal("CheckerCompleted",

158

self.checker_completed,

159

client_interface,

160

byte_arrays=True)

161

self.proxy.connect_to_signal("CheckerStarted",

162

self.checker_started,

163

client_interface,

164

byte_arrays=True)

165

self.proxy.connect_to_signal("GotSecret",

166

self.got_secret,

167

client_interface,

168

byte_arrays=True)

169

self.proxy.connect_to_signal("NeedApproval",

170

self.need_approval,

171

client_interface,

172

byte_arrays=True)

173

self.proxy.connect_to_signal("Rejected",

174

self.rejected,

175

client_interface,

176

byte_arrays=True)

177

178

def property_changed(self, property=None, value=None):

179

super(self, MandosClientWidget).property_changed(property,

180

value)

181

if property == "ApprovalPending":

182

using_timer(bool(value))

183

184

def using_timer(self, flag):

185

"""Call this method with True or False when timer should be

186

activated or deactivated.

187

"""

188

old = self._update_timer_callback_lock

189

if flag:

190

self._update_timer_callback_lock += 1

191

else:

192

self._update_timer_callback_lock -= 1

193

if old == 0 and self._update_timer_callback_lock:

194

self._update_timer_callback_tag = (gobject.timeout_add

195

(1000,

196

self.update_timer))

197

elif old and self._update_timer_callback_lock == 0:

198

gobject.source_remove(self._update_timer_callback_tag)

199

self._update_timer_callback_tag = None

200

201

def checker_completed(self, exitstatus, condition, command):

202

if exitstatus == 0:

203

if self.last_checker_failed:

204

self.last_checker_failed = False

205

self.using_timer(False)

206

#self.logger('Checker for client %s (command "%s")'

207

# ' was successful'

208

# % (self.properties["Name"], command))

209

self.update()

210

return

211

# Checker failed

212

if not self.last_checker_failed:

213

self.last_checker_failed = True

214

self.using_timer(True)

215

if os.WIFEXITED(condition):

216

self.logger('Checker for client %s (command "%s")'

217

' failed with exit code %s'

218

% (self.properties["Name"], command,

219

os.WEXITSTATUS(condition)))

220

elif os.WIFSIGNALED(condition):

221

self.logger('Checker for client %s (command "%s")'

222

' was killed by signal %s'

223

% (self.properties["Name"], command,

224

os.WTERMSIG(condition)))

225

elif os.WCOREDUMP(condition):

226

self.logger('Checker for client %s (command "%s")'

227

' dumped core'

228

% (self.properties["Name"], command))

229

else:

230

self.logger('Checker for client %s completed'

231

' mysteriously')

232

self.update()

233

234

def checker_started(self, command):

235

#self.logger('Client %s started checker "%s"'

236

# % (self.properties["Name"], unicode(command)))

237

pass

238

239

def got_secret(self):

240

self.last_checker_failed = False

241

self.logger('Client %s received its secret'

242

% self.properties["Name"])

243

244

def need_approval(self, timeout, default):

245

if not default:

246

message = 'Client %s needs approval within %s seconds'

247

else:

248

message = 'Client %s will get its secret in %s seconds'

249

self.logger(message

250

% (self.properties["Name"], timeout/1000))

251

self.using_timer(True)

252

253

def rejected(self, reason):

254

self.logger('Client %s was rejected; reason: %s'

255

% (self.properties["Name"], reason))

256

257

def selectable(self):

258

"""Make this a "selectable" widget.

259

This overrides the method from urwid.FlowWidget."""

260

return True

261

262

def rows(self, maxcolrow, focus=False):

263

"""How many rows this widget will occupy might depend on

264

whether we have focus or not.

265

This overrides the method from urwid.FlowWidget"""

266

return self.current_widget(focus).rows(maxcolrow, focus=focus)

267

268

def current_widget(self, focus=False):

269

if focus or self.opened:

270

return self._focus_widget

271

return self._widget

272

273

def update(self):

274

"Called when what is visible on the screen should be updated."

275

# How to add standout mode to a style

276

with_standout = { "normal": "standout",

277

"bold": "bold-standout",

278

"underline-blink":

279

"underline-blink-standout",

280

"bold-underline-blink":

281

"bold-underline-blink-standout",

282

}

283

284

# Rebuild focus and non-focus widgets using current properties

285

286

# Base part of a client. Name!

287

base = ('%(name)s: '

288

% {"name": self.properties["Name"]})

289

if not self.properties["Enabled"]:

290

message = "DISABLED"

291

elif self.properties["ApprovalPending"]:

292

timeout = datetime.timedelta(milliseconds

293

= self.properties

294

["ApprovalDelay"])

295

last_approval_request = isoformat_to_datetime(

296

self.properties["LastApprovalRequest"])

297

if last_approval_request is not None:

298

timer = timeout - (datetime.datetime.utcnow()

299

- last_approval_request)

300

else:

301

timer = datetime.timedelta()

302

if self.properties["ApprovedByDefault"]:

303

message = "Approval in %s. (d)eny?"

304

else:

305

message = "Denial in %s. (a)pprove?"

306

message = message % unicode(timer).rsplit(".", 1)[0]

307

elif self.last_checker_failed:

308

timeout = datetime.timedelta(milliseconds

309

= self.properties

310

["Timeout"])

311

last_ok = isoformat_to_datetime(

312

max((self.properties["LastCheckedOK"]

313

or self.properties["Created"]),

314

self.properties["LastEnabled"]))

315

timer = timeout - (datetime.datetime.utcnow() - last_ok)

316

message = ('A checker has failed! Time until client'

317

' gets disabled: %s'

318

% unicode(timer).rsplit(".", 1)[0])

319

else:

320

message = "enabled"

321

self._text = "%s%s" % (base, message)

322

323

if not urwid.supports_unicode():

324

self._text = self._text.encode("ascii", "replace")

325

textlist = [("normal", self._text)]

326

self._text_widget.set_text(textlist)

327

self._focus_text_widget.set_text([(with_standout[text[0]],

328

text[1])

329

if isinstance(text, tuple)

330

else text

331

for text in textlist])

332

self._widget = self._text_widget

333

self._focus_widget = urwid.AttrWrap(self._focus_text_widget,

334

"standout")

335

# Run update hook, if any

336

if self.update_hook is not None:

337

self.update_hook()

338

339

def update_timer(self):

340

"called by gobject"

341

self.update()

342

return True # Keep calling this

343

344

def delete(self):

345

if self._update_timer_callback_tag is not None:

346

gobject.source_remove(self._update_timer_callback_tag)

347

self._update_timer_callback_tag = None

348

if self.delete_hook is not None:

349

self.delete_hook(self)

350

351

def render(self, maxcolrow, focus=False):

352

"""Render differently if we have focus.

353

This overrides the method from urwid.FlowWidget"""

354

return self.current_widget(focus).render(maxcolrow,

355

focus=focus)

356

357

def keypress(self, maxcolrow, key):

358

"""Handle keys.

359

This overrides the method from urwid.FlowWidget"""

360

if key == "+":

361

self.proxy.Enable(dbus_interface = client_interface)

362

elif key == "-":

363

self.proxy.Disable(dbus_interface = client_interface)

364

elif key == "a":

365

self.proxy.Approve(dbus.Boolean(True, variant_level=1),

366

dbus_interface = client_interface)

367

elif key == "d":

368

self.proxy.Approve(dbus.Boolean(False, variant_level=1),

369

dbus_interface = client_interface)

370

elif key == "R" or key == "_" or key == "ctrl k":

371

self.server_proxy_object.RemoveClient(self.proxy

372

.object_path)

373

elif key == "s":

374

self.proxy.StartChecker(dbus_interface = client_interface)

375

elif key == "S":

376

self.proxy.StopChecker(dbus_interface = client_interface)

377

elif key == "C":

378

self.proxy.CheckedOK(dbus_interface = client_interface)

379

# xxx

380

# elif key == "p" or key == "=":

381

# self.proxy.pause()

382

# elif key == "u" or key == ":":

383

# self.proxy.unpause()

384

# elif key == "RET":

385

# self.open()

386

else:

387

return key

388

389

def property_changed(self, property=None, value=None,

390

*args, **kwargs):

391

"""Call self.update() if old value is not new value.

392

This overrides the method from MandosClientPropertyCache"""

393

property_name = unicode(property)

394

old_value = self.properties.get(property_name)

395

super(MandosClientWidget, self).property_changed(

396

property=property, value=value, *args, **kwargs)

397

if self.properties.get(property_name) != old_value:

398

self.update()

399

400

401

class ConstrainedListBox(urwid.ListBox):

402

"""Like a normal urwid.ListBox, but will consume all "up" or

403

"down" key presses, thus not allowing any containing widgets to

404

use them as an excuse to shift focus away from this widget.

405

"""

406

def keypress(self, maxcolrow, key):

407

ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)

408

if ret in ("up", "down"):

409

return

410

return ret

411

412

413

class UserInterface(object):

414

"""This is the entire user interface - the whole screen

415

with boxes, lists of client widgets, etc.

416

"""

417

def __init__(self, max_log_length=1000):

418

DBusGMainLoop(set_as_default=True)

419

420

self.screen = urwid.curses_display.Screen()

421

422

self.screen.register_palette((

423

("normal",

424

"default", "default", None),

425

("bold",

426

"default", "default", "bold"),

427

("underline-blink",

428

"default", "default", "underline"),

429

("standout",

430

"default", "default", "standout"),

431

("bold-underline-blink",

432

"default", "default", ("bold", "underline")),

433

("bold-standout",

434

"default", "default", ("bold", "standout")),

435

("underline-blink-standout",

436

"default", "default", ("underline", "standout")),

437

("bold-underline-blink-standout",

438

"default", "default", ("bold", "underline",

439

"standout")),

440

))

441

442

if urwid.supports_unicode():

443

self.divider = "─" # \u2500

444

#self.divider = "━" # \u2501

445

else:

446

#self.divider = "-" # \u002d

447

self.divider = "_" # \u005f

448

449

self.screen.start()

450

451

self.size = self.screen.get_cols_rows()

452

453

self.clients = urwid.SimpleListWalker([])

454

self.clients_dict = {}

455

456

# We will add Text widgets to this list

457

self.log = []

458

self.max_log_length = max_log_length

459

460

# We keep a reference to the log widget so we can remove it

461

# from the ListWalker without it getting destroyed

462

self.logbox = ConstrainedListBox(self.log)

463

464

# This keeps track of whether self.uilist currently has

465

# self.logbox in it or not

466

self.log_visible = True

467

self.log_wrap = "any"

468

469

self.rebuild()

470

self.log_message_raw(("bold",

471

"Mandos Monitor version " + version))

472

self.log_message_raw(("bold",

473

"q: Quit ?: Help"))

474

475

self.busname = domain + '.Mandos'

476

self.main_loop = gobject.MainLoop()

477

self.bus = dbus.SystemBus()

478

mandos_dbus_objc = self.bus.get_object(

479

self.busname, "/", follow_name_owner_changes=True)

480

self.mandos_serv = dbus.Interface(mandos_dbus_objc,

481

dbus_interface

482

= server_interface)

483

try:

484

mandos_clients = (self.mandos_serv

485

.GetAllClientsWithProperties())

486

except dbus.exceptions.DBusException:

487

mandos_clients = dbus.Dictionary()

488

489

(self.mandos_serv

490

.connect_to_signal("ClientRemoved",

491

self.find_and_remove_client,

492

dbus_interface=server_interface,

493

byte_arrays=True))

494

(self.mandos_serv

495

.connect_to_signal("ClientAdded",

496

self.add_new_client,

497

dbus_interface=server_interface,

498

byte_arrays=True))

499

(self.mandos_serv

500

.connect_to_signal("ClientNotFound",

501

self.client_not_found,

502

dbus_interface=server_interface,

503

byte_arrays=True))

504

for path, client in mandos_clients.iteritems():

505

client_proxy_object = self.bus.get_object(self.busname,

506

path)

507

self.add_client(MandosClientWidget(server_proxy_object

508

=self.mandos_serv,

509

proxy_object

510

=client_proxy_object,

511

properties=client,

512

update_hook

513

=self.refresh,

514

delete_hook

515

=self.remove_client,

516

logger

517

=self.log_message),

518

path=path)

519

520

def client_not_found(self, fingerprint, address):

521

self.log_message(("Client with address %s and fingerprint %s"

522

" could not be found" % (address,

523

fingerprint)))

524

525

def rebuild(self):

526

"""This rebuilds the User Interface.

527

Call this when the widget layout needs to change"""

528

self.uilist = []

529

#self.uilist.append(urwid.ListBox(self.clients))

530

self.uilist.append(urwid.Frame(ConstrainedListBox(self.

531

clients),

532

#header=urwid.Divider(),

533

header=None,

534

footer=

535

urwid.Divider(div_char=

536

self.divider)))

537

if self.log_visible:

538

self.uilist.append(self.logbox)

539

pass

540

self.topwidget = urwid.Pile(self.uilist)

541

542

def log_message(self, message):

543

timestamp = datetime.datetime.now().isoformat()

544

self.log_message_raw(timestamp + ": " + message)

545

546

def log_message_raw(self, markup):

547

"""Add a log message to the log buffer."""

548

self.log.append(urwid.Text(markup, wrap=self.log_wrap))

549

if (self.max_log_length

550

and len(self.log) > self.max_log_length):

551

del self.log[0:len(self.log)-self.max_log_length-1]

552

self.logbox.set_focus(len(self.logbox.body.contents),

553

coming_from="above")

554

self.refresh()

555

556

def toggle_log_display(self):

557

"""Toggle visibility of the log buffer."""

558

self.log_visible = not self.log_visible

559

self.rebuild()

560

#self.log_message("Log visibility changed to: "

561

# + unicode(self.log_visible))

562

563

def change_log_display(self):

564

"""Change type of log display.

565

Currently, this toggles wrapping of text lines."""

566

if self.log_wrap == "clip":

567

self.log_wrap = "any"

568

else:

569

self.log_wrap = "clip"

570

for textwidget in self.log:

571

textwidget.set_wrap_mode(self.log_wrap)

572

#self.log_message("Wrap mode: " + self.log_wrap)

573

574

def find_and_remove_client(self, path, name):

575

"""Find an client from its object path and remove it.

576

577

This is connected to the ClientRemoved signal from the

578

Mandos server object."""

579

try:

580

client = self.clients_dict[path]

581

except KeyError:

582

# not found?

583

return

584

self.remove_client(client, path)

585

586

def add_new_client(self, path):

587

client_proxy_object = self.bus.get_object(self.busname, path)

588

self.add_client(MandosClientWidget(server_proxy_object

589

=self.mandos_serv,

590

proxy_object

591

=client_proxy_object,

592

update_hook

593

=self.refresh,

594

delete_hook

595

=self.remove_client,

596

logger

597

=self.log_message),

598

path=path)

599

600

def add_client(self, client, path=None):

601

self.clients.append(client)

602

if path is None:

603

path = client.proxy.object_path

604

self.clients_dict[path] = client

605

self.clients.sort(None, lambda c: c.properties["Name"])

606

self.refresh()

607

608

def remove_client(self, client, path=None):

609

self.clients.remove(client)

610

if path is None:

611

path = client.proxy.object_path

612

del self.clients_dict[path]

613

if not self.clients_dict:

614

# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker

615

# is completely emptied, we need to recreate it.

616

self.clients = urwid.SimpleListWalker([])

617

self.rebuild()

618

self.refresh()

619

620

def refresh(self):

621

"""Redraw the screen"""

622

canvas = self.topwidget.render(self.size, focus=True)

623

self.screen.draw_screen(self.size, canvas)

624

625

def run(self):

626

"""Start the main loop and exit when it's done."""

627

self.refresh()

628

self._input_callback_tag = (gobject.io_add_watch

629

(sys.stdin.fileno(),

630

gobject.IO_IN,

631

self.process_input))

632

self.main_loop.run()

633

# Main loop has finished, we should close everything now

634

gobject.source_remove(self._input_callback_tag)

635

self.screen.stop()

636

637

def stop(self):

638

self.main_loop.quit()

639

640

def process_input(self, source, condition):

641

keys = self.screen.get_input()

642

translations = { "ctrl n": "down", # Emacs

643

"ctrl p": "up", # Emacs

644

"ctrl v": "page down", # Emacs

645

"meta v": "page up", # Emacs

646

" ": "page down", # less

647

"f": "page down", # less

648

"b": "page up", # less

649

"j": "down", # vi

650

"k": "up", # vi

651

}

652

for key in keys:

653

try:

654

key = translations[key]

655

except KeyError: # :-)

656

pass

657

658

if key == "q" or key == "Q":

659

self.stop()

660

break

661

elif key == "window resize":

662

self.size = self.screen.get_cols_rows()

663

self.refresh()

664

elif key == "\f": # Ctrl-L

665

self.refresh()

666

elif key == "l" or key == "D":

667

self.toggle_log_display()

668

self.refresh()

669

elif key == "w" or key == "i":

670

self.change_log_display()

671

self.refresh()

672

elif key == "?" or key == "f1" or key == "esc":

673

if not self.log_visible:

674

self.log_visible = True

675

self.rebuild()

676

self.log_message_raw(("bold",

677

" ".

678

join(("q: Quit",

679

"?: Help",

680

"l: Log window toggle",

681

"TAB: Switch window",

682

"w: Wrap (log)"))))

683

self.log_message_raw(("bold",

684

" "

685

.join(("Clients:",

686

"+: Enable",

687

"-: Disable",

688

"R: Remove",

689

"s: Start new checker",

690

"S: Stop checker",

691

"C: Checker OK",

692

"a: Approve",

693

"d: Deny"))))

694

self.refresh()

695

elif key == "tab":

696

if self.topwidget.get_focus() is self.logbox:

697

self.topwidget.set_focus(0)

698

else:

699

self.topwidget.set_focus(self.logbox)

700

self.refresh()

701

#elif (key == "end" or key == "meta >" or key == "G"

702

# or key == ">"):

703

# pass # xxx end-of-buffer

704

#elif (key == "home" or key == "meta <" or key == "g"

705

# or key == "<"):

706

# pass # xxx beginning-of-buffer

707

#elif key == "ctrl e" or key == "$":

708

# pass # xxx move-end-of-line

709

#elif key == "ctrl a" or key == "^":

710

# pass # xxx move-beginning-of-line

711

#elif key == "ctrl b" or key == "meta (" or key == "h":

712

# pass # xxx left

713

#elif key == "ctrl f" or key == "meta )" or key == "l":

714

# pass # xxx right

715

#elif key == "a":

716

# pass # scroll up log

717

#elif key == "z":

718

# pass # scroll down log

719

elif self.topwidget.selectable():

720

self.topwidget.keypress(self.size, key)

721

self.refresh()

722

return True

723

724

ui = UserInterface()

725

try:

726

ui.run()

727

except KeyboardInterrupt:

728

ui.screen.stop()

729

except Exception, e:

730

ui.log_message(unicode(e))

731

ui.screen.stop()

732

raise