/mandos/trunk : revision 1011

1

#!/usr/bin/python

2

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

3

4

from __future__ import division

2

# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-

3

#

4

# Mandos Monitor - Control and monitor the Mandos server

5

#

6

7

8

#

9

# This file is part of Mandos.

10

#

11

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

12

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

13

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

14

# (at your option) any later version.

15

#

16

# Mandos is distributed in the hope that it will be useful, but

17

# WITHOUT ANY WARRANTY; without even the implied warranty of

18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

19

# GNU General Public License for more details.

20

#

21

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

22

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

23

#

24

# Contact the authors at <mandos@recompile.se>.

25

#

26

27

from __future__ import (division, absolute_import, print_function,

28

unicode_literals)

29

30

try:

31

from future_builtins import *

32

except ImportError:

33

pass

34

5

35

import sys

6

import dbus

7

from optparse import OptionParser

36

import argparse

8

37

import locale

9

38

import datetime

10

39

import re

11

12

locale.setlocale(locale.LC_ALL, u'')

13

14

tablewords = {

15

'name': u'Name',

16

'enabled': u'Enabled',

17

'timeout': u'Timeout',

18

'last_checked_ok': u'Last Successful Check',

19

'created': u'Created',

20

'interval': u'Interval',

21

'host': u'Host',

22

'fingerprint': u'Fingerprint',

23

'checker_running': u'Check Is Running',

24

'last_enabled': u'Last Enabled',

25

'checker': u'Checker',

26

}

27

defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok',

28

'checker')

29

busname = 'org.mandos-system.Mandos'

30

server_path = '/Mandos'

31

server_interface = 'org.mandos_system.Mandos'

32

client_interface = 'org.mandos_system.Mandos.Client'

33

version = "1.0.5"

34

35

bus = dbus.SystemBus()

36

mandos_dbus_objc = bus.get_object(busname, server_path)

37

mandos_serv = dbus.Interface(mandos_dbus_objc,

38

dbus_interface = server_interface)

39

mandos_clients = mandos_serv.GetAllClientsWithProperties()

40

41

def datetime_to_milliseconds(dt):

42

"Return the 'timeout' attribute in milliseconds"

43

return ((dt.days * 24 * 60 * 60 * 1000)

44

+ (dt.seconds * 1000)

45

+ (dt.microseconds // 1000))

40

import os

41

import collections

42

import json

43

import unittest

44

import logging

45

46

import dbus

47

48

# Show warnings by default

49

if not sys.warnoptions:

50

import warnings

51

warnings.simplefilter("default")

52

53

log = logging.getLogger(sys.argv[0])

54

logging.basicConfig(level="INFO", # Show info level messages

55

format="%(message)s") # Show basic log messages

56

57

logging.captureWarnings(True) # Show warnings via the logging system

58

59

if sys.version_info.major == 2:

60

str = unicode

61

62

locale.setlocale(locale.LC_ALL, "")

63

64

domain = "se.recompile"

65

busname = domain + ".Mandos"

66

server_path = "/"

67

server_interface = domain + ".Mandos"

68

client_interface = domain + ".Mandos.Client"

69

version = "1.8.3"

70

71

72

try:

73

dbus.OBJECT_MANAGER_IFACE

74

except AttributeError:

75

dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"

76

46

77

47

78

def milliseconds_to_string(ms):

48

79

td = datetime.timedelta(0, 0, 0, ms)

49

return "%s%02d:%02d:%02d" % (("%dT" % td.days) if td.days else "", # days

50

td.seconds // 3600, # hours

51

(td.seconds % 3600) // 60, # minutes

52

(td.seconds % 60)) # seconds

80

return ("{days}{hours:02}:{minutes:02}:{seconds:02}"

81

.format(days="{}T".format(td.days) if td.days else "",

82

hours=td.seconds // 3600,

83

minutes=(td.seconds % 3600) // 60,

84

seconds=td.seconds % 60))

85

86

87

def rfc3339_duration_to_delta(duration):

88

"""Parse an RFC 3339 "duration" and return a datetime.timedelta

89

90

>>> rfc3339_duration_to_delta("P7D")

91

datetime.timedelta(7)

92

>>> rfc3339_duration_to_delta("PT60S")

93

datetime.timedelta(0, 60)

94

>>> rfc3339_duration_to_delta("PT60M")

95

datetime.timedelta(0, 3600)

96

>>> rfc3339_duration_to_delta("P60M")

97

datetime.timedelta(1680)

98

>>> rfc3339_duration_to_delta("PT24H")

99

datetime.timedelta(1)

100

>>> rfc3339_duration_to_delta("P1W")

101

datetime.timedelta(7)

102

>>> rfc3339_duration_to_delta("PT5M30S")

103

datetime.timedelta(0, 330)

104

>>> rfc3339_duration_to_delta("P1DT3M20S")

105

datetime.timedelta(1, 200)

106

>>> # Can not be empty:

107

>>> rfc3339_duration_to_delta("")

108

Traceback (most recent call last):

109

...

110

ValueError: Invalid RFC 3339 duration: u''

111

>>> # Must start with "P":

112

>>> rfc3339_duration_to_delta("1D")

113

Traceback (most recent call last):

114

...

115

ValueError: Invalid RFC 3339 duration: u'1D'

116

>>> # Must use correct order

117

>>> rfc3339_duration_to_delta("PT1S2M")

118

Traceback (most recent call last):

119

...

120

ValueError: Invalid RFC 3339 duration: u'PT1S2M'

121

>>> # Time needs time marker

122

>>> rfc3339_duration_to_delta("P1H2S")

123

Traceback (most recent call last):

124

...

125

ValueError: Invalid RFC 3339 duration: u'P1H2S'

126

>>> # Weeks can not be combined with anything else

127

>>> rfc3339_duration_to_delta("P1D2W")

128

Traceback (most recent call last):

129

...

130

ValueError: Invalid RFC 3339 duration: u'P1D2W'

131

>>> rfc3339_duration_to_delta("P2W2H")

132

Traceback (most recent call last):

133

...

134

ValueError: Invalid RFC 3339 duration: u'P2W2H'

135

"""

136

137

# Parsing an RFC 3339 duration with regular expressions is not

138

# possible - there would have to be multiple places for the same

139

# values, like seconds. The current code, while more esoteric, is

140

# cleaner without depending on a parsing library. If Python had a

141

# built-in library for parsing we would use it, but we'd like to

142

# avoid excessive use of external libraries.

143

144

# New type for defining tokens, syntax, and semantics all-in-one

145

Token = collections.namedtuple("Token", (

146

"regexp", # To match token; if "value" is not None, must have

147

# a "group" containing digits

148

"value", # datetime.timedelta or None

149

"followers")) # Tokens valid after this token

150

# RFC 3339 "duration" tokens, syntax, and semantics; taken from

151

# the "duration" ABNF definition in RFC 3339, Appendix A.

152

token_end = Token(re.compile(r"$"), None, frozenset())

153

token_second = Token(re.compile(r"(\d+)S"),

154

datetime.timedelta(seconds=1),

155

frozenset((token_end, )))

156

token_minute = Token(re.compile(r"(\d+)M"),

157

datetime.timedelta(minutes=1),

158

frozenset((token_second, token_end)))

159

token_hour = Token(re.compile(r"(\d+)H"),

160

datetime.timedelta(hours=1),

161

frozenset((token_minute, token_end)))

162

token_time = Token(re.compile(r"T"),

163

None,

164

frozenset((token_hour, token_minute,

165

token_second)))

166

token_day = Token(re.compile(r"(\d+)D"),

167

datetime.timedelta(days=1),

168

frozenset((token_time, token_end)))

169

token_month = Token(re.compile(r"(\d+)M"),

170

datetime.timedelta(weeks=4),

171

frozenset((token_day, token_end)))

172

token_year = Token(re.compile(r"(\d+)Y"),

173

datetime.timedelta(weeks=52),

174

frozenset((token_month, token_end)))

175

token_week = Token(re.compile(r"(\d+)W"),

176

datetime.timedelta(weeks=1),

177

frozenset((token_end, )))

178

token_duration = Token(re.compile(r"P"), None,

179

frozenset((token_year, token_month,

180

token_day, token_time,

181

token_week)))

182

# Define starting values:

183

# Value so far

184

value = datetime.timedelta()

185

found_token = None

186

# Following valid tokens

187

followers = frozenset((token_duration, ))

188

# String left to parse

189

s = duration

190

# Loop until end token is found

191

while found_token is not token_end:

192

# Search for any currently valid tokens

193

for token in followers:

194

match = token.regexp.match(s)

195

if match is not None:

196

# Token found

197

if token.value is not None:

198

# Value found, parse digits

199

factor = int(match.group(1), 10)

200

# Add to value so far

201

value += factor * token.value

202

# Strip token from string

203

s = token.regexp.sub("", s, 1)

204

# Go to found token

205

found_token = token

206

# Set valid next tokens

207

followers = found_token.followers

208

break

209

else:

210

# No currently valid tokens were found

211

raise ValueError("Invalid RFC 3339 duration: {!r}"

212

.format(duration))

213

# End token found

214

return value

53

215

54

216

55

217

def string_to_delta(interval):

56

"""Parse a string and return a datetime.timedelta

57

58

>>> string_to_delta('7d')

218

"""Parse a string and return a datetime.timedelta"""

219

220

try:

221

return rfc3339_duration_to_delta(interval)

222

except ValueError as e:

223

log.warning("%s - Parsing as pre-1.6.1 interval instead",

224

' '.join(e.args))

225

return parse_pre_1_6_1_interval(interval)

226

227

228

def parse_pre_1_6_1_interval(interval):

229

"""Parse an interval string as documented by Mandos before 1.6.1,

230

and return a datetime.timedelta

231

232

>>> parse_pre_1_6_1_interval('7d')

59

233

datetime.timedelta(7)

60

>>> string_to_delta('60s')

234

>>> parse_pre_1_6_1_interval('60s')

61

235

datetime.timedelta(0, 60)

62

>>> string_to_delta('60m')

236

>>> parse_pre_1_6_1_interval('60m')

63

237

datetime.timedelta(0, 3600)

64

>>> string_to_delta('24h')

238

>>> parse_pre_1_6_1_interval('24h')

65

239

datetime.timedelta(1)

66

>>> string_to_delta(u'1w')

240

>>> parse_pre_1_6_1_interval('1w')

67

241

datetime.timedelta(7)

68

>>> string_to_delta('5m 30s')

242

>>> parse_pre_1_6_1_interval('5m 30s')

69

243

datetime.timedelta(0, 330)

244

>>> parse_pre_1_6_1_interval('')

245

datetime.timedelta(0)

246

>>> # Ignore unknown characters, allow any order and repetitions

247

>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')

248

datetime.timedelta(2, 480, 18000)

249

70

250

"""

71

timevalue = datetime.timedelta(0)

72

regexp = re.compile("\d+[dsmhw]")

73

74

for s in regexp.findall(interval):

75

try:

76

suffix = unicode(s[-1])

77

value = int(s[:-1])

78

if suffix == u"d":

79

delta = datetime.timedelta(value)

80

elif suffix == u"s":

81

delta = datetime.timedelta(0, value)

82

elif suffix == u"m":

83

delta = datetime.timedelta(0, 0, 0, 0, value)

84

elif suffix == u"h":

85

delta = datetime.timedelta(0, 0, 0, 0, 0, value)

86

elif suffix == u"w":

87

delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)

88

else:

89

raise ValueError

90

except (ValueError, IndexError):

91

raise ValueError

92

timevalue += delta

93

return timevalue

94

95

def print_clients(clients):

96

def valuetostring(value, keyword):

97

if type(value) is dbus.Boolean:

98

return u"Yes" if value else u"No"

99

if keyword in ("timeout", "interval"):

100

return milliseconds_to_string(value)

101

return unicode(value)

102

103

format_string = u' '.join(u'%%-%ds' %

104

max(len(tablewords[key]),

105

max(len(valuetostring(client[key], key))

106

for client in

107

clients))

108

for key in keywords)

109

print format_string % tuple(tablewords[key] for key in keywords)

110

for client in clients:

111

print format_string % tuple(valuetostring(client[key], key)

112

for key in keywords)

113

114

parser = OptionParser(version = "%%prog %s" % version)

115

parser.add_option("-a", "--all", action="store_true",

116

help="Print all fields")

117

parser.add_option("-e", "--enable", action="store_true",

118

help="Enable specified client")

119

parser.add_option("-d", "--disable", action="store_true",

120

help="disable specified client")

121

parser.add_option("-b", "--bump-timeout", action="store_true",

122

help="Bump timeout of specified client")

123

parser.add_option("--start-checker", action="store_true",

124

help="Start checker for specified client")

125

parser.add_option("--stop-checker", action="store_true",

126

help="Stop checker for specified client")

127

parser.add_option("-V", "--is-valid", action="store_true",

128

help="Check if specified client is still valid")

129

parser.add_option("-Q", "--quit", action="store_true",

130

help="Stops the running mandos server")

131

parser.add_option("-c", "--checker", type="string",

132

help="Set checker command for specified client")

133

parser.add_option("-t", "--timeout", type="string",

134

help="Set timeout for specified client")

135

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

136

help="Set checker interval for specified client")

137

parser.add_option("-H", "--host", type="string",

138

help="Set host for specified client")

139

parser.add_option("-s", "--secret", type="string",

140

help="Set password blob (file) for specified client")

141

options, client_names = parser.parse_args()

142

143

clients=[]

144

for name in client_names:

145

for path, client in mandos_clients.iteritems():

146

if client['name'] == name:

147

client_objc = bus.get_object(busname, path)

148

clients.append(dbus.Interface(client_objc,

149

dbus_interface

150

= client_interface))

151

break

152

else:

153

print >> sys.stderr, "Client not found on server: %r" % name

251

252

value = datetime.timedelta(0)

253

regexp = re.compile(r"(\d+)([dsmhw]?)")

254

255

for num, suffix in regexp.findall(interval):

256

if suffix == "d":

257

value += datetime.timedelta(int(num))

258

elif suffix == "s":

259

value += datetime.timedelta(0, int(num))

260

elif suffix == "m":

261

value += datetime.timedelta(0, 0, 0, 0, int(num))

262

elif suffix == "h":

263

value += datetime.timedelta(0, 0, 0, 0, 0, int(num))

264

elif suffix == "w":

265

value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))

266

elif suffix == "":

267

value += datetime.timedelta(0, 0, 0, int(num))

268

return value

269

270

271

## Classes for commands.

272

273

# Abstract classes first

274

class Command(object):

275

"""Abstract class for commands"""

276

def run(self, mandos, clients):

277

"""Normal commands should implement run_on_one_client(), but

278

commands which want to operate on all clients at the same time

279

can override this run() method instead."""

280

self.mandos = mandos

281

for client in clients:

282

self.run_on_one_client(client)

283

284

class PrintCmd(Command):

285

"""Abstract class for commands printing client details"""

286

all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",

287

"Created", "Interval", "Host", "KeyID",

288

"Fingerprint", "CheckerRunning", "LastEnabled",

289

"ApprovalPending", "ApprovedByDefault",

290

"LastApprovalRequest", "ApprovalDelay",

291

"ApprovalDuration", "Checker", "ExtendedTimeout",

292

"Expires", "LastCheckerStatus")

293

def run(self, mandos, clients):

294

print(self.output(clients))

295

296

class PropertyCmd(Command):

297

"""Abstract class for Actions for setting one client property"""

298

def run_on_one_client(self, client):

299

"""Set the Client's D-Bus property"""

300

client.Set(client_interface, self.property, self.value_to_set,

301

dbus_interface=dbus.PROPERTIES_IFACE)

302

303

class ValueArgumentMixIn(object):

304

"""Mixin class for commands taking a value as argument"""

305

def __init__(self, value):

306

self.value_to_set = value

307

308

class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):

309

"""Mixin class for commands taking a value argument as

310

milliseconds."""

311

@property

312

def value_to_set(self):

313

return self._vts

314

@value_to_set.setter

315

def value_to_set(self, value):

316

"""When setting, convert value to a datetime.timedelta"""

317

self._vts = string_to_delta(value).total_seconds() * 1000

318

319

# Actual (non-abstract) command classes

320

321

class PrintTableCmd(PrintCmd):

322

def __init__(self, verbose=False):

323

self.verbose = verbose

324

325

def output(self, clients):

326

if self.verbose:

327

keywords = self.all_keywords

328

else:

329

keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")

330

return str(self.TableOfClients(clients.values(), keywords))

331

332

class TableOfClients(object):

333

tableheaders = {

334

"Name": "Name",

335

"Enabled": "Enabled",

336

"Timeout": "Timeout",

337

"LastCheckedOK": "Last Successful Check",

338

"LastApprovalRequest": "Last Approval Request",

339

"Created": "Created",

340

"Interval": "Interval",

341

"Host": "Host",

342

"Fingerprint": "Fingerprint",

343

"KeyID": "Key ID",

344

"CheckerRunning": "Check Is Running",

345

"LastEnabled": "Last Enabled",

346

"ApprovalPending": "Approval Is Pending",

347

"ApprovedByDefault": "Approved By Default",

348

"ApprovalDelay": "Approval Delay",

349

"ApprovalDuration": "Approval Duration",

350

"Checker": "Checker",

351

"ExtendedTimeout": "Extended Timeout",

352

"Expires": "Expires",

353

"LastCheckerStatus": "Last Checker Status",

354

}

355

356

def __init__(self, clients, keywords, tableheaders=None):

357

self.clients = clients

358

self.keywords = keywords

359

if tableheaders is not None:

360

self.tableheaders = tableheaders

361

362

def __str__(self):

363

return "\n".join(self.rows())

364

365

if sys.version_info.major == 2:

366

__unicode__ = __str__

367

def __str__(self):

368

return str(self).encode(locale.getpreferredencoding())

369

370

def rows(self):

371

format_string = self.row_formatting_string()

372

rows = [self.header_line(format_string)]

373

rows.extend(self.client_line(client, format_string)

374

for client in self.clients)

375

return rows

376

377

def row_formatting_string(self):

378

"Format string used to format table rows"

379

return " ".join("{{{key}:{width}}}".format(

380

width=max(len(self.tableheaders[key]),

381

*(len(self.string_from_client(client, key))

382

for client in self.clients)),

383

key=key)

384

for key in self.keywords)

385

386

def string_from_client(self, client, key):

387

return self.valuetostring(client[key], key)

388

389

@staticmethod

390

def valuetostring(value, keyword):

391

if isinstance(value, dbus.Boolean):

392

return "Yes" if value else "No"

393

if keyword in ("Timeout", "Interval", "ApprovalDelay",

394

"ApprovalDuration", "ExtendedTimeout"):

395

return milliseconds_to_string(value)

396

return str(value)

397

398

def header_line(self, format_string):

399

return format_string.format(**self.tableheaders)

400

401

def client_line(self, client, format_string):

402

return format_string.format(

403

**{key: self.string_from_client(client, key)

404

for key in self.keywords})

405

406

407

408

class DumpJSONCmd(PrintCmd):

409

def output(self, clients):

410

data = {client["Name"]:

411

{key: self.dbus_boolean_to_bool(client[key])

412

for key in self.all_keywords}

413

for client in clients.values()}

414

return json.dumps(data, indent=4, separators=(',', ': '))

415

@staticmethod

416

def dbus_boolean_to_bool(value):

417

if isinstance(value, dbus.Boolean):

418

value = bool(value)

419

return value

420

421

class IsEnabledCmd(Command):

422

def run_on_one_client(self, client):

423

if self.is_enabled(client):

424

sys.exit(0)

154

425

sys.exit(1)

155

156

if not clients:

157

keywords = defaultkeywords

158

if options.all:

159

keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',

160

'created', 'interval', 'host', 'fingerprint',

161

'checker_running', 'last_enabled', 'checker')

162

print_clients(mandos_clients.values())

163

164

for client in clients:

426

def is_enabled(self, client):

427

return client.Get(client_interface, "Enabled",

428

dbus_interface=dbus.PROPERTIES_IFACE)

429

430

class RemoveCmd(Command):

431

def run_on_one_client(self, client):

432

self.mandos.RemoveClient(client.__dbus_object_path__)

433

434

class ApproveCmd(Command):

435

def run_on_one_client(self, client):

436

client.Approve(dbus.Boolean(True),

437

dbus_interface=client_interface)

438

439

class DenyCmd(Command):

440

def run_on_one_client(self, client):

441

client.Approve(dbus.Boolean(False),

442

dbus_interface=client_interface)

443

444

class EnableCmd(PropertyCmd):

445

property = "Enabled"

446

value_to_set = dbus.Boolean(True)

447

448

class DisableCmd(PropertyCmd):

449

property = "Enabled"

450

value_to_set = dbus.Boolean(False)

451

452

class BumpTimeoutCmd(PropertyCmd):

453

property = "LastCheckedOK"

454

value_to_set = ""

455

456

class StartCheckerCmd(PropertyCmd):

457

property = "CheckerRunning"

458

value_to_set = dbus.Boolean(True)

459

460

class StopCheckerCmd(PropertyCmd):

461

property = "CheckerRunning"

462

value_to_set = dbus.Boolean(False)

463

464

class ApproveByDefaultCmd(PropertyCmd):

465

property = "ApprovedByDefault"

466

value_to_set = dbus.Boolean(True)

467

468

class DenyByDefaultCmd(PropertyCmd):

469

property = "ApprovedByDefault"

470

value_to_set = dbus.Boolean(False)

471

472

class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):

473

property = "Checker"

474

475

class SetHostCmd(PropertyCmd, ValueArgumentMixIn):

476

property = "Host"

477

478

class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):

479

property = "Secret"

480

481

class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):

482

property = "Timeout"

483

484

class SetExtendedTimeoutCmd(PropertyCmd,

485

MillisecondsValueArgumentMixIn):

486

property = "ExtendedTimeout"

487

488

class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):

489

property = "Interval"

490

491

class SetApprovalDelayCmd(PropertyCmd,

492

MillisecondsValueArgumentMixIn):

493

property = "ApprovalDelay"

494

495

class SetApprovalDurationCmd(PropertyCmd,

496

MillisecondsValueArgumentMixIn):

497

property = "ApprovalDuration"

498

499

def has_actions(options):

500

return any((options.enable,

501

options.disable,

502

options.bump_timeout,

503

options.start_checker,

504

options.stop_checker,

505

options.is_enabled,

506

options.remove,

507

options.checker is not None,

508

options.timeout is not None,

509

options.extended_timeout is not None,

510

options.interval is not None,

511

options.approved_by_default is not None,

512

options.approval_delay is not None,

513

options.approval_duration is not None,

514

options.host is not None,

515

options.secret is not None,

516

options.approve,

517

options.deny))

518

519

520

def commands_and_clients_from_options(args=None):

521

if args is None:

522

args=sys.argv[1:]

523

parser = argparse.ArgumentParser()

524

parser.add_argument("--version", action="version",

525

version="%(prog)s {}".format(version),

526

help="show version number and exit")

527

parser.add_argument("-a", "--all", action="store_true",

528

help="Select all clients")

529

parser.add_argument("-v", "--verbose", action="store_true",

530

help="Print all fields")

531

parser.add_argument("-j", "--dump-json", action="store_true",

532

help="Dump client data in JSON format")

533

enable_disable = parser.add_mutually_exclusive_group()

534

enable_disable.add_argument("-e", "--enable", action="store_true",

535

help="Enable client")

536

enable_disable.add_argument("-d", "--disable",

537

action="store_true",

538

help="disable client")

539

parser.add_argument("-b", "--bump-timeout", action="store_true",

540

help="Bump timeout for client")

541

start_stop_checker = parser.add_mutually_exclusive_group()

542

start_stop_checker.add_argument("--start-checker",

543

action="store_true",

544

help="Start checker for client")

545

start_stop_checker.add_argument("--stop-checker",

546

action="store_true",

547

help="Stop checker for client")

548

parser.add_argument("-V", "--is-enabled", action="store_true",

549

help="Check if client is enabled")

550

parser.add_argument("-r", "--remove", action="store_true",

551

help="Remove client")

552

parser.add_argument("-c", "--checker",

553

help="Set checker command for client")

554

parser.add_argument("-t", "--timeout",

555

help="Set timeout for client")

556

parser.add_argument("--extended-timeout",

557

help="Set extended timeout for client")

558

parser.add_argument("-i", "--interval",

559

help="Set checker interval for client")

560

approve_deny_default = parser.add_mutually_exclusive_group()

561

approve_deny_default.add_argument(

562

"--approve-by-default", action="store_true",

563

default=None, dest="approved_by_default",

564

help="Set client to be approved by default")

565

approve_deny_default.add_argument(

566

"--deny-by-default", action="store_false",

567

dest="approved_by_default",

568

help="Set client to be denied by default")

569

parser.add_argument("--approval-delay",

570

help="Set delay before client approve/deny")

571

parser.add_argument("--approval-duration",

572

help="Set duration of one client approval")

573

parser.add_argument("-H", "--host", help="Set host for client")

574

parser.add_argument("-s", "--secret",

575

type=argparse.FileType(mode="rb"),

576

help="Set password blob (file) for client")

577

approve_deny = parser.add_mutually_exclusive_group()

578

approve_deny.add_argument(

579

"-A", "--approve", action="store_true",

580

help="Approve any current client request")

581

approve_deny.add_argument("-D", "--deny", action="store_true",

582

help="Deny any current client request")

583

parser.add_argument("--check", action="store_true",

584

help="Run self-test")

585

parser.add_argument("client", nargs="*", help="Client name")

586

options = parser.parse_args(args=args)

587

588

if has_actions(options) and not (options.client or options.all):

589

parser.error("Options require clients names or --all.")

590

if options.verbose and has_actions(options):

591

parser.error("--verbose can only be used alone.")

592

if options.dump_json and (options.verbose

593

or has_actions(options)):

594

parser.error("--dump-json can only be used alone.")

595

if options.all and not has_actions(options):

596

parser.error("--all requires an action.")

597

if options.is_enabled and len(options.client) > 1:

598

parser.error("--is-enabled requires exactly one client")

599

600

commands = []

601

602

if options.dump_json:

603

commands.append(DumpJSONCmd())

604

165

605

if options.enable:

166

client.Enable()

606

commands.append(EnableCmd())

607

167

608

if options.disable:

168

client.Disable()

609

commands.append(DisableCmd())

610

169

611

if options.bump_timeout:

170

client.BumpTimeout()

612

commands.append(BumpTimeoutCmd(options.bump_timeout))

613

171

614

if options.start_checker:

172

client.StartChecker()

615

commands.append(StartCheckerCmd())

616

173

617

if options.stop_checker:

174

client.StopChecker()

175

if options.is_valid:

176

sys.exit(0 if client.IsStillValid() else 1)

177

if options.checker:

178

client.SetChecker(options.checker)

179

if options.host:

180

client.SetHost(options.host)

181

if options.interval:

182

client.SetInterval(datetime_to_milliseconds

183

(string_to_delta(options.interval)))

184

if options.timeout:

185

client.SetTimeout(datetime_to_milliseconds

186

(string_to_delta(options.timeout)))

187

if options.secret:

188

client.SetSecret(dbus.ByteArray(open(options.secret, 'rb').read()))

189

618

commands.append(StopCheckerCmd())

619

620

if options.is_enabled:

621

commands.append(IsEnabledCmd())

622

623

if options.remove:

624

commands.append(RemoveCmd())

625

626

if options.checker is not None:

627

commands.append(SetCheckerCmd())

628

629

if options.timeout is not None:

630

commands.append(SetTimeoutCmd(options.timeout))

631

632

if options.extended_timeout:

633

commands.append(

634

SetExtendedTimeoutCmd(options.extended_timeout))

635

636

if options.interval is not None:

637

command.append(SetIntervalCmd(options.interval))

638

639

if options.approved_by_default is not None:

640

if options.approved_by_default:

641

command.append(ApproveByDefaultCmd())

642

else:

643

command.append(DenyByDefaultCmd())

644

645

if options.approval_delay is not None:

646

command.append(SetApprovalDelayCmd(options.approval_delay))

647

648

if options.approval_duration is not None:

649

command.append(

650

SetApprovalDurationCmd(options.approval_duration))

651

652

if options.host is not None:

653

command.append(SetHostCmd(options.host))

654

655

if options.secret is not None:

656

command.append(SetSecretCmd(options.secret))

657

658

if options.approve:

659

commands.append(ApproveCmd())

660

661

if options.deny:

662

commands.append(DenyCmd())

663

664

# If no command option has been given, show table of clients,

665

# optionally verbosely

666

if not commands:

667

commands.append(PrintTableCmd(verbose=options.verbose))

668

669

return commands, options.client

670

671

672

def main():

673

commands, clientnames = commands_and_clients_from_options()

674

675

try:

676

bus = dbus.SystemBus()

677

mandos_dbus_objc = bus.get_object(busname, server_path)

678

except dbus.exceptions.DBusException:

679

log.critical("Could not connect to Mandos server")

680

sys.exit(1)

681

682

mandos_serv = dbus.Interface(mandos_dbus_objc,

683

dbus_interface=server_interface)

684

mandos_serv_object_manager = dbus.Interface(

685

mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)

686

687

# Filter out log message from dbus module

688

dbus_logger = logging.getLogger("dbus.proxies")

689

class NullFilter(logging.Filter):

690

def filter(self, record):

691

return False

692

dbus_filter = NullFilter()

693

dbus_logger.addFilter(dbus_filter)

694

try:

695

try:

696

mandos_clients = {path: ifs_and_props[client_interface]

697

for path, ifs_and_props in

698

mandos_serv_object_manager

699

.GetManagedObjects().items()

700

if client_interface in ifs_and_props}

701

finally:

702

# restore dbus logger

703

dbus_logger.removeFilter(dbus_filter)

704

except dbus.exceptions.DBusException as e:

705

log.critical("Failed to access Mandos server through D-Bus:"

706

"\n%s", e)

707

sys.exit(1)

708

709

# Compile dict of (clients: properties) to process

710

clients = {}

711

712

if not clientnames:

713

clients = {bus.get_object(busname, path): properties

714

for path, properties in mandos_clients.items()}

715

else:

716

for name in clientnames:

717

for path, client in mandos_clients.items():

718

if client["Name"] == name:

719

client_objc = bus.get_object(busname, path)

720

clients[client_objc] = client

721

break

722

else:

723

log.critical("Client not found on server: %r", name)

724

sys.exit(1)

725

726

# Run all commands on clients

727

for command in commands:

728

command.run(mandos_serv, clients)

729

730

731

class Test_milliseconds_to_string(unittest.TestCase):

732

def test_all(self):

733

self.assertEqual(milliseconds_to_string(93785000),

734

"1T02:03:05")

735

def test_no_days(self):

736

self.assertEqual(milliseconds_to_string(7385000), "02:03:05")

737

def test_all_zero(self):

738

self.assertEqual(milliseconds_to_string(0), "00:00:00")

739

def test_no_fractional_seconds(self):

740

self.assertEqual(milliseconds_to_string(400), "00:00:00")

741

self.assertEqual(milliseconds_to_string(900), "00:00:00")

742

self.assertEqual(milliseconds_to_string(1900), "00:00:01")

743

744

class Test_string_to_delta(unittest.TestCase):

745

def test_handles_basic_rfc3339(self):

746

self.assertEqual(string_to_delta("PT2H"),

747

datetime.timedelta(0, 7200))

748

def test_falls_back_to_pre_1_6_1_with_warning(self):

749

# assertLogs only exists in Python 3.4

750

if hasattr(self, "assertLogs"):

751

with self.assertLogs(log, logging.WARNING):

752

value = string_to_delta("2h")

753

else:

754

class WarningFilter(logging.Filter):

755

"""Don't show, but record the presence of, warnings"""

756

def filter(self, record):

757

is_warning = record.levelno >= logging.WARNING

758

self.found = is_warning or getattr(self, "found",

759

False)

760

return not is_warning

761

warning_filter = WarningFilter()

762

log.addFilter(warning_filter)

763

try:

764

value = string_to_delta("2h")

765

finally:

766

log.removeFilter(warning_filter)

767

self.assertTrue(getattr(warning_filter, "found", False))

768

self.assertEqual(value, datetime.timedelta(0, 7200))

769

770

771

class TestCmd(unittest.TestCase):

772

"""Abstract class for tests of command classes"""

773

def setUp(self):

774

testcase = self

775

class MockClient(object):

776

def __init__(self, name, **attributes):

777

self.__dbus_object_path__ = "objpath_{}".format(name)

778

self.attributes = attributes

779

self.attributes["Name"] = name

780

def Set(interface, property, value,

781

properties_interface):

782

testcase.assertEqual(interface, client_interface)

783

testcase.assertEqual(properties_interface,

784

dbus.PROPERTIES_IFACE)

785

self.attributes[property] = value

786

def Get(interface, property, properties_interface):

787

testcase.assertEqual(interface, client_interface)

788

testcase.assertEqual(properties_interface,

789

dbus.PROPERTIES_IFACE)

790

return self.attributes[property]

791

def __getitem__(self, key):

792

return self.attributes[key]

793

self.clients = collections.OrderedDict([

794

("foo",

795

MockClient(

796

"foo",

797

KeyID=("92ed150794387c03ce684574b1139a65"

798

"94a34f895daaaf09fd8ea90a27cddb12"),

799

Secret=b"secret",

800

Host="foo.example.org",

801

Enabled=dbus.Boolean(True),

802

Timeout=300000,

803

LastCheckedOK="2019-02-03T00:00:00",

804

Created="2019-01-02T00:00:00",

805

Interval=120000,

806

Fingerprint=("778827225BA7DE539C5A"

807

"7CFA59CFF7CDBD9A5920"),

808

CheckerRunning=dbus.Boolean(False),

809

LastEnabled="2019-01-03T00:00:00",

810

ApprovalPending=dbus.Boolean(False),

811

ApprovedByDefault=dbus.Boolean(True),

812

LastApprovalRequest="",

813

ApprovalDelay=0,

814

ApprovalDuration=1000,

815

Checker="fping -q -- %(host)s",

816

ExtendedTimeout=900000,

817

Expires="2019-02-04T00:00:00",

818

LastCheckerStatus=0)),

819

("barbar",

820

MockClient(

821

"barbar",

822

KeyID=("0558568eedd67d622f5c83b35a115f79"

823

"6ab612cff5ad227247e46c2b020f441c"),

824

Secret=b"secretbar",

825

Host="192.0.2.3",

826

Enabled=dbus.Boolean(True),

827

Timeout=300000,

828

LastCheckedOK="2019-02-04T00:00:00",

829

Created="2019-01-03T00:00:00",

830

Interval=120000,

831

Fingerprint=("3E393AEAEFB84C7E89E2"

832

"F547B3A107558FCA3A27"),

833

CheckerRunning=dbus.Boolean(True),

834

LastEnabled="2019-01-04T00:00:00",

835

ApprovalPending=dbus.Boolean(False),

836

ApprovedByDefault=dbus.Boolean(False),

837

LastApprovalRequest="2019-01-03T00:00:00",

838

ApprovalDelay=30000,

839

ApprovalDuration=1000,

840

Checker=":",

841

ExtendedTimeout=900000,

842

Expires="2019-02-05T00:00:00",

843

LastCheckerStatus=-2)),

844

])

845

846

class TestPrintTableCmd(TestCmd):

847

def test_normal(self):

848

output = PrintTableCmd().output(self.clients)

849

expected_output = """

850

Name Enabled Timeout Last Successful Check

851

foo Yes 00:05:00 2019-02-03T00:00:00

852

barbar Yes 00:05:00 2019-02-04T00:00:00

853

"""[1:-1]

854

self.assertEqual(output, expected_output)

855

def test_verbose(self):

856

output = PrintTableCmd(verbose=True).output(self.clients)

857

expected_output = """

858

Name Enabled Timeout Last Successful Check Created Interval Host Key ID Fingerprint Check Is Running Last Enabled Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker Extended Timeout Expires Last Checker Status

859

foo Yes 00:05:00 2019-02-03T00:00:00 2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No 2019-01-03T00:00:00 No Yes 00:00:00 00:00:01 fping -q -- %(host)s 00:15:00 2019-02-04T00:00:00 0

860

barbar Yes 00:05:00 2019-02-04T00:00:00 2019-01-03T00:00:00 00:02:00 192.0.2.3 0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes 2019-01-04T00:00:00 No No 2019-01-03T00:00:00 00:00:30 00:00:01 : 00:15:00 2019-02-05T00:00:00 -2

861

"""[1:-1]

862

self.assertEqual(output, expected_output)

863

def test_one_client(self):

864

output = PrintTableCmd().output({"foo": self.clients["foo"]})

865

expected_output = """

866

Name Enabled Timeout Last Successful Check

867

foo Yes 00:05:00 2019-02-03T00:00:00

868

"""[1:-1]

869

self.assertEqual(output, expected_output)

870

871

872

873

def should_only_run_tests():

874

parser = argparse.ArgumentParser(add_help=False)

875

parser.add_argument("--check", action='store_true')

876

args, unknown_args = parser.parse_known_args()

877

run_tests = args.check

878

if run_tests:

879

# Remove --check argument from sys.argv

880

sys.argv[1:] = unknown_args

881

return run_tests

882

883

# Add all tests from doctest strings

884

def load_tests(loader, tests, none):

885

import doctest

886

tests.addTests(doctest.DocTestSuite())

887

return tests

888

889

if __name__ == "__main__":

890

if should_only_run_tests():

891

# Call using ./tdd-python-script --check [--verbose]

892

unittest.main()

893

else:

894

main()