Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

"""Tests for certbot.storage.""" 

# pylint disable=protected-access 

import datetime 

import os 

import shutil 

import stat 

import unittest 

 

import configobj 

import mock 

import pytz 

import six 

 

import certbot 

from certbot import cli 

from certbot import compat 

from certbot import errors 

from certbot.storage import ALL_FOUR 

 

import certbot.tests.util as test_util 

 

 

CERT = test_util.load_cert('cert_512.pem') 

 

 

 

def unlink_all(rc_object): 

"""Unlink all four items associated with this RenewableCert.""" 

for kind in ALL_FOUR: 

os.unlink(getattr(rc_object, kind)) 

 

 

def fill_with_sample_data(rc_object): 

"""Put dummy data into all four files of this RenewableCert.""" 

for kind in ALL_FOUR: 

with open(getattr(rc_object, kind), "w") as f: 

f.write(kind) 

 

 

class BaseRenewableCertTest(test_util.ConfigTestCase): 

"""Base class for setting up Renewable Cert tests. 

 

.. note:: It may be required to write out self.config for 

your test. Check :class:`.cli_test.DuplicateCertTest` for an example. 

 

""" 

 

def setUp(self): 

from certbot import storage 

 

super(BaseRenewableCertTest, self).setUp() 

 

# TODO: maybe provide NamespaceConfig.make_dirs? 

# TODO: main() should create those dirs, c.f. #902 

os.makedirs(os.path.join(self.config.config_dir, "live", "example.org")) 

archive_path = os.path.join(self.config.config_dir, "archive", "example.org") 

os.makedirs(archive_path) 

os.makedirs(os.path.join(self.config.config_dir, "renewal")) 

 

config_file = configobj.ConfigObj() 

for kind in ALL_FOUR: 

kind_path = os.path.join(self.config.config_dir, "live", "example.org", 

kind + ".pem") 

config_file[kind] = kind_path 

with open(os.path.join(self.config.config_dir, "live", "example.org", 

"README"), 'a'): 

pass 

config_file["archive"] = archive_path 

config_file.filename = os.path.join(self.config.config_dir, "renewal", 

"example.org.conf") 

config_file.write() 

self.config_file = config_file 

 

# We also create a file that isn't a renewal config in the same 

# location to test that logic that reads in all-and-only renewal 

# configs will ignore it and NOT attempt to parse it. 

with open(os.path.join(self.config.config_dir, "renewal", "IGNORE.THIS"), "w") as junk: 

junk.write("This file should be ignored!") 

 

self.defaults = configobj.ConfigObj() 

 

with mock.patch("certbot.storage.RenewableCert._check_symlinks") as check: 

check.return_value = True 

self.test_rc = storage.RenewableCert(config_file.filename, self.config) 

 

def _write_out_kind(self, kind, ver, value=None): 

link = getattr(self.test_rc, kind) 

if os.path.lexists(link): 

os.unlink(link) 

os.symlink(os.path.join(os.path.pardir, os.path.pardir, "archive", 

"example.org", "{0}{1}.pem".format(kind, ver)), 

link) 

with open(link, "wb") as f: 

f.write(kind.encode('ascii') if value is None else value) 

if kind == "privkey": 

os.chmod(link, 0o600) 

 

def _write_out_ex_kinds(self): 

for kind in ALL_FOUR: 

self._write_out_kind(kind, 12) 

self._write_out_kind(kind, 11) 

 

 

class RenewableCertTests(BaseRenewableCertTest): 

# pylint: disable=too-many-public-methods 

"""Tests for certbot.storage.""" 

 

def test_initialization(self): 

self.assertEqual(self.test_rc.lineagename, "example.org") 

for kind in ALL_FOUR: 

self.assertEqual( 

getattr(self.test_rc, kind), os.path.join( 

self.config.config_dir, "live", "example.org", kind + ".pem")) 

 

def test_renewal_bad_config(self): 

"""Test that the RenewableCert constructor will complain if 

the renewal configuration file doesn't end in ".conf" 

 

""" 

from certbot import storage 

broken = os.path.join(self.config.config_dir, "broken.conf") 

with open(broken, "w") as f: 

f.write("[No closing bracket for you!") 

self.assertRaises(errors.CertStorageError, storage.RenewableCert, 

broken, self.config) 

os.unlink(broken) 

self.assertRaises(errors.CertStorageError, storage.RenewableCert, 

"fun", self.config) 

 

def test_renewal_incomplete_config(self): 

"""Test that the RenewableCert constructor will complain if 

the renewal configuration file is missing a required file element.""" 

from certbot import storage 

config = configobj.ConfigObj() 

config["cert"] = "imaginary_cert.pem" 

# Here the required privkey is missing. 

config["chain"] = "imaginary_chain.pem" 

config["fullchain"] = "imaginary_fullchain.pem" 

config.filename = os.path.join(self.config.config_dir, "imaginary_config.conf") 

config.write() 

self.assertRaises(errors.CertStorageError, storage.RenewableCert, 

config.filename, self.config) 

 

def test_no_renewal_version(self): 

from certbot import storage 

 

self._write_out_ex_kinds() 

self.assertTrue("version" not in self.config_file) 

 

with mock.patch("certbot.storage.logger") as mock_logger: 

storage.RenewableCert(self.config_file.filename, self.config) 

self.assertFalse(mock_logger.warning.called) 

 

def test_renewal_newer_version(self): 

from certbot import storage 

 

self._write_out_ex_kinds() 

self.config_file["version"] = "99.99.99" 

self.config_file.write() 

 

with mock.patch("certbot.storage.logger") as mock_logger: 

storage.RenewableCert(self.config_file.filename, self.config) 

self.assertTrue(mock_logger.info.called) 

self.assertTrue("version" in mock_logger.info.call_args[0][0]) 

 

def test_consistent(self): 

# pylint: disable=too-many-statements,protected-access 

oldcert = self.test_rc.cert 

self.test_rc.cert = "relative/path" 

# Absolute path for item requirement 

self.assertFalse(self.test_rc._consistent()) 

self.test_rc.cert = oldcert 

# Items must exist requirement 

self.assertFalse(self.test_rc._consistent()) 

# Items must be symlinks requirements 

fill_with_sample_data(self.test_rc) 

self.assertFalse(self.test_rc._consistent()) 

unlink_all(self.test_rc) 

# Items must point to desired place if they are relative 

for kind in ALL_FOUR: 

os.symlink(os.path.join("..", kind + "17.pem"), 

getattr(self.test_rc, kind)) 

self.assertFalse(self.test_rc._consistent()) 

unlink_all(self.test_rc) 

# Items must point to desired place if they are absolute 

for kind in ALL_FOUR: 

os.symlink(os.path.join(self.config.config_dir, kind + "17.pem"), 

getattr(self.test_rc, kind)) 

self.assertFalse(self.test_rc._consistent()) 

unlink_all(self.test_rc) 

# Items must point to things that exist 

for kind in ALL_FOUR: 

os.symlink(os.path.join("..", "..", "archive", "example.org", 

kind + "17.pem"), 

getattr(self.test_rc, kind)) 

self.assertFalse(self.test_rc._consistent()) 

# This version should work 

fill_with_sample_data(self.test_rc) 

self.assertTrue(self.test_rc._consistent()) 

# Items must point to things that follow the naming convention 

os.unlink(self.test_rc.fullchain) 

os.symlink(os.path.join("..", "..", "archive", "example.org", 

"fullchain_17.pem"), self.test_rc.fullchain) 

with open(self.test_rc.fullchain, "w") as f: 

f.write("wrongly-named fullchain") 

self.assertFalse(self.test_rc._consistent()) 

 

def test_current_target(self): 

# Relative path logic 

self._write_out_kind("cert", 17) 

self.assertTrue(os.path.samefile(self.test_rc.current_target("cert"), 

os.path.join(self.config.config_dir, "archive", 

"example.org", 

"cert17.pem"))) 

# Absolute path logic 

os.unlink(self.test_rc.cert) 

os.symlink(os.path.join(self.config.config_dir, "archive", "example.org", 

"cert17.pem"), self.test_rc.cert) 

with open(self.test_rc.cert, "w") as f: 

f.write("cert") 

self.assertTrue(os.path.samefile(self.test_rc.current_target("cert"), 

os.path.join(self.config.config_dir, "archive", 

"example.org", 

"cert17.pem"))) 

 

def test_current_version(self): 

for ver in (1, 5, 10, 20): 

self._write_out_kind("cert", ver) 

os.unlink(self.test_rc.cert) 

os.symlink(os.path.join("..", "..", "archive", "example.org", 

"cert10.pem"), self.test_rc.cert) 

self.assertEqual(self.test_rc.current_version("cert"), 10) 

 

def test_no_current_version(self): 

self.assertEqual(self.test_rc.current_version("cert"), None) 

 

def test_latest_and_next_versions(self): 

for ver in six.moves.range(1, 6): 

for kind in ALL_FOUR: 

self._write_out_kind(kind, ver) 

self.assertEqual(self.test_rc.latest_common_version(), 5) 

self.assertEqual(self.test_rc.next_free_version(), 6) 

# Having one kind of file of a later version doesn't change the 

# result 

self._write_out_kind("privkey", 7) 

self.assertEqual(self.test_rc.latest_common_version(), 5) 

# ... although it does change the next free version 

self.assertEqual(self.test_rc.next_free_version(), 8) 

# Nor does having three out of four change the result 

self._write_out_kind("cert", 7) 

self._write_out_kind("fullchain", 7) 

self.assertEqual(self.test_rc.latest_common_version(), 5) 

# If we have everything from a much later version, it does change 

# the result 

for kind in ALL_FOUR: 

self._write_out_kind(kind, 17) 

self.assertEqual(self.test_rc.latest_common_version(), 17) 

self.assertEqual(self.test_rc.next_free_version(), 18) 

 

@mock.patch("certbot.storage.logger") 

def test_ensure_deployed(self, mock_logger): 

mock_update = self.test_rc.update_all_links_to = mock.Mock() 

mock_has_pending = self.test_rc.has_pending_deployment = mock.Mock() 

self.test_rc.latest_common_version = mock.Mock() 

 

mock_has_pending.return_value = False 

self.assertEqual(self.test_rc.ensure_deployed(), True) 

self.assertEqual(mock_update.call_count, 0) 

self.assertEqual(mock_logger.warning.call_count, 0) 

 

mock_has_pending.return_value = True 

self.assertEqual(self.test_rc.ensure_deployed(), False) 

self.assertEqual(mock_update.call_count, 1) 

self.assertEqual(mock_logger.warning.call_count, 1) 

 

 

def test_update_link_to(self): 

for ver in six.moves.range(1, 6): 

for kind in ALL_FOUR: 

self._write_out_kind(kind, ver) 

self.assertEqual(ver, self.test_rc.current_version(kind)) 

# pylint: disable=protected-access 

self.test_rc._update_link_to("cert", 3) 

self.test_rc._update_link_to("privkey", 2) 

self.assertEqual(3, self.test_rc.current_version("cert")) 

self.assertEqual(2, self.test_rc.current_version("privkey")) 

self.assertEqual(5, self.test_rc.current_version("chain")) 

self.assertEqual(5, self.test_rc.current_version("fullchain")) 

# Currently we are allowed to update to a version that doesn't exist 

self.test_rc._update_link_to("chain", 3000) 

# However, current_version doesn't allow querying the resulting 

# version (because it's a broken link). 

self.assertEqual(os.path.basename(os.readlink(self.test_rc.chain)), 

"chain3000.pem") 

 

def test_version(self): 

self._write_out_kind("cert", 12) 

# TODO: We should probably test that the directory is still the 

# same, but it's tricky because we can get an absolute 

# path out when we put a relative path in. 

self.assertEqual("cert8.pem", 

os.path.basename(self.test_rc.version("cert", 8))) 

 

def test_update_all_links_to_success(self): 

for ver in six.moves.range(1, 6): 

for kind in ALL_FOUR: 

self._write_out_kind(kind, ver) 

self.assertEqual(ver, self.test_rc.current_version(kind)) 

self.assertEqual(self.test_rc.latest_common_version(), 5) 

for ver in six.moves.range(1, 6): 

self.test_rc.update_all_links_to(ver) 

for kind in ALL_FOUR: 

self.assertEqual(ver, self.test_rc.current_version(kind)) 

self.assertEqual(self.test_rc.latest_common_version(), 5) 

 

def test_update_all_links_to_partial_failure(self): 

def unlink_or_raise(path, real_unlink=os.unlink): 

# pylint: disable=missing-docstring 

basename = os.path.basename(path) 

if "fullchain" in basename and basename.startswith("prev"): 

raise ValueError 

else: 

real_unlink(path) 

 

self._write_out_ex_kinds() 

with mock.patch("certbot.storage.os.unlink") as mock_unlink: 

mock_unlink.side_effect = unlink_or_raise 

self.assertRaises(ValueError, self.test_rc.update_all_links_to, 12) 

 

for kind in ALL_FOUR: 

self.assertEqual(self.test_rc.current_version(kind), 12) 

 

def test_update_all_links_to_full_failure(self): 

def unlink_or_raise(path, real_unlink=os.unlink): 

# pylint: disable=missing-docstring 

if "fullchain" in os.path.basename(path): 

raise ValueError 

else: 

real_unlink(path) 

 

self._write_out_ex_kinds() 

with mock.patch("certbot.storage.os.unlink") as mock_unlink: 

mock_unlink.side_effect = unlink_or_raise 

self.assertRaises(ValueError, self.test_rc.update_all_links_to, 12) 

 

for kind in ALL_FOUR: 

self.assertEqual(self.test_rc.current_version(kind), 11) 

 

def test_has_pending_deployment(self): 

for ver in six.moves.range(1, 6): 

for kind in ALL_FOUR: 

self._write_out_kind(kind, ver) 

self.assertEqual(ver, self.test_rc.current_version(kind)) 

for ver in six.moves.range(1, 6): 

self.test_rc.update_all_links_to(ver) 

for kind in ALL_FOUR: 

self.assertEqual(ver, self.test_rc.current_version(kind)) 

if ver < 5: 

self.assertTrue(self.test_rc.has_pending_deployment()) 

else: 

self.assertFalse(self.test_rc.has_pending_deployment()) 

 

def test_names(self): 

# Trying the current version 

self._write_out_kind("cert", 12, test_util.load_vector("cert-san_512.pem")) 

 

self.assertEqual(self.test_rc.names(), 

["example.com", "www.example.com"]) 

 

# Trying a non-current version 

self._write_out_kind("cert", 15, test_util.load_vector("cert_512.pem")) 

 

self.assertEqual(self.test_rc.names(12), 

["example.com", "www.example.com"]) 

 

# Testing common name is listed first 

self._write_out_kind( 

"cert", 12, test_util.load_vector("cert-5sans_512.pem")) 

 

self.assertEqual( 

self.test_rc.names(12), 

["example.com"] + ["{0}.example.com".format(c) for c in "abcd"]) 

 

# Trying missing cert 

os.unlink(self.test_rc.cert) 

self.assertRaises(errors.CertStorageError, self.test_rc.names) 

 

@mock.patch("certbot.storage.cli") 

@mock.patch("certbot.storage.datetime") 

def test_time_interval_judgments(self, mock_datetime, mock_cli): 

"""Test should_autorenew() on the basis of expiry time windows.""" 

test_cert = test_util.load_vector("cert_512.pem") 

 

self._write_out_ex_kinds() 

 

self.test_rc.update_all_links_to(12) 

with open(self.test_rc.cert, "wb") as f: 

f.write(test_cert) 

self.test_rc.update_all_links_to(11) 

with open(self.test_rc.cert, "wb") as f: 

f.write(test_cert) 

 

mock_datetime.timedelta = datetime.timedelta 

mock_cli.set_by_cli.return_value = False 

self.test_rc.configuration["renewalparams"] = {} 

 

for (current_time, interval, result) in [ 

# 2014-12-13 12:00:00+00:00 (about 5 days prior to expiry) 

# Times that should result in autorenewal/autodeployment 

(1418472000, "2 months", True), (1418472000, "1 week", True), 

# Times that should not 

(1418472000, "4 days", False), (1418472000, "2 days", False), 

# 2009-05-01 12:00:00+00:00 (about 5 years prior to expiry) 

# Times that should result in autorenewal/autodeployment 

(1241179200, "7 years", True), 

(1241179200, "11 years 2 months", True), 

# Times that should not 

(1241179200, "8 hours", False), (1241179200, "2 days", False), 

(1241179200, "40 days", False), (1241179200, "9 months", False), 

# 2015-01-01 (after expiry has already happened, so all 

# intervals should cause autorenewal/autodeployment) 

(1420070400, "0 seconds", True), 

(1420070400, "10 seconds", True), 

(1420070400, "10 minutes", True), 

(1420070400, "10 weeks", True), (1420070400, "10 months", True), 

(1420070400, "10 years", True), (1420070400, "99 months", True), 

]: 

sometime = datetime.datetime.utcfromtimestamp(current_time) 

mock_datetime.datetime.utcnow.return_value = sometime 

self.test_rc.configuration["deploy_before_expiry"] = interval 

self.test_rc.configuration["renew_before_expiry"] = interval 

self.assertEqual(self.test_rc.should_autorenew(), result) 

 

def test_autorenewal_is_enabled(self): 

self.test_rc.configuration["renewalparams"] = {} 

self.assertTrue(self.test_rc.autorenewal_is_enabled()) 

self.test_rc.configuration["renewalparams"]["autorenew"] = "True" 

self.assertTrue(self.test_rc.autorenewal_is_enabled()) 

 

self.test_rc.configuration["renewalparams"]["autorenew"] = "False" 

self.assertFalse(self.test_rc.autorenewal_is_enabled()) 

 

@mock.patch("certbot.storage.cli") 

@mock.patch("certbot.storage.RenewableCert.ocsp_revoked") 

def test_should_autorenew(self, mock_ocsp, mock_cli): 

"""Test should_autorenew on the basis of reasons other than 

expiry time window.""" 

# pylint: disable=too-many-statements 

mock_cli.set_by_cli.return_value = False 

# Autorenewal turned off 

self.test_rc.configuration["renewalparams"] = {"autorenew": "False"} 

self.assertFalse(self.test_rc.should_autorenew()) 

self.test_rc.configuration["renewalparams"]["autorenew"] = "True" 

for kind in ALL_FOUR: 

self._write_out_kind(kind, 12) 

# Mandatory renewal on the basis of OCSP revocation 

mock_ocsp.return_value = True 

self.assertTrue(self.test_rc.should_autorenew()) 

mock_ocsp.return_value = False 

 

@test_util.broken_on_windows 

@mock.patch("certbot.storage.relevant_values") 

def test_save_successor(self, mock_rv): 

# Mock relevant_values() to claim that all values are relevant here 

# (to avoid instantiating parser) 

mock_rv.side_effect = lambda x: x 

 

for ver in six.moves.range(1, 6): 

for kind in ALL_FOUR: 

self._write_out_kind(kind, ver) 

self.test_rc.update_all_links_to(3) 

self.assertEqual( 

6, self.test_rc.save_successor(3, b'new cert', None, 

b'new chain', self.config)) 

with open(self.test_rc.version("cert", 6)) as f: 

self.assertEqual(f.read(), "new cert") 

with open(self.test_rc.version("chain", 6)) as f: 

self.assertEqual(f.read(), "new chain") 

with open(self.test_rc.version("fullchain", 6)) as f: 

self.assertEqual(f.read(), "new cert" + "new chain") 

# version 6 of the key should be a link back to version 3 

self.assertFalse(os.path.islink(self.test_rc.version("privkey", 3))) 

self.assertTrue(os.path.islink(self.test_rc.version("privkey", 6))) 

# Let's try two more updates 

self.assertEqual( 

7, self.test_rc.save_successor(6, b'again', None, 

b'newer chain', self.config)) 

self.assertEqual( 

8, self.test_rc.save_successor(7, b'hello', None, 

b'other chain', self.config)) 

# All of the subsequent versions should link directly to the original 

# privkey. 

for i in (6, 7, 8): 

self.assertTrue(os.path.islink(self.test_rc.version("privkey", i))) 

self.assertEqual("privkey3.pem", os.path.basename(os.readlink( 

self.test_rc.version("privkey", i)))) 

 

for kind in ALL_FOUR: 

self.assertEqual(self.test_rc.available_versions(kind), list(six.moves.range(1, 9))) 

self.assertEqual(self.test_rc.current_version(kind), 3) 

# Test updating from latest version rather than old version 

self.test_rc.update_all_links_to(8) 

self.assertEqual( 

9, self.test_rc.save_successor(8, b'last', None, 

b'attempt', self.config)) 

for kind in ALL_FOUR: 

self.assertEqual(self.test_rc.available_versions(kind), 

list(six.moves.range(1, 10))) 

self.assertEqual(self.test_rc.current_version(kind), 8) 

with open(self.test_rc.version("fullchain", 9)) as f: 

self.assertEqual(f.read(), "last" + "attempt") 

temp_config_file = os.path.join(self.config.renewal_configs_dir, 

self.test_rc.lineagename) + ".conf.new" 

with open(temp_config_file, "w") as f: 

f.write("We previously crashed while writing me :(") 

# Test updating when providing a new privkey. The key should 

# be saved in a new file rather than creating a new symlink. 

self.assertEqual( 

10, self.test_rc.save_successor(9, b'with', b'a', 

b'key', self.config)) 

self.assertTrue(os.path.exists(self.test_rc.version("privkey", 10))) 

self.assertFalse(os.path.islink(self.test_rc.version("privkey", 10))) 

self.assertFalse(os.path.exists(temp_config_file)) 

 

@test_util.broken_on_windows 

@mock.patch("certbot.storage.relevant_values") 

def test_save_successor_maintains_group_mode(self, mock_rv): 

# Mock relevant_values() to claim that all values are relevant here 

# (to avoid instantiating parser) 

mock_rv.side_effect = lambda x: x 

for kind in ALL_FOUR: 

self._write_out_kind(kind, 1) 

self.test_rc.update_all_links_to(1) 

self.assertTrue(compat.compare_file_modes( 

os.stat(self.test_rc.version("privkey", 1)).st_mode, 0o600)) 

os.chmod(self.test_rc.version("privkey", 1), 0o444) 

# If no new key, permissions should be the same (we didn't write any keys) 

self.test_rc.save_successor(1, b"newcert", None, b"new chain", self.config) 

self.assertTrue(compat.compare_file_modes( 

os.stat(self.test_rc.version("privkey", 2)).st_mode, 0o444)) 

# If new key, permissions should be kept as 644 

self.test_rc.save_successor(2, b"newcert", b"new_privkey", b"new chain", self.config) 

self.assertTrue(compat.compare_file_modes( 

os.stat(self.test_rc.version("privkey", 3)).st_mode, 0o644)) 

# If permissions reverted, next renewal will also revert permissions of new key 

os.chmod(self.test_rc.version("privkey", 3), 0o400) 

self.test_rc.save_successor(3, b"newcert", b"new_privkey", b"new chain", self.config) 

self.assertTrue(compat.compare_file_modes( 

os.stat(self.test_rc.version("privkey", 4)).st_mode, 0o600)) 

 

@test_util.broken_on_windows 

@mock.patch("certbot.storage.relevant_values") 

@mock.patch("certbot.storage.os.chown") 

def test_save_successor_maintains_gid(self, mock_chown, mock_rv): 

# Mock relevant_values() to claim that all values are relevant here 

# (to avoid instantiating parser) 

mock_rv.side_effect = lambda x: x 

for kind in ALL_FOUR: 

self._write_out_kind(kind, 1) 

self.test_rc.update_all_links_to(1) 

self.test_rc.save_successor(1, b"newcert", None, b"new chain", self.config) 

self.assertFalse(mock_chown.called) 

self.test_rc.save_successor(2, b"newcert", b"new_privkey", b"new chain", self.config) 

self.assertTrue(mock_chown.called) 

 

def _test_relevant_values_common(self, values): 

defaults = dict((option, cli.flag_default(option)) 

for option in ("authenticator", "installer", 

"rsa_key_size", "server",)) 

mock_parser = mock.Mock(args=[], verb="plugins", 

defaults=defaults) 

 

# make a copy to ensure values isn't modified 

values = values.copy() 

values.setdefault("server", defaults["server"]) 

expected_server = values["server"] 

 

from certbot.storage import relevant_values 

with mock.patch("certbot.cli.helpful_parser", mock_parser): 

rv = relevant_values(values) 

self.assertIn("server", rv) 

self.assertEqual(rv.pop("server"), expected_server) 

return rv 

 

def test_relevant_values(self): 

"""Test that relevant_values() can reject an irrelevant value.""" 

self.assertEqual( 

self._test_relevant_values_common({"hello": "there"}), {}) 

 

def test_relevant_values_default(self): 

"""Test that relevant_values() can reject a default value.""" 

option = "rsa_key_size" 

values = {option: cli.flag_default(option)} 

self.assertEqual(self._test_relevant_values_common(values), {}) 

 

def test_relevant_values_nondefault(self): 

"""Test that relevant_values() can retain a non-default value.""" 

values = {"rsa_key_size": 12} 

self.assertEqual( 

self._test_relevant_values_common(values), values) 

 

def test_relevant_values_bool(self): 

values = {"allow_subset_of_names": True} 

self.assertEqual( 

self._test_relevant_values_common(values), values) 

 

def test_relevant_values_str(self): 

values = {"authenticator": "apache"} 

self.assertEqual( 

self._test_relevant_values_common(values), values) 

 

def test_relevant_values_plugins_none(self): 

self.assertEqual( 

self._test_relevant_values_common( 

{"authenticator": None, "installer": None}), {}) 

 

@mock.patch("certbot.cli.set_by_cli") 

@mock.patch("certbot.plugins.disco.PluginsRegistry.find_all") 

def test_relevant_values_namespace(self, mock_find_all, mock_set_by_cli): 

mock_set_by_cli.return_value = True 

mock_find_all.return_value = ["certbot-foo:bar"] 

values = {"certbot_foo:bar_baz": 42} 

self.assertEqual( 

self._test_relevant_values_common(values), values) 

 

def test_relevant_values_server(self): 

self.assertEqual( 

# _test_relevant_values_common handles testing the server 

# value and removes it 

self._test_relevant_values_common({"server": "example.org"}), {}) 

 

@mock.patch("certbot.storage.relevant_values") 

def test_new_lineage(self, mock_rv): 

"""Test for new_lineage() class method.""" 

# Mock relevant_values to say everything is relevant here (so we 

# don't have to mock the parser to help it decide!) 

mock_rv.side_effect = lambda x: x 

 

from certbot import storage 

result = storage.RenewableCert.new_lineage( 

"the-lineage.com", b"cert", b"privkey", b"chain", self.config) 

# This consistency check tests most relevant properties about the 

# newly created cert lineage. 

# pylint: disable=protected-access 

self.assertTrue(result._consistent()) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.renewal_configs_dir, "the-lineage.com.conf"))) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.live_dir, "README"))) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.live_dir, "the-lineage.com", "README"))) 

self.assertTrue(compat.compare_file_modes(os.stat(result.key_path).st_mode, 0o600)) 

with open(result.fullchain, "rb") as f: 

self.assertEqual(f.read(), b"cert" + b"chain") 

# Let's do it again and make sure it makes a different lineage 

result = storage.RenewableCert.new_lineage( 

"the-lineage.com", b"cert2", b"privkey2", b"chain2", self.config) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.renewal_configs_dir, "the-lineage.com-0001.conf"))) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.live_dir, "the-lineage.com-0001", "README"))) 

# Now trigger the detection of already existing files 

os.mkdir(os.path.join( 

self.config.live_dir, "the-lineage.com-0002")) 

self.assertRaises(errors.CertStorageError, 

storage.RenewableCert.new_lineage, "the-lineage.com", 

b"cert3", b"privkey3", b"chain3", self.config) 

os.mkdir(os.path.join(self.config.default_archive_dir, "other-example.com")) 

self.assertRaises(errors.CertStorageError, 

storage.RenewableCert.new_lineage, 

"other-example.com", b"cert4", 

b"privkey4", b"chain4", self.config) 

# Make sure it can accept renewal parameters 

result = storage.RenewableCert.new_lineage( 

"the-lineage.com", b"cert2", b"privkey2", b"chain2", self.config) 

# TODO: Conceivably we could test that the renewal parameters actually 

# got saved 

 

@mock.patch("certbot.storage.relevant_values") 

def test_new_lineage_nonexistent_dirs(self, mock_rv): 

"""Test that directories can be created if they don't exist.""" 

# Mock relevant_values to say everything is relevant here (so we 

# don't have to mock the parser to help it decide!) 

mock_rv.side_effect = lambda x: x 

 

from certbot import storage 

shutil.rmtree(self.config.renewal_configs_dir) 

shutil.rmtree(self.config.default_archive_dir) 

shutil.rmtree(self.config.live_dir) 

 

storage.RenewableCert.new_lineage( 

"the-lineage.com", b"cert2", b"privkey2", b"chain2", self.config) 

self.assertTrue(os.path.exists( 

os.path.join( 

self.config.renewal_configs_dir, "the-lineage.com.conf"))) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.live_dir, "the-lineage.com", "privkey.pem"))) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.default_archive_dir, "the-lineage.com", "privkey1.pem"))) 

 

@mock.patch("certbot.storage.util.unique_lineage_name") 

def test_invalid_config_filename(self, mock_uln): 

from certbot import storage 

mock_uln.return_value = "this_does_not_end_with_dot_conf", "yikes" 

self.assertRaises(errors.CertStorageError, 

storage.RenewableCert.new_lineage, "example.com", 

"cert", "privkey", "chain", self.config) 

 

def test_bad_kind(self): 

self.assertRaises( 

errors.CertStorageError, self.test_rc.current_target, "elephant") 

self.assertRaises( 

errors.CertStorageError, self.test_rc.current_version, "elephant") 

self.assertRaises( 

errors.CertStorageError, self.test_rc.version, "elephant", 17) 

self.assertRaises( 

errors.CertStorageError, 

self.test_rc.available_versions, "elephant") 

self.assertRaises( 

errors.CertStorageError, 

self.test_rc.newest_available_version, "elephant") 

# pylint: disable=protected-access 

self.assertRaises( 

errors.CertStorageError, 

self.test_rc._update_link_to, "elephant", 17) 

 

def test_ocsp_revoked(self): 

# XXX: This is currently hardcoded to False due to a lack of an 

# OCSP server to test against. 

self.assertFalse(self.test_rc.ocsp_revoked()) 

 

def test_add_time_interval(self): 

from certbot import storage 

 

# this month has 30 days, and the next year is a leap year 

time_1 = pytz.UTC.fromutc(datetime.datetime(2003, 11, 20, 11, 59, 21)) 

 

# this month has 31 days, and the next year is not a leap year 

time_2 = pytz.UTC.fromutc(datetime.datetime(2012, 10, 18, 21, 31, 16)) 

 

# in different time zone (GMT+8) 

time_3 = pytz.timezone('Asia/Shanghai').fromutc( 

datetime.datetime(2015, 10, 26, 22, 25, 41)) 

 

intended = { 

(time_1, ""): time_1, 

(time_2, ""): time_2, 

(time_3, ""): time_3, 

(time_1, "17 days"): time_1 + datetime.timedelta(17), 

(time_2, "17 days"): time_2 + datetime.timedelta(17), 

(time_1, "30"): time_1 + datetime.timedelta(30), 

(time_2, "30"): time_2 + datetime.timedelta(30), 

(time_1, "7 weeks"): time_1 + datetime.timedelta(49), 

(time_2, "7 weeks"): time_2 + datetime.timedelta(49), 

# 1 month is always 30 days, no matter which month it is 

(time_1, "1 month"): time_1 + datetime.timedelta(30), 

(time_2, "1 month"): time_2 + datetime.timedelta(31), 

# 1 year could be 365 or 366 days, depends on the year 

(time_1, "1 year"): time_1 + datetime.timedelta(366), 

(time_2, "1 year"): time_2 + datetime.timedelta(365), 

(time_1, "1 year 1 day"): time_1 + datetime.timedelta(367), 

(time_2, "1 year 1 day"): time_2 + datetime.timedelta(366), 

(time_1, "1 year-1 day"): time_1 + datetime.timedelta(365), 

(time_2, "1 year-1 day"): time_2 + datetime.timedelta(364), 

(time_1, "4 years"): time_1 + datetime.timedelta(1461), 

(time_2, "4 years"): time_2 + datetime.timedelta(1461), 

} 

 

for parameters, excepted in intended.items(): 

base_time, interval = parameters 

self.assertEqual(storage.add_time_interval(base_time, interval), 

excepted) 

 

def test_is_test_cert(self): 

self.test_rc.configuration["renewalparams"] = {} 

rp = self.test_rc.configuration["renewalparams"] 

self.assertEqual(self.test_rc.is_test_cert, False) 

rp["server"] = "https://acme-staging-v02.api.letsencrypt.org/directory" 

self.assertEqual(self.test_rc.is_test_cert, True) 

rp["server"] = "https://staging.someotherca.com/directory" 

self.assertEqual(self.test_rc.is_test_cert, True) 

rp["server"] = "https://acme-v01.api.letsencrypt.org/directory" 

self.assertEqual(self.test_rc.is_test_cert, False) 

rp["server"] = "https://acme-v02.api.letsencrypt.org/directory" 

self.assertEqual(self.test_rc.is_test_cert, False) 

 

def test_missing_cert(self): 

from certbot import storage 

self.assertRaises(errors.CertStorageError, 

storage.RenewableCert, 

self.config_file.filename, self.config) 

os.symlink("missing", self.config_file[ALL_FOUR[0]]) 

self.assertRaises(errors.CertStorageError, 

storage.RenewableCert, 

self.config_file.filename, self.config) 

 

def test_write_renewal_config(self): 

# Mostly tested by the process of creating and updating lineages, 

# but we can test that this successfully creates files, removes 

# unneeded items, and preserves comments. 

temp = os.path.join(self.config.config_dir, "sample-file") 

temp2 = os.path.join(self.config.config_dir, "sample-file.new") 

with open(temp, "w") as f: 

f.write("[renewalparams]\nuseful = value # A useful value\n" 

"useless = value # Not needed\n") 

os.chmod(temp, 0o640) 

target = {} 

for x in ALL_FOUR: 

target[x] = "somewhere" 

archive_dir = "the_archive" 

relevant_data = {"useful": "new_value"} 

 

from certbot import storage 

storage.write_renewal_config(temp, temp2, archive_dir, target, relevant_data) 

 

with open(temp2, "r") as f: 

content = f.read() 

# useful value was updated 

self.assertTrue("useful = new_value" in content) 

# associated comment was preserved 

self.assertTrue("A useful value" in content) 

# useless value was deleted 

self.assertTrue("useless" not in content) 

# check version was stored 

self.assertTrue("version = {0}".format(certbot.__version__) in content) 

# ensure permissions are copied 

self.assertEqual(stat.S_IMODE(os.lstat(temp).st_mode), 

stat.S_IMODE(os.lstat(temp2).st_mode)) 

 

def test_update_symlinks(self): 

from certbot import storage 

archive_dir_path = os.path.join(self.config.config_dir, "archive", "example.org") 

for kind in ALL_FOUR: 

live_path = self.config_file[kind] 

basename = kind + "1.pem" 

archive_path = os.path.join(archive_dir_path, basename) 

open(archive_path, 'a').close() 

os.symlink(os.path.join(self.config.config_dir, basename), live_path) 

self.assertRaises(errors.CertStorageError, 

storage.RenewableCert, self.config_file.filename, 

self.config) 

storage.RenewableCert(self.config_file.filename, self.config, 

update_symlinks=True) 

 

class DeleteFilesTest(BaseRenewableCertTest): 

"""Tests for certbot.storage.delete_files""" 

def setUp(self): 

super(DeleteFilesTest, self).setUp() 

 

for kind in ALL_FOUR: 

kind_path = os.path.join(self.config.config_dir, "live", "example.org", 

kind + ".pem") 

with open(kind_path, 'a'): 

pass 

self.config_file.write() 

self.assertTrue(os.path.exists(os.path.join( 

self.config.renewal_configs_dir, "example.org.conf"))) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.live_dir, "example.org"))) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.config_dir, "archive", "example.org"))) 

 

def _call(self): 

from certbot import storage 

with mock.patch("certbot.storage.logger"): 

storage.delete_files(self.config, "example.org") 

 

def test_delete_all_files(self): 

self._call() 

 

self.assertFalse(os.path.exists(os.path.join( 

self.config.renewal_configs_dir, "example.org.conf"))) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.live_dir, "example.org"))) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.config_dir, "archive", "example.org"))) 

 

def test_bad_renewal_config(self): 

with open(self.config_file.filename, 'a') as config_file: 

config_file.write("asdfasfasdfasdf") 

 

self.assertRaises(errors.CertStorageError, self._call) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.live_dir, "example.org"))) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.renewal_configs_dir, "example.org.conf"))) 

 

def test_no_renewal_config(self): 

os.remove(self.config_file.filename) 

self.assertRaises(errors.CertStorageError, self._call) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.live_dir, "example.org"))) 

self.assertFalse(os.path.exists(self.config_file.filename)) 

 

def test_no_cert_file(self): 

os.remove(os.path.join( 

self.config.live_dir, "example.org", "cert.pem")) 

self._call() 

self.assertFalse(os.path.exists(self.config_file.filename)) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.live_dir, "example.org"))) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.config_dir, "archive", "example.org"))) 

 

def test_no_readme_file(self): 

os.remove(os.path.join( 

self.config.live_dir, "example.org", "README")) 

self._call() 

self.assertFalse(os.path.exists(self.config_file.filename)) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.live_dir, "example.org"))) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.config_dir, "archive", "example.org"))) 

 

def test_livedir_not_empty(self): 

with open(os.path.join( 

self.config.live_dir, "example.org", "other_file"), 'a'): 

pass 

self._call() 

self.assertFalse(os.path.exists(self.config_file.filename)) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.live_dir, "example.org"))) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.config_dir, "archive", "example.org"))) 

 

def test_no_archive(self): 

archive_dir = os.path.join(self.config.config_dir, "archive", "example.org") 

os.rmdir(archive_dir) 

self._call() 

self.assertFalse(os.path.exists(self.config_file.filename)) 

self.assertFalse(os.path.exists(os.path.join( 

self.config.live_dir, "example.org"))) 

self.assertFalse(os.path.exists(archive_dir)) 

 

class CertPathForCertNameTest(BaseRenewableCertTest): 

"""Test for certbot.storage.cert_path_for_cert_name""" 

def setUp(self): 

super(CertPathForCertNameTest, self).setUp() 

self.config_file.write() 

self._write_out_ex_kinds() 

self.fullchain = os.path.join(self.config.config_dir, 'live', 'example.org', 

'fullchain.pem') 

self.config.cert_path = (self.fullchain, '') 

 

def _call(self, cli_config, certname): 

from certbot.storage import cert_path_for_cert_name 

return cert_path_for_cert_name(cli_config, certname) 

 

def test_simple_cert_name(self): 

self.assertEqual(self._call(self.config, 'example.org'), (self.fullchain, 'fullchain')) 

 

def test_no_such_cert_name(self): 

self.assertRaises(errors.CertStorageError, self._call, self.config, 'fake-example.org') 

 

if __name__ == "__main__": 

unittest.main() # pragma: no cover