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

"""Certbot client API.""" 

import datetime 

import logging 

import os 

import platform 

 

 

from cryptography.hazmat.backends import default_backend 

# https://github.com/python/typeshed/blob/master/third_party/ 

# 2/cryptography/hazmat/primitives/asymmetric/rsa.pyi 

from cryptography.hazmat.primitives.asymmetric.rsa import generate_private_key # type: ignore 

import josepy as jose 

import OpenSSL 

import zope.component 

 

from acme import client as acme_client 

from acme import crypto_util as acme_crypto_util 

from acme import errors as acme_errors 

from acme import messages 

from acme.magic_typing import Optional # pylint: disable=unused-import,no-name-in-module 

 

import certbot 

 

from certbot import account 

from certbot import auth_handler 

from certbot import cli 

from certbot import compat 

from certbot import constants 

from certbot import crypto_util 

from certbot import eff 

from certbot import error_handler 

from certbot import errors 

from certbot import interfaces 

from certbot import reverter 

from certbot import storage 

from certbot import util 

 

from certbot.display import ops as display_ops 

from certbot.display import enhancements 

from certbot.plugins import selection as plugin_selection 

 

 

logger = logging.getLogger(__name__) 

 

 

def acme_from_config_key(config, key, regr=None): 

"Wrangle ACME client construction" 

# TODO: Allow for other alg types besides RS256 

net = acme_client.ClientNetwork(key, account=regr, verify_ssl=(not config.no_verify_ssl), 

user_agent=determine_user_agent(config)) 

return acme_client.BackwardsCompatibleClientV2(net, key, config.server) 

 

 

def determine_user_agent(config): 

""" 

Set a user_agent string in the config based on the choice of plugins. 

(this wasn't knowable at construction time) 

 

:returns: the client's User-Agent string 

:rtype: `str` 

""" 

 

# WARNING: To ensure changes are in line with Certbot's privacy 

# policy, talk to a core Certbot team member before making any 

# changes here. 

if config.user_agent is None: 

ua = ("CertbotACMEClient/{0} ({1}; {2}{8}) Authenticator/{3} Installer/{4} " 

"({5}; flags: {6}) Py/{7}") 

if os.environ.get("CERTBOT_DOCS") == "1": 

cli_command = "certbot(-auto)" 

os_info = "OS_NAME OS_VERSION" 

python_version = "major.minor.patchlevel" 

else: 

cli_command = cli.cli_command 

os_info = util.get_os_info_ua() 

python_version = platform.python_version() 

ua = ua.format(certbot.__version__, cli_command, os_info, 

config.authenticator, config.installer, config.verb, 

ua_flags(config), python_version, 

"; " + config.user_agent_comment if config.user_agent_comment else "") 

else: 

ua = config.user_agent 

return ua 

 

def ua_flags(config): 

"Turn some very important CLI flags into clues in the user agent." 

if isinstance(config, DummyConfig): 

return "FLAGS" 

flags = [] 

if config.duplicate: 

flags.append("dup") 

if config.renew_by_default: 

flags.append("frn") 

if config.allow_subset_of_names: 

flags.append("asn") 

if config.noninteractive_mode: 

flags.append("n") 

hook_names = ("pre", "post", "renew", "manual_auth", "manual_cleanup") 

hooks = [getattr(config, h + "_hook") for h in hook_names] 

if any(hooks): 

flags.append("hook") 

return " ".join(flags) 

 

class DummyConfig(object): 

"Shim for computing a sample user agent." 

def __init__(self): 

self.authenticator = "XXX" 

self.installer = "YYY" 

self.user_agent = None 

self.verb = "SUBCOMMAND" 

 

def __getattr__(self, name): 

"Any config properties we might have are None." 

return None 

 

def sample_user_agent(): 

"Document what this Certbot's user agent string will be like." 

 

return determine_user_agent(DummyConfig()) 

 

 

def register(config, account_storage, tos_cb=None): 

"""Register new account with an ACME CA. 

 

This function takes care of generating fresh private key, 

registering the account, optionally accepting CA Terms of Service 

and finally saving the account. It should be called prior to 

initialization of `Client`, unless account has already been created. 

 

:param .IConfig config: Client configuration. 

 

:param .AccountStorage account_storage: Account storage where newly 

registered account will be saved to. Save happens only after TOS 

acceptance step, so any account private keys or 

`.RegistrationResource` will not be persisted if `tos_cb` 

returns ``False``. 

 

:param tos_cb: If ACME CA requires the user to accept a Terms of 

Service before registering account, client action is 

necessary. For example, a CLI tool would prompt the user 

acceptance. `tos_cb` must be a callable that should accept 

`.RegistrationResource` and return a `bool`: ``True`` iff the 

Terms of Service present in the contained 

`.Registration.terms_of_service` is accepted by the client, and 

``False`` otherwise. ``tos_cb`` will be called only if the 

client action is necessary, i.e. when ``terms_of_service is not 

None``. This argument is optional, if not supplied it will 

default to automatic acceptance! 

 

:raises certbot.errors.Error: In case of any client problems, in 

particular registration failure, or unaccepted Terms of Service. 

:raises acme.errors.Error: In case of any protocol problems. 

 

:returns: Newly registered and saved account, as well as protocol 

API handle (should be used in `Client` initialization). 

:rtype: `tuple` of `.Account` and `acme.client.Client` 

 

""" 

# Log non-standard actions, potentially wrong API calls 

if account_storage.find_all(): 

logger.info("There are already existing accounts for %s", config.server) 

if config.email is None: 

if not config.register_unsafely_without_email: 

msg = ("No email was provided and " 

"--register-unsafely-without-email was not present.") 

logger.warning(msg) 

raise errors.Error(msg) 

if not config.dry_run: 

logger.info("Registering without email!") 

 

# If --dry-run is used, and there is no staging account, create one with no email. 

if config.dry_run: 

config.email = None 

 

# Each new registration shall use a fresh new key 

rsa_key = generate_private_key( 

public_exponent=65537, 

key_size=config.rsa_key_size, 

backend=default_backend()) 

key = jose.JWKRSA(key=jose.ComparableRSAKey(rsa_key)) 

acme = acme_from_config_key(config, key) 

# TODO: add phone? 

regr = perform_registration(acme, config, tos_cb) 

 

acc = account.Account(regr, key) 

account.report_new_account(config) 

account_storage.save(acc, acme) 

 

eff.handle_subscription(config) 

 

return acc, acme 

 

 

def perform_registration(acme, config, tos_cb): 

""" 

Actually register new account, trying repeatedly if there are email 

problems 

 

:param acme.client.Client client: ACME client object. 

:param .IConfig config: Client configuration. 

:param Callable tos_cb: a callback to handle Term of Service agreement. 

 

:returns: Registration Resource. 

:rtype: `acme.messages.RegistrationResource` 

""" 

 

eab_credentials_supplied = config.eab_kid and config.eab_hmac_key 

if eab_credentials_supplied: 

account_public_key = acme.client.net.key.public_key() 

eab = messages.ExternalAccountBinding.from_data(account_public_key=account_public_key, 

kid=config.eab_kid, 

hmac_key=config.eab_hmac_key, 

directory=acme.client.directory) 

else: 

eab = None 

 

if acme.external_account_required(): 

if not eab_credentials_supplied: 

msg = ("Server requires external account binding." 

" Please use --eab-kid and --eab-hmac-key.") 

raise errors.Error(msg) 

 

try: 

newreg = messages.NewRegistration.from_data(email=config.email, 

external_account_binding=eab) 

return acme.new_account_and_tos(newreg, tos_cb) 

except messages.Error as e: 

if e.code == "invalidEmail" or e.code == "invalidContact": 

if config.noninteractive_mode: 

msg = ("The ACME server believes %s is an invalid email address. " 

"Please ensure it is a valid email and attempt " 

"registration again." % config.email) 

raise errors.Error(msg) 

else: 

config.email = display_ops.get_email(invalid=True) 

return perform_registration(acme, config, tos_cb) 

else: 

raise 

 

 

class Client(object): 

"""Certbot's client. 

 

:ivar .IConfig config: Client configuration. 

:ivar .Account account: Account registered with `register`. 

:ivar .AuthHandler auth_handler: Authorizations handler that will 

dispatch DV challenges to appropriate authenticators 

(providing `.IAuthenticator` interface). 

:ivar .IAuthenticator auth: Prepared (`.IAuthenticator.prepare`) 

authenticator that can solve ACME challenges. 

:ivar .IInstaller installer: Installer. 

:ivar acme.client.BackwardsCompatibleClientV2 acme: Optional ACME 

client API handle. You might already have one from `register`. 

 

""" 

 

def __init__(self, config, account_, auth, installer, acme=None): 

"""Initialize a client.""" 

self.config = config 

self.account = account_ 

self.auth = auth 

self.installer = installer 

 

# Initialize ACME if account is provided 

if acme is None and self.account is not None: 

acme = acme_from_config_key(config, self.account.key, self.account.regr) 

self.acme = acme 

 

if auth is not None: 

self.auth_handler = auth_handler.AuthHandler( 

auth, self.acme, self.account, self.config.pref_challs) 

else: 

self.auth_handler = None 

 

def obtain_certificate_from_csr(self, csr, orderr=None): 

"""Obtain certificate. 

 

:param .util.CSR csr: PEM-encoded Certificate Signing 

Request. The key used to generate this CSR can be different 

than `authkey`. 

:param acme.messages.OrderResource orderr: contains authzrs 

 

:returns: certificate and chain as PEM byte strings 

:rtype: tuple 

 

""" 

if self.auth_handler is None: 

msg = ("Unable to obtain certificate because authenticator is " 

"not set.") 

logger.warning(msg) 

raise errors.Error(msg) 

if self.account.regr is None: 

raise errors.Error("Please register with the ACME server first.") 

 

logger.debug("CSR: %s", csr) 

 

if orderr is None: 

orderr = self._get_order_and_authorizations(csr.data, best_effort=False) 

 

deadline = datetime.datetime.now() + datetime.timedelta(seconds=90) 

orderr = self.acme.finalize_order(orderr, deadline) 

cert, chain = crypto_util.cert_and_chain_from_fullchain(orderr.fullchain_pem) 

return cert.encode(), chain.encode() 

 

def obtain_certificate(self, domains, old_keypath=None): 

"""Obtains a certificate from the ACME server. 

 

`.register` must be called before `.obtain_certificate` 

 

:param list domains: domains to get a certificate 

 

:returns: certificate as PEM string, chain as PEM string, 

newly generated private key (`.util.Key`), and DER-encoded 

Certificate Signing Request (`.util.CSR`). 

:rtype: tuple 

 

""" 

 

# We need to determine the key path, key PEM data, CSR path, 

# and CSR PEM data. For a dry run, the paths are None because 

# they aren't permanently saved to disk. For a lineage with 

# --reuse-key, the key path and PEM data are derived from an 

# existing file. 

 

if old_keypath is not None: 

# We've been asked to reuse a specific existing private key. 

# Therefore, we'll read it now and not generate a new one in 

# either case below. 

# 

# We read in bytes here because the type of `key.pem` 

# created below is also bytes. 

with open(old_keypath, "rb") as f: 

keypath = old_keypath 

keypem = f.read() 

key = util.Key(file=keypath, pem=keypem) # type: Optional[util.Key] 

logger.info("Reusing existing private key from %s.", old_keypath) 

else: 

# The key is set to None here but will be created below. 

key = None 

 

# Create CSR from names 

if self.config.dry_run: 

key = key or util.Key(file=None, 

pem=crypto_util.make_key(self.config.rsa_key_size)) 

csr = util.CSR(file=None, form="pem", 

data=acme_crypto_util.make_csr( 

key.pem, domains, self.config.must_staple)) 

else: 

key = key or crypto_util.init_save_key(self.config.rsa_key_size, 

self.config.key_dir) 

csr = crypto_util.init_save_csr(key, domains, self.config.csr_dir) 

 

orderr = self._get_order_and_authorizations(csr.data, self.config.allow_subset_of_names) 

authzr = orderr.authorizations 

auth_domains = set(a.body.identifier.value for a in authzr) 

successful_domains = [d for d in domains if d in auth_domains] 

 

# allow_subset_of_names is currently disabled for wildcard 

# certificates. The reason for this and checking allow_subset_of_names 

# below is because successful_domains == domains is never true if 

# domains contains a wildcard because the ACME spec forbids identifiers 

# in authzs from containing a wildcard character. 

if self.config.allow_subset_of_names and successful_domains != domains: 

if not self.config.dry_run: 

os.remove(key.file) 

os.remove(csr.file) 

return self.obtain_certificate(successful_domains) 

else: 

cert, chain = self.obtain_certificate_from_csr(csr, orderr) 

 

return cert, chain, key, csr 

 

def _get_order_and_authorizations(self, csr_pem, best_effort): 

"""Request a new order and complete its authorizations. 

 

:param str csr_pem: A CSR in PEM format. 

:param bool best_effort: True if failing to complete all 

authorizations should not raise an exception 

 

:returns: order resource containing its completed authorizations 

:rtype: acme.messages.OrderResource 

 

""" 

try: 

orderr = self.acme.new_order(csr_pem) 

except acme_errors.WildcardUnsupportedError: 

raise errors.Error("The currently selected ACME CA endpoint does" 

" not support issuing wildcard certificates.") 

authzr = self.auth_handler.handle_authorizations(orderr, best_effort) 

return orderr.update(authorizations=authzr) 

 

# pylint: disable=no-member 

def obtain_and_enroll_certificate(self, domains, certname): 

"""Obtain and enroll certificate. 

 

Get a new certificate for the specified domains using the specified 

authenticator and installer, and then create a new renewable lineage 

containing it. 

 

:param domains: domains to request a certificate for 

:type domains: `list` of `str` 

:param certname: requested name of lineage 

:type certname: `str` or `None` 

 

:returns: A new :class:`certbot.storage.RenewableCert` instance 

referred to the enrolled cert lineage, False if the cert could not 

be obtained, or None if doing a successful dry run. 

 

""" 

cert, chain, key, _ = self.obtain_certificate(domains) 

 

if (self.config.config_dir != constants.CLI_DEFAULTS["config_dir"] or 

self.config.work_dir != constants.CLI_DEFAULTS["work_dir"]): 

logger.info( 

"Non-standard path(s), might not work with crontab installed " 

"by your operating system package manager") 

 

new_name = self._choose_lineagename(domains, certname) 

 

if self.config.dry_run: 

logger.debug("Dry run: Skipping creating new lineage for %s", 

new_name) 

return None 

else: 

return storage.RenewableCert.new_lineage( 

new_name, cert, 

key.pem, chain, 

self.config) 

 

def _choose_lineagename(self, domains, certname): 

"""Chooses a name for the new lineage. 

 

:param domains: domains in certificate request 

:type domains: `list` of `str` 

:param certname: requested name of lineage 

:type certname: `str` or `None` 

 

:returns: lineage name that should be used 

:rtype: str 

 

""" 

if certname: 

return certname 

elif util.is_wildcard_domain(domains[0]): 

# Don't make files and directories starting with *. 

return domains[0][2:] 

else: 

return domains[0] 

 

def save_certificate(self, cert_pem, chain_pem, 

cert_path, chain_path, fullchain_path): 

"""Saves the certificate received from the ACME server. 

 

:param str cert_pem: 

:param str chain_pem: 

:param str cert_path: Candidate path to a certificate. 

:param str chain_path: Candidate path to a certificate chain. 

:param str fullchain_path: Candidate path to a full cert chain. 

 

:returns: cert_path, chain_path, and fullchain_path as absolute 

paths to the actual files 

:rtype: `tuple` of `str` 

 

:raises IOError: If unable to find room to write the cert files 

 

""" 

for path in cert_path, chain_path, fullchain_path: 

util.make_or_verify_dir( 

os.path.dirname(path), 0o755, compat.os_geteuid(), 

self.config.strict_permissions) 

 

 

cert_file, abs_cert_path = _open_pem_file('cert_path', cert_path) 

 

try: 

cert_file.write(cert_pem) 

finally: 

cert_file.close() 

logger.info("Server issued certificate; certificate written to %s", 

abs_cert_path) 

 

chain_file, abs_chain_path =\ 

_open_pem_file('chain_path', chain_path) 

fullchain_file, abs_fullchain_path =\ 

_open_pem_file('fullchain_path', fullchain_path) 

 

_save_chain(chain_pem, chain_file) 

_save_chain(cert_pem + chain_pem, fullchain_file) 

 

return abs_cert_path, abs_chain_path, abs_fullchain_path 

 

def deploy_certificate(self, domains, privkey_path, 

cert_path, chain_path, fullchain_path): 

"""Install certificate 

 

:param list domains: list of domains to install the certificate 

:param str privkey_path: path to certificate private key 

:param str cert_path: certificate file path (optional) 

:param str chain_path: chain file path 

 

""" 

if self.installer is None: 

logger.warning("No installer specified, client is unable to deploy" 

"the certificate") 

raise errors.Error("No installer available") 

 

chain_path = None if chain_path is None else os.path.abspath(chain_path) 

 

msg = ("Unable to install the certificate") 

with error_handler.ErrorHandler(self._recovery_routine_with_msg, msg): 

for dom in domains: 

self.installer.deploy_cert( 

domain=dom, cert_path=os.path.abspath(cert_path), 

key_path=os.path.abspath(privkey_path), 

chain_path=chain_path, 

fullchain_path=fullchain_path) 

self.installer.save() # needed by the Apache plugin 

 

self.installer.save("Deployed ACME Certificate") 

 

msg = ("We were unable to install your certificate, " 

"however, we successfully restored your " 

"server to its prior configuration.") 

with error_handler.ErrorHandler(self._rollback_and_restart, msg): 

# sites may have been enabled / final cleanup 

self.installer.restart() 

 

def enhance_config(self, domains, chain_path, ask_redirect=True): 

"""Enhance the configuration. 

 

:param list domains: list of domains to configure 

:param chain_path: chain file path 

:type chain_path: `str` or `None` 

 

:raises .errors.Error: if no installer is specified in the 

client. 

 

""" 

if self.installer is None: 

logger.warning("No installer is specified, there isn't any " 

"configuration to enhance.") 

raise errors.Error("No installer available") 

 

enhanced = False 

enhancement_info = ( 

("hsts", "ensure-http-header", "Strict-Transport-Security"), 

("redirect", "redirect", None), 

("staple", "staple-ocsp", chain_path), 

("uir", "ensure-http-header", "Upgrade-Insecure-Requests"),) 

supported = self.installer.supported_enhancements() 

 

for config_name, enhancement_name, option in enhancement_info: 

config_value = getattr(self.config, config_name) 

if enhancement_name in supported: 

if ask_redirect: 

if config_name == "redirect" and config_value is None: 

config_value = enhancements.ask(enhancement_name) 

if config_value: 

self.apply_enhancement(domains, enhancement_name, option) 

enhanced = True 

elif config_value: 

logger.warning( 

"Option %s is not supported by the selected installer. " 

"Skipping enhancement.", config_name) 

 

msg = ("We were unable to restart web server") 

if enhanced: 

with error_handler.ErrorHandler(self._rollback_and_restart, msg): 

self.installer.restart() 

 

def apply_enhancement(self, domains, enhancement, options=None): 

"""Applies an enhancement on all domains. 

 

:param list domains: list of ssl_vhosts (as strings) 

:param str enhancement: name of enhancement, e.g. ensure-http-header 

:param str options: options to enhancement, e.g. Strict-Transport-Security 

 

.. note:: When more `options` are needed, make options a list. 

 

:raises .errors.PluginError: If Enhancement is not supported, or if 

there is any other problem with the enhancement. 

 

 

""" 

msg = ("We were unable to set up enhancement %s for your server, " 

"however, we successfully installed your certificate." 

% (enhancement)) 

with error_handler.ErrorHandler(self._recovery_routine_with_msg, msg): 

for dom in domains: 

try: 

self.installer.enhance(dom, enhancement, options) 

except errors.PluginEnhancementAlreadyPresent: 

if enhancement == "ensure-http-header": 

logger.warning("Enhancement %s was already set.", 

options) 

else: 

logger.warning("Enhancement %s was already set.", 

enhancement) 

except errors.PluginError: 

logger.warning("Unable to set enhancement %s for %s", 

enhancement, dom) 

raise 

 

self.installer.save("Add enhancement %s" % (enhancement)) 

 

def _recovery_routine_with_msg(self, success_msg): 

"""Calls the installer's recovery routine and prints success_msg 

 

:param str success_msg: message to show on successful recovery 

 

""" 

self.installer.recovery_routine() 

reporter = zope.component.getUtility(interfaces.IReporter) 

reporter.add_message(success_msg, reporter.HIGH_PRIORITY) 

 

def _rollback_and_restart(self, success_msg): 

"""Rollback the most recent checkpoint and restart the webserver 

 

:param str success_msg: message to show on successful rollback 

 

""" 

logger.critical("Rolling back to previous server configuration...") 

reporter = zope.component.getUtility(interfaces.IReporter) 

try: 

self.installer.rollback_checkpoints() 

self.installer.restart() 

except: 

reporter.add_message( 

"An error occurred and we failed to restore your config and " 

"restart your server. Please post to " 

"https://community.letsencrypt.org/c/server-config " 

"with details about your configuration and this error you received.", 

reporter.HIGH_PRIORITY) 

raise 

reporter.add_message(success_msg, reporter.HIGH_PRIORITY) 

 

 

def validate_key_csr(privkey, csr=None): 

"""Validate Key and CSR files. 

 

Verifies that the client key and csr arguments are valid and correspond to 

one another. This does not currently check the names in the CSR due to 

the inability to read SANs from CSRs in python crypto libraries. 

 

If csr is left as None, only the key will be validated. 

 

:param privkey: Key associated with CSR 

:type privkey: :class:`certbot.util.Key` 

 

:param .util.CSR csr: CSR 

 

:raises .errors.Error: when validation fails 

 

""" 

# TODO: Handle all of these problems appropriately 

# The client can eventually do things like prompt the user 

# and allow the user to take more appropriate actions 

 

# Key must be readable and valid. 

if privkey.pem and not crypto_util.valid_privkey(privkey.pem): 

raise errors.Error("The provided key is not a valid key") 

 

if csr: 

if csr.form == "der": 

csr_obj = OpenSSL.crypto.load_certificate_request( 

OpenSSL.crypto.FILETYPE_ASN1, csr.data) 

cert_buffer = OpenSSL.crypto.dump_certificate_request( 

OpenSSL.crypto.FILETYPE_PEM, csr_obj 

) 

csr = util.CSR(csr.file, cert_buffer, "pem") 

 

# If CSR is provided, it must be readable and valid. 

if csr.data and not crypto_util.valid_csr(csr.data): 

raise errors.Error("The provided CSR is not a valid CSR") 

 

# If both CSR and key are provided, the key must be the same key used 

# in the CSR. 

if csr.data and privkey.pem: 

if not crypto_util.csr_matches_pubkey( 

csr.data, privkey.pem): 

raise errors.Error("The key and CSR do not match") 

 

 

def rollback(default_installer, checkpoints, config, plugins): 

"""Revert configuration the specified number of checkpoints. 

 

:param int checkpoints: Number of checkpoints to revert. 

 

:param config: Configuration. 

:type config: :class:`certbot.interfaces.IConfig` 

 

""" 

# Misconfigurations are only a slight problems... allow the user to rollback 

installer = plugin_selection.pick_installer( 

config, default_installer, plugins, question="Which installer " 

"should be used for rollback?") 

 

# No Errors occurred during init... proceed normally 

# If installer is None... couldn't find an installer... there shouldn't be 

# anything to rollback 

if installer is not None: 

installer.rollback_checkpoints(checkpoints) 

installer.restart() 

 

 

def view_config_changes(config, num=None): 

"""View checkpoints and associated configuration changes. 

 

.. note:: This assumes that the installation is using a Reverter object. 

 

:param config: Configuration. 

:type config: :class:`certbot.interfaces.IConfig` 

 

""" 

rev = reverter.Reverter(config) 

rev.recovery_routine() 

rev.view_config_changes(num) 

 

def _open_pem_file(cli_arg_path, pem_path): 

"""Open a pem file. 

 

If cli_arg_path was set by the client, open that. 

Otherwise, uniquify the file path. 

 

:param str cli_arg_path: the cli arg name, e.g. cert_path 

:param str pem_path: the pem file path to open 

 

:returns: a tuple of file object and its absolute file path 

 

""" 

if cli.set_by_cli(cli_arg_path): 

return util.safe_open(pem_path, chmod=0o644, mode="wb"),\ 

os.path.abspath(pem_path) 

else: 

uniq = util.unique_file(pem_path, 0o644, "wb") 

return uniq[0], os.path.abspath(uniq[1]) 

 

def _save_chain(chain_pem, chain_file): 

"""Saves chain_pem at a unique path based on chain_path. 

 

:param str chain_pem: certificate chain in PEM format 

:param str chain_file: chain file object 

 

""" 

try: 

chain_file.write(chain_pem) 

finally: 

chain_file.close() 

 

logger.info("Cert chain written to %s", chain_file.name)