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

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1048

1049

1050

1051

1052

1053

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

1072

1073

1074

1075

1076

1077

1078

1079

1080

1081

1082

1083

1084

1085

1086

1087

1088

1089

1090

1091

1092

1093

1094

1095

1096

1097

1098

1099

1100

1101

1102

1103

1104

1105

1106

1107

1108

1109

1110

1111

1112

1113

1114

1115

1116

1117

1118

1119

1120

1121

1122

1123

1124

1125

1126

1127

1128

1129

1130

1131

1132

1133

1134

1135

1136

1137

1138

1139

1140

1141

1142

1143

1144

1145

1146

1147

1148

1149

1150

1151

1152

1153

1154

1155

1156

1157

1158

1159

1160

1161

1162

1163

1164

1165

1166

1167

1168

1169

1170

1171

1172

1173

1174

1175

1176

1177

1178

1179

1180

1181

1182

1183

1184

1185

1186

1187

1188

1189

1190

1191

1192

1193

1194

1195

1196

1197

1198

1199

1200

1201

1202

1203

1204

1205

1206

1207

1208

1209

1210

1211

1212

1213

1214

1215

1216

1217

1218

1219

1220

1221

1222

1223

1224

1225

1226

1227

1228

1229

1230

1231

1232

1233

1234

1235

1236

1237

1238

1239

1240

1241

1242

1243

1244

1245

1246

1247

1248

1249

1250

1251

1252

1253

1254

1255

1256

1257

1258

1259

1260

1261

1262

1263

1264

1265

1266

1267

1268

1269

1270

1271

1272

1273

1274

1275

1276

1277

1278

1279

1280

1281

1282

1283

1284

1285

1286

1287

1288

1289

1290

1291

1292

1293

1294

1295

1296

1297

1298

1299

1300

1301

1302

1303

1304

1305

1306

1307

1308

1309

1310

1311

1312

1313

1314

1315

1316

1317

1318

1319

1320

1321

1322

1323

1324

1325

1326

1327

1328

1329

1330

1331

1332

1333

1334

1335

1336

1337

1338

1339

1340

1341

1342

1343

1344

1345

1346

1347

1348

1349

1350

1351

1352

1353

1354

1355

1356

1357

1358

1359

1360

1361

1362

1363

1364

1365

1366

1367

1368

1369

1370

1371

1372

"""Certbot main entry point.""" 

# pylint: disable=too-many-lines 

from __future__ import print_function 

import functools 

import logging.handlers 

import os 

import sys 

 

import configobj 

import josepy as jose 

import zope.component 

 

from acme import errors as acme_errors 

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

 

import certbot 

 

from certbot import account 

from certbot import cert_manager 

from certbot import cli 

from certbot import client 

from certbot import compat 

from certbot import configuration 

from certbot import constants 

from certbot import crypto_util 

from certbot import eff 

from certbot import errors 

from certbot import hooks 

from certbot import interfaces 

from certbot import log 

from certbot import renewal 

from certbot import reporter 

from certbot import storage 

from certbot import updater 

from certbot import util 

 

from certbot.display import util as display_util, ops as display_ops 

from certbot.plugins import disco as plugins_disco 

from certbot.plugins import selection as plug_sel 

from certbot.plugins import enhancements 

 

USER_CANCELLED = ("User chose to cancel the operation and may " 

"reinvoke the client.") 

 

 

logger = logging.getLogger(__name__) 

 

 

def _suggest_donation_if_appropriate(config): 

"""Potentially suggest a donation to support Certbot. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:returns: `None` 

:rtype: None 

 

""" 

assert config.verb != "renew" 

if config.staging: 

# --dry-run implies --staging 

return 

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

msg = ("If you like Certbot, please consider supporting our work by:\n\n" 

"Donating to ISRG / Let's Encrypt: https://letsencrypt.org/donate\n" 

"Donating to EFF: https://eff.org/donate-le\n\n") 

reporter_util.add_message(msg, reporter_util.LOW_PRIORITY) 

 

def _report_successful_dry_run(config): 

"""Reports on successful dry run 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:returns: `None` 

:rtype: None 

 

""" 

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

assert config.verb != "renew" 

reporter_util.add_message("The dry run was successful.", 

reporter_util.HIGH_PRIORITY, on_crash=False) 

 

 

def _get_and_save_cert(le_client, config, domains=None, certname=None, lineage=None): 

"""Authenticate and enroll certificate. 

 

This method finds the relevant lineage, figures out what to do with it, 

then performs that action. Includes calls to hooks, various reports, 

checks, and requests for user input. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param domains: List of domain names to get a certificate. Defaults to `None` 

:type domains: `list` of `str` 

 

:param certname: Name of new certificate. Defaults to `None` 

:type certname: str 

 

:param lineage: Certificate lineage object. Defaults to `None` 

:type lineage: storage.RenewableCert 

 

:returns: the issued certificate or `None` if doing a dry run 

:rtype: storage.RenewableCert or None 

 

:raises errors.Error: if certificate could not be obtained 

 

""" 

hooks.pre_hook(config) 

try: 

if lineage is not None: 

# Renewal, where we already know the specific lineage we're 

# interested in 

logger.info("Renewing an existing certificate") 

renewal.renew_cert(config, domains, le_client, lineage) 

else: 

# TREAT AS NEW REQUEST 

assert domains is not None 

logger.info("Obtaining a new certificate") 

lineage = le_client.obtain_and_enroll_certificate(domains, certname) 

if lineage is False: 

raise errors.Error("Certificate could not be obtained") 

elif lineage is not None: 

hooks.deploy_hook(config, lineage.names(), lineage.live_dir) 

finally: 

hooks.post_hook(config) 

 

return lineage 

 

 

def _handle_subset_cert_request(config, domains, cert): 

"""Figure out what to do if a previous cert had a subset of the names now requested 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param domains: List of domain names 

:type domains: `list` of `str` 

 

:param cert: Certificate object 

:type cert: storage.RenewableCert 

 

:returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname 

action can be: "newcert" | "renew" | "reinstall" 

:rtype: `tuple` of `str` 

 

""" 

existing = ", ".join(cert.names()) 

question = ( 

"You have an existing certificate that contains a portion of " 

"the domains you requested (ref: {0}){br}{br}It contains these " 

"names: {1}{br}{br}You requested these names for the new " 

"certificate: {2}.{br}{br}Do you want to expand and replace this existing " 

"certificate with the new certificate?" 

).format(cert.configfile.filename, 

existing, 

", ".join(domains), 

br=os.linesep) 

if config.expand or config.renew_by_default or zope.component.getUtility( 

interfaces.IDisplay).yesno(question, "Expand", "Cancel", 

cli_flag="--expand", 

force_interactive=True): 

return "renew", cert 

else: 

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

reporter_util.add_message( 

"To obtain a new certificate that contains these names without " 

"replacing your existing certificate for {0}, you must use the " 

"--duplicate option.{br}{br}" 

"For example:{br}{br}{1} --duplicate {2}".format( 

existing, 

sys.argv[0], " ".join(sys.argv[1:]), 

br=os.linesep 

), 

reporter_util.HIGH_PRIORITY) 

raise errors.Error(USER_CANCELLED) 

 

 

def _handle_identical_cert_request(config, lineage): 

"""Figure out what to do if a lineage has the same names as a previously obtained one 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param lineage: Certificate lineage object 

:type lineage: storage.RenewableCert 

 

:returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname 

action can be: "newcert" | "renew" | "reinstall" 

:rtype: `tuple` of `str` 

 

""" 

if not lineage.ensure_deployed(): 

return "reinstall", lineage 

if renewal.should_renew(config, lineage): 

return "renew", lineage 

if config.reinstall: 

# Set with --reinstall, force an identical certificate to be 

# reinstalled without further prompting. 

return "reinstall", lineage 

question = ( 

"You have an existing certificate that has exactly the same " 

"domains or certificate name you requested and isn't close to expiry." 

"{br}(ref: {0}){br}{br}What would you like to do?" 

).format(lineage.configfile.filename, br=os.linesep) 

 

if config.verb == "run": 

keep_opt = "Attempt to reinstall this existing certificate" 

elif config.verb == "certonly": 

keep_opt = "Keep the existing certificate for now" 

choices = [keep_opt, 

"Renew & replace the cert (limit ~5 per 7 days)"] 

 

display = zope.component.getUtility(interfaces.IDisplay) 

response = display.menu(question, choices, 

default=0, force_interactive=True) 

if response[0] == display_util.CANCEL: 

# TODO: Add notification related to command-line options for 

# skipping the menu for this case. 

raise errors.Error( 

"Operation canceled. You may re-run the client.") 

elif response[1] == 0: 

return "reinstall", lineage 

elif response[1] == 1: 

return "renew", lineage 

else: 

assert False, "This is impossible" 

 

def _find_lineage_for_domains(config, domains): 

"""Determine whether there are duplicated names and how to handle 

them (renew, reinstall, newcert, or raising an error to stop 

the client run if the user chooses to cancel the operation when 

prompted). 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param domains: List of domain names 

:type domains: `list` of `str` 

 

:returns: Two-element tuple containing desired new-certificate behavior as 

a string token ("reinstall", "renew", or "newcert"), plus either 

a RenewableCert instance or `None` if renewal shouldn't occur. 

:rtype: `tuple` of `str` and :class:`storage.RenewableCert` or `None` 

 

:raises errors.Error: If the user would like to rerun the client again. 

 

""" 

# Considering the possibility that the requested certificate is 

# related to an existing certificate. (config.duplicate, which 

# is set with --duplicate, skips all of this logic and forces any 

# kind of certificate to be obtained with renewal = False.) 

if config.duplicate: 

return "newcert", None 

# TODO: Also address superset case 

ident_names_cert, subset_names_cert = cert_manager.find_duplicative_certs(config, domains) 

# XXX ^ schoen is not sure whether that correctly reads the systemwide 

# configuration file. 

if ident_names_cert is None and subset_names_cert is None: 

return "newcert", None 

 

if ident_names_cert is not None: 

return _handle_identical_cert_request(config, ident_names_cert) 

elif subset_names_cert is not None: 

return _handle_subset_cert_request(config, domains, subset_names_cert) 

 

def _find_cert(config, domains, certname): 

"""Finds an existing certificate object given domains and/or a certificate name. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param domains: List of domain names 

:type domains: `list` of `str` 

 

:param certname: Name of certificate 

:type certname: str 

 

:returns: Two-element tuple of a boolean that indicates if this function should be 

followed by a call to fetch a certificate from the server, and either a 

RenewableCert instance or None. 

:rtype: `tuple` of `bool` and :class:`storage.RenewableCert` or `None` 

 

""" 

action, lineage = _find_lineage_for_domains_and_certname(config, domains, certname) 

if action == "reinstall": 

logger.info("Keeping the existing certificate") 

return (action != "reinstall"), lineage 

 

def _find_lineage_for_domains_and_certname(config, domains, certname): 

"""Find appropriate lineage based on given domains and/or certname. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param domains: List of domain names 

:type domains: `list` of `str` 

 

:param certname: Name of certificate 

:type certname: str 

 

:returns: Two-element tuple containing desired new-certificate behavior as 

a string token ("reinstall", "renew", or "newcert"), plus either 

a RenewableCert instance or None if renewal should not occur. 

 

:rtype: `tuple` of `str` and :class:`storage.RenewableCert` or `None` 

 

:raises errors.Error: If the user would like to rerun the client again. 

 

""" 

if not certname: 

return _find_lineage_for_domains(config, domains) 

else: 

lineage = cert_manager.lineage_for_certname(config, certname) 

if lineage: 

if domains: 

if set(cert_manager.domains_for_certname(config, certname)) != set(domains): 

_ask_user_to_confirm_new_names(config, domains, certname, 

lineage.names()) # raises if no 

return "renew", lineage 

# unnecessarily specified domains or no domains specified 

return _handle_identical_cert_request(config, lineage) 

else: 

if domains: 

return "newcert", None 

else: 

raise errors.ConfigurationError("No certificate with name {0} found. " 

"Use -d to specify domains, or run certbot certificates to see " 

"possible certificate names.".format(certname)) 

 

def _get_added_removed(after, before): 

"""Get lists of items removed from `before` 

and a lists of items added to `after` 

""" 

added = list(set(after) - set(before)) 

removed = list(set(before) - set(after)) 

added.sort() 

removed.sort() 

return added, removed 

 

def _format_list(character, strings): 

"""Format list with given character 

""" 

if len(strings) == 0: 

formatted = "{br}(None)" 

else: 

formatted = "{br}{ch} " + "{br}{ch} ".join(strings) 

return formatted.format( 

ch=character, 

br=os.linesep 

) 

 

def _ask_user_to_confirm_new_names(config, new_domains, certname, old_domains): 

"""Ask user to confirm update cert certname to contain new_domains. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param new_domains: List of new domain names 

:type new_domains: `list` of `str` 

 

:param certname: Name of certificate 

:type certname: str 

 

:param old_domains: List of old domain names 

:type old_domains: `list` of `str` 

 

:returns: None 

:rtype: None 

 

:raises errors.ConfigurationError: if cert name and domains mismatch 

 

""" 

if config.renew_with_new_domains: 

return 

 

added, removed = _get_added_removed(new_domains, old_domains) 

 

msg = ("You are updating certificate {0} to include new domain(s): {1}{br}{br}" 

"You are also removing previously included domain(s): {2}{br}{br}" 

"Did you intend to make this change?".format( 

certname, 

_format_list("+", added), 

_format_list("-", removed), 

br=os.linesep)) 

obj = zope.component.getUtility(interfaces.IDisplay) 

if not obj.yesno(msg, "Update cert", "Cancel", default=True): 

raise errors.ConfigurationError("Specified mismatched cert name and domains.") 

 

def _find_domains_or_certname(config, installer, question=None): 

"""Retrieve domains and certname from config or user input. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param installer: Installer object 

:type installer: interfaces.IInstaller 

 

:param `str` question: Overriding dialog question to ask the user if asked 

to choose from domain names. 

 

:returns: Two-part tuple of domains and certname 

:rtype: `tuple` of list of `str` and `str` 

 

:raises errors.Error: Usage message, if parameters are not used correctly 

 

""" 

domains = None 

certname = config.certname 

# first, try to get domains from the config 

if config.domains: 

domains = config.domains 

# if we can't do that but we have a certname, get the domains 

# with that certname 

elif certname: 

domains = cert_manager.domains_for_certname(config, certname) 

 

# that certname might not have existed, or there was a problem. 

# try to get domains from the user. 

if not domains: 

domains = display_ops.choose_names(installer, question) 

 

if not domains and not certname: 

raise errors.Error("Please specify --domains, or --installer that " 

"will help in domain names autodiscovery, or " 

"--cert-name for an existing certificate name.") 

 

return domains, certname 

 

 

def _report_new_cert(config, cert_path, fullchain_path, key_path=None): 

"""Reports the creation of a new certificate to the user. 

 

:param cert_path: path to certificate 

:type cert_path: str 

 

:param fullchain_path: path to full chain 

:type fullchain_path: str 

 

:param key_path: path to private key, if available 

:type key_path: str 

 

:returns: `None` 

:rtype: None 

 

""" 

if config.dry_run: 

_report_successful_dry_run(config) 

return 

 

assert cert_path and fullchain_path, "No certificates saved to report." 

 

expiry = crypto_util.notAfter(cert_path).date() 

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

# Print the path to fullchain.pem because that's what modern webservers 

# (Nginx and Apache2.4) will want. 

 

verbswitch = ' with the "certonly" option' if config.verb == "run" else "" 

privkey_statement = 'Your key file has been saved at:{br}{0}{br}'.format( 

key_path, br=os.linesep) if key_path else "" 

# XXX Perhaps one day we could detect the presence of known old webservers 

# and say something more informative here. 

msg = ('Congratulations! Your certificate and chain have been saved at:{br}' 

'{0}{br}{1}' 

'Your cert will expire on {2}. To obtain a new or tweaked version of this ' 

'certificate in the future, simply run {3} again{4}. ' 

'To non-interactively renew *all* of your certificates, run "{3} renew"' 

.format(fullchain_path, privkey_statement, expiry, cli.cli_command, verbswitch, 

br=os.linesep)) 

reporter_util.add_message(msg, reporter_util.MEDIUM_PRIORITY) 

 

 

def _determine_account(config): 

"""Determine which account to use. 

 

If ``config.account`` is ``None``, it will be updated based on the 

user input. Same for ``config.email``. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:returns: Account and optionally ACME client API (biproduct of new 

registration). 

:rtype: tuple of :class:`certbot.account.Account` and :class:`acme.client.Client` 

 

:raises errors.Error: If unable to register an account with ACME server 

 

""" 

def _tos_cb(terms_of_service): 

if config.tos: 

return True 

msg = ("Please read the Terms of Service at {0}. You " 

"must agree in order to register with the ACME " 

"server at {1}".format( 

terms_of_service, config.server)) 

obj = zope.component.getUtility(interfaces.IDisplay) 

result = obj.yesno(msg, "Agree", "Cancel", 

cli_flag="--agree-tos", force_interactive=True) 

if not result: 

raise errors.Error( 

"Registration cannot proceed without accepting " 

"Terms of Service.") 

 

account_storage = account.AccountFileStorage(config) 

acme = None 

 

if config.account is not None: 

acc = account_storage.load(config.account) 

else: 

accounts = account_storage.find_all() 

if len(accounts) > 1: 

acc = display_ops.choose_account(accounts) 

elif len(accounts) == 1: 

acc = accounts[0] 

else: # no account registered yet 

if config.email is None and not config.register_unsafely_without_email: 

config.email = display_ops.get_email() 

try: 

acc, acme = client.register( 

config, account_storage, tos_cb=_tos_cb) 

except errors.MissingCommandlineFlag: 

raise 

except errors.Error: 

logger.debug("", exc_info=True) 

raise errors.Error( 

"Unable to register an account with ACME server") 

 

config.account = acc.id 

return acc, acme 

 

 

def _delete_if_appropriate(config): # pylint: disable=too-many-locals,too-many-branches 

"""Does the user want to delete their now-revoked certs? If run in non-interactive mode, 

deleting happens automatically. 

 

:param config: parsed command line arguments 

:type config: interfaces.IConfig 

 

:returns: `None` 

:rtype: None 

 

:raises errors.Error: If anything goes wrong, including bad user input, if an overlapping 

archive dir is found for the specified lineage, etc ... 

""" 

display = zope.component.getUtility(interfaces.IDisplay) 

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

 

attempt_deletion = config.delete_after_revoke 

if attempt_deletion is None: 

msg = ("Would you like to delete the cert(s) you just revoked, along with all earlier and " 

"later versions of the cert?") 

attempt_deletion = display.yesno(msg, yes_label="Yes (recommended)", no_label="No", 

force_interactive=True, default=True) 

 

if not attempt_deletion: 

reporter_util.add_message("Not deleting revoked certs.", reporter_util.LOW_PRIORITY) 

return 

 

# config.cert_path must have been set 

# config.certname may have been set 

assert config.cert_path 

 

if not config.certname: 

config.certname = cert_manager.cert_path_to_lineage(config) 

 

# don't delete if the archive_dir is used by some other lineage 

archive_dir = storage.full_archive_path( 

configobj.ConfigObj(storage.renewal_file_for_certname(config, config.certname)), 

config, config.certname) 

try: 

cert_manager.match_and_check_overlaps(config, [lambda x: archive_dir], 

lambda x: x.archive_dir, lambda x: x) 

except errors.OverlappingMatchFound: 

msg = ('Not deleting revoked certs due to overlapping archive dirs. More than ' 

'one lineage is using {0}'.format(archive_dir)) 

reporter_util.add_message(''.join(msg), reporter_util.MEDIUM_PRIORITY) 

return 

except Exception as e: 

msg = ('config.default_archive_dir: {0}, config.live_dir: {1}, archive_dir: {2},' 

'original exception: {3}') 

msg = msg.format(config.default_archive_dir, config.live_dir, archive_dir, e) 

raise errors.Error(msg) 

 

cert_manager.delete(config) 

 

 

def _init_le_client(config, authenticator, installer): 

"""Initialize Let's Encrypt Client 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param authenticator: Acme authentication handler 

:type authenticator: interfaces.IAuthenticator 

:param installer: Installer object 

:type installer: interfaces.IInstaller 

 

:returns: client: Client object 

:rtype: client.Client 

 

""" 

if authenticator is not None: 

# if authenticator was given, then we will need account... 

acc, acme = _determine_account(config) 

logger.debug("Picked account: %r", acc) 

# XXX 

#crypto_util.validate_key_csr(acc.key) 

else: 

acc, acme = None, None 

 

return client.Client(config, acc, authenticator, installer, acme=acme) 

 

 

def unregister(config, unused_plugins): 

"""Deactivate account on server 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

account_storage = account.AccountFileStorage(config) 

accounts = account_storage.find_all() 

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

 

if not accounts: 

return "Could not find existing account to deactivate." 

yesno = zope.component.getUtility(interfaces.IDisplay).yesno 

prompt = ("Are you sure you would like to irrevocably deactivate " 

"your account?") 

wants_deactivate = yesno(prompt, yes_label='Deactivate', no_label='Abort', 

default=True) 

 

if not wants_deactivate: 

return "Deactivation aborted." 

 

acc, acme = _determine_account(config) 

cb_client = client.Client(config, acc, None, None, acme=acme) 

 

# delete on boulder 

cb_client.acme.deactivate_registration(acc.regr) 

account_files = account.AccountFileStorage(config) 

# delete local account files 

account_files.delete(config.account) 

 

reporter_util.add_message("Account deactivated.", reporter_util.MEDIUM_PRIORITY) 

 

 

def register(config, unused_plugins): 

"""Create accounts on the server. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` or a string indicating and error 

:rtype: None or str 

 

""" 

# TODO: When `certbot register --update-registration` is fully deprecated, 

# delete the true case of if block 

if config.update_registration: 

msg = ("Usage 'certbot register --update-registration' is deprecated.\n" 

"Please use 'cerbot update_account [options]' instead.\n") 

logger.warning(msg) 

return update_account(config, unused_plugins) 

 

# Portion of _determine_account logic to see whether accounts already 

# exist or not. 

account_storage = account.AccountFileStorage(config) 

accounts = account_storage.find_all() 

 

if len(accounts) > 0: 

# TODO: add a flag to register a duplicate account (this will 

# also require extending _determine_account's behavior 

# or else extracting the registration code from there) 

return ("There is an existing account; registration of a " 

"duplicate account with this command is currently " 

"unsupported.") 

# _determine_account will register an account 

_determine_account(config) 

return 

 

 

def update_account(config, unused_plugins): 

"""Modify accounts on the server. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` or a string indicating and error 

:rtype: None or str 

 

""" 

# Portion of _determine_account logic to see whether accounts already 

# exist or not. 

account_storage = account.AccountFileStorage(config) 

accounts = account_storage.find_all() 

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

add_msg = lambda m: reporter_util.add_message(m, reporter_util.MEDIUM_PRIORITY) 

 

if len(accounts) == 0: 

return "Could not find an existing account to update." 

if config.email is None: 

if config.register_unsafely_without_email: 

return ("--register-unsafely-without-email provided, however, a " 

"new e-mail address must\ncurrently be provided when " 

"updating a registration.") 

config.email = display_ops.get_email(optional=False) 

 

acc, acme = _determine_account(config) 

cb_client = client.Client(config, acc, None, None, acme=acme) 

# We rely on an exception to interrupt this process if it didn't work. 

acc_contacts = ['mailto:' + email for email in config.email.split(',')] 

prev_regr_uri = acc.regr.uri 

acc.regr = cb_client.acme.update_registration(acc.regr.update( 

body=acc.regr.body.update(contact=acc_contacts))) 

# A v1 account being used as a v2 account will result in changing the uri to 

# the v2 uri. Since it's the same object on disk, put it back to the v1 uri 

# so that we can also continue to use the account object with acmev1. 

acc.regr = acc.regr.update(uri=prev_regr_uri) 

account_storage.save_regr(acc, cb_client.acme) 

eff.handle_subscription(config) 

add_msg("Your e-mail address was updated to {0}.".format(config.email)) 

 

def _install_cert(config, le_client, domains, lineage=None): 

"""Install a cert 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param le_client: Client object 

:type le_client: client.Client 

 

:param domains: List of domains 

:type domains: `list` of `str` 

 

:param lineage: Certificate lineage object. Defaults to `None` 

:type lineage: storage.RenewableCert 

 

:returns: `None` 

:rtype: None 

 

""" 

path_provider = lineage if lineage else config 

assert path_provider.cert_path is not None 

 

le_client.deploy_certificate(domains, path_provider.key_path, 

path_provider.cert_path, path_provider.chain_path, path_provider.fullchain_path) 

le_client.enhance_config(domains, path_provider.chain_path) 

 

def install(config, plugins): 

"""Install a previously obtained cert in a server. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param plugins: List of plugins 

:type plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

# XXX: Update for renewer/RenewableCert 

# FIXME: be consistent about whether errors are raised or returned from 

# this function ... 

 

try: 

installer, _ = plug_sel.choose_configurator_plugins(config, plugins, "install") 

except errors.PluginSelectionError as e: 

return str(e) 

 

custom_cert = (config.key_path and config.cert_path) 

if not config.certname and not custom_cert: 

certname_question = "Which certificate would you like to install?" 

config.certname = cert_manager.get_certnames( 

config, "install", allow_multiple=False, 

custom_prompt=certname_question)[0] 

 

if not enhancements.are_supported(config, installer): 

raise errors.NotSupportedError("One ore more of the requested enhancements " 

"are not supported by the selected installer") 

# If cert-path is defined, populate missing (ie. not overridden) values. 

# Unfortunately this can't be done in argument parser, as certificate 

# manager needs the access to renewal directory paths 

if config.certname: 

config = _populate_from_certname(config) 

elif enhancements.are_requested(config): 

# Preflight config check 

raise errors.ConfigurationError("One or more of the requested enhancements " 

"require --cert-name to be provided") 

 

if config.key_path and config.cert_path: 

_check_certificate_and_key(config) 

domains, _ = _find_domains_or_certname(config, installer) 

le_client = _init_le_client(config, authenticator=None, installer=installer) 

_install_cert(config, le_client, domains) 

else: 

raise errors.ConfigurationError("Path to certificate or key was not defined. " 

"If your certificate is managed by Certbot, please use --cert-name " 

"to define which certificate you would like to install.") 

 

if enhancements.are_requested(config): 

# In the case where we don't have certname, we have errored out already 

lineage = cert_manager.lineage_for_certname(config, config.certname) 

enhancements.enable(lineage, domains, installer, config) 

 

def _populate_from_certname(config): 

"""Helper function for install to populate missing config values from lineage 

defined by --cert-name.""" 

 

lineage = cert_manager.lineage_for_certname(config, config.certname) 

if not lineage: 

return config 

if not config.key_path: 

config.namespace.key_path = lineage.key_path 

if not config.cert_path: 

config.namespace.cert_path = lineage.cert_path 

if not config.chain_path: 

config.namespace.chain_path = lineage.chain_path 

if not config.fullchain_path: 

config.namespace.fullchain_path = lineage.fullchain_path 

return config 

 

def _check_certificate_and_key(config): 

if not os.path.isfile(os.path.realpath(config.cert_path)): 

raise errors.ConfigurationError("Error while reading certificate from path " 

"{0}".format(config.cert_path)) 

if not os.path.isfile(os.path.realpath(config.key_path)): 

raise errors.ConfigurationError("Error while reading private key from path " 

"{0}".format(config.key_path)) 

def plugins_cmd(config, plugins): 

"""List server software plugins. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param plugins: List of plugins 

:type plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

logger.debug("Expected interfaces: %s", config.ifaces) 

 

ifaces = [] if config.ifaces is None else config.ifaces 

filtered = plugins.visible().ifaces(ifaces) 

logger.debug("Filtered plugins: %r", filtered) 

 

notify = functools.partial(zope.component.getUtility( 

interfaces.IDisplay).notification, pause=False) 

if not config.init and not config.prepare: 

notify(str(filtered)) 

return 

 

filtered.init(config) 

verified = filtered.verify(ifaces) 

logger.debug("Verified plugins: %r", verified) 

 

if not config.prepare: 

notify(str(verified)) 

return 

 

verified.prepare() 

available = verified.available() 

logger.debug("Prepared plugins: %s", available) 

notify(str(available)) 

 

def enhance(config, plugins): 

"""Add security enhancements to existing configuration 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param plugins: List of plugins 

:type plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

supported_enhancements = ["hsts", "redirect", "uir", "staple"] 

# Check that at least one enhancement was requested on command line 

oldstyle_enh = any([getattr(config, enh) for enh in supported_enhancements]) 

if not enhancements.are_requested(config) and not oldstyle_enh: 

msg = ("Please specify one or more enhancement types to configure. To list " 

"the available enhancement types, run:\n\n%s --help enhance\n") 

logger.warning(msg, sys.argv[0]) 

raise errors.MisconfigurationError("No enhancements requested, exiting.") 

 

try: 

installer, _ = plug_sel.choose_configurator_plugins(config, plugins, "enhance") 

except errors.PluginSelectionError as e: 

return str(e) 

 

if not enhancements.are_supported(config, installer): 

raise errors.NotSupportedError("One ore more of the requested enhancements " 

"are not supported by the selected installer") 

 

certname_question = ("Which certificate would you like to use to enhance " 

"your configuration?") 

config.certname = cert_manager.get_certnames( 

config, "enhance", allow_multiple=False, 

custom_prompt=certname_question)[0] 

cert_domains = cert_manager.domains_for_certname(config, config.certname) 

if config.noninteractive_mode: 

domains = cert_domains 

else: 

domain_question = ("Which domain names would you like to enable the " 

"selected enhancements for?") 

domains = display_ops.choose_values(cert_domains, domain_question) 

if not domains: 

raise errors.Error("User cancelled the domain selection. No domains " 

"defined, exiting.") 

 

lineage = cert_manager.lineage_for_certname(config, config.certname) 

if not config.chain_path: 

config.chain_path = lineage.chain_path 

if oldstyle_enh: 

le_client = _init_le_client(config, authenticator=None, installer=installer) 

le_client.enhance_config(domains, config.chain_path, ask_redirect=False) 

if enhancements.are_requested(config): 

enhancements.enable(lineage, domains, installer, config) 

 

 

def rollback(config, plugins): 

"""Rollback server configuration changes made during install. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param plugins: List of plugins 

:type plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

client.rollback(config.installer, config.checkpoints, config, plugins) 

 

 

def config_changes(config, unused_plugins): 

"""Show changes made to server config during installation 

 

View checkpoints and associated configuration changes. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

client.view_config_changes(config, num=config.num) 

 

def update_symlinks(config, unused_plugins): 

"""Update the certificate file family symlinks 

 

Use the information in the config file to make symlinks point to 

the correct archive directory. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

cert_manager.update_live_symlinks(config) 

 

def rename(config, unused_plugins): 

"""Rename a certificate 

 

Use the information in the config file to rename an existing 

lineage. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

cert_manager.rename_lineage(config) 

 

def delete(config, unused_plugins): 

"""Delete a certificate 

 

Use the information in the config file to delete an existing 

lineage. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

cert_manager.delete(config) 

 

def certificates(config, unused_plugins): 

"""Display information about certs configured with Certbot 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

cert_manager.certificates(config) 

 

def revoke(config, unused_plugins): # TODO: coop with renewal config 

"""Revoke a previously obtained certificate. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` or string indicating error in case of error 

:rtype: None or str 

 

""" 

# For user-agent construction 

config.installer = config.authenticator = None 

 

if config.cert_path is None and config.certname: 

config.cert_path = storage.cert_path_for_cert_name(config, config.certname) 

elif not config.cert_path or (config.cert_path and config.certname): 

# intentionally not supporting --cert-path & --cert-name together, 

# to avoid dealing with mismatched values 

raise errors.Error("Error! Exactly one of --cert-path or --cert-name must be specified!") 

 

if config.key_path is not None: # revocation by cert key 

logger.debug("Revoking %s using cert key %s", 

config.cert_path[0], config.key_path[0]) 

crypto_util.verify_cert_matches_priv_key(config.cert_path[0], config.key_path[0]) 

key = jose.JWK.load(config.key_path[1]) 

acme = client.acme_from_config_key(config, key) 

else: # revocation by account key 

logger.debug("Revoking %s using Account Key", config.cert_path[0]) 

acc, _ = _determine_account(config) 

acme = client.acme_from_config_key(config, acc.key, acc.regr) 

cert = crypto_util.pyopenssl_load_certificate(config.cert_path[1])[0] 

logger.debug("Reason code for revocation: %s", config.reason) 

try: 

acme.revoke(jose.ComparableX509(cert), config.reason) 

_delete_if_appropriate(config) 

except acme_errors.ClientError as e: 

return str(e) 

 

display_ops.success_revocation(config.cert_path[0]) 

 

 

def run(config, plugins): # pylint: disable=too-many-branches,too-many-locals 

"""Obtain a certificate and install. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param plugins: List of plugins 

:type plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

# TODO: Make run as close to auth + install as possible 

# Possible difficulties: config.csr was hacked into auth 

try: 

installer, authenticator = plug_sel.choose_configurator_plugins(config, plugins, "run") 

except errors.PluginSelectionError as e: 

return str(e) 

 

# Preflight check for enhancement support by the selected installer 

if not enhancements.are_supported(config, installer): 

raise errors.NotSupportedError("One ore more of the requested enhancements " 

"are not supported by the selected installer") 

 

# TODO: Handle errors from _init_le_client? 

le_client = _init_le_client(config, authenticator, installer) 

 

domains, certname = _find_domains_or_certname(config, installer) 

should_get_cert, lineage = _find_cert(config, domains, certname) 

 

new_lineage = lineage 

if should_get_cert: 

new_lineage = _get_and_save_cert(le_client, config, domains, 

certname, lineage) 

 

cert_path = new_lineage.cert_path if new_lineage else None 

fullchain_path = new_lineage.fullchain_path if new_lineage else None 

key_path = new_lineage.key_path if new_lineage else None 

_report_new_cert(config, cert_path, fullchain_path, key_path) 

 

_install_cert(config, le_client, domains, new_lineage) 

 

if enhancements.are_requested(config) and new_lineage: 

enhancements.enable(new_lineage, domains, installer, config) 

 

if lineage is None or not should_get_cert: 

display_ops.success_installation(domains) 

else: 

display_ops.success_renewal(domains) 

 

_suggest_donation_if_appropriate(config) 

 

 

def _csr_get_and_save_cert(config, le_client): 

"""Obtain a cert using a user-supplied CSR 

 

This works differently in the CSR case (for now) because we don't 

have the privkey, and therefore can't construct the files for a lineage. 

So we just save the cert & chain to disk :/ 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param client: Client object 

:type client: client.Client 

 

:returns: `cert_path` and `fullchain_path` as absolute paths to the actual files 

:rtype: `tuple` of `str` 

 

""" 

csr, _ = config.actual_csr 

cert, chain = le_client.obtain_certificate_from_csr(csr) 

if config.dry_run: 

logger.debug( 

"Dry run: skipping saving certificate to %s", config.cert_path) 

return None, None 

cert_path, _, fullchain_path = le_client.save_certificate( 

cert, chain, os.path.normpath(config.cert_path), 

os.path.normpath(config.chain_path), os.path.normpath(config.fullchain_path)) 

return cert_path, fullchain_path 

 

def renew_cert(config, plugins, lineage): 

"""Renew & save an existing cert. Do not install it. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param plugins: List of plugins 

:type plugins: `list` of `str` 

 

:param lineage: Certificate lineage object 

:type lineage: storage.RenewableCert 

 

:returns: `None` 

:rtype: None 

 

:raises errors.PluginSelectionError: MissingCommandlineFlag if supplied parameters do not pass 

 

""" 

try: 

# installers are used in auth mode to determine domain names 

installer, auth = plug_sel.choose_configurator_plugins(config, plugins, "certonly") 

except errors.PluginSelectionError as e: 

logger.info("Could not choose appropriate plugin: %s", e) 

raise 

le_client = _init_le_client(config, auth, installer) 

 

renewed_lineage = _get_and_save_cert(le_client, config, lineage=lineage) 

 

notify = zope.component.getUtility(interfaces.IDisplay).notification 

if installer is None: 

notify("new certificate deployed without reload, fullchain is {0}".format( 

lineage.fullchain), pause=False) 

else: 

# In case of a renewal, reload server to pick up new certificate. 

# In principle we could have a configuration option to inhibit this 

# from happening. 

# Run deployer 

updater.run_renewal_deployer(config, renewed_lineage, installer) 

installer.restart() 

notify("new certificate deployed with reload of {0} server; fullchain is {1}".format( 

config.installer, lineage.fullchain), pause=False) 

 

def certonly(config, plugins): 

"""Authenticate & obtain cert, but do not install it. 

 

This implements the 'certonly' subcommand. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param plugins: List of plugins 

:type plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

:raises errors.Error: If specified plugin could not be used 

 

""" 

# SETUP: Select plugins and construct a client instance 

try: 

# installers are used in auth mode to determine domain names 

installer, auth = plug_sel.choose_configurator_plugins(config, plugins, "certonly") 

except errors.PluginSelectionError as e: 

logger.info("Could not choose appropriate plugin: %s", e) 

raise 

 

le_client = _init_le_client(config, auth, installer) 

 

if config.csr: 

cert_path, fullchain_path = _csr_get_and_save_cert(config, le_client) 

_report_new_cert(config, cert_path, fullchain_path) 

_suggest_donation_if_appropriate(config) 

return 

 

domains, certname = _find_domains_or_certname(config, installer) 

should_get_cert, lineage = _find_cert(config, domains, certname) 

 

if not should_get_cert: 

notify = zope.component.getUtility(interfaces.IDisplay).notification 

notify("Certificate not yet due for renewal; no action taken.", pause=False) 

return 

 

lineage = _get_and_save_cert(le_client, config, domains, certname, lineage) 

 

cert_path = lineage.cert_path if lineage else None 

fullchain_path = lineage.fullchain_path if lineage else None 

key_path = lineage.key_path if lineage else None 

_report_new_cert(config, cert_path, fullchain_path, key_path) 

_suggest_donation_if_appropriate(config) 

 

def renew(config, unused_plugins): 

"""Renew previously-obtained certificates. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:param unused_plugins: List of plugins (deprecated) 

:type unused_plugins: `list` of `str` 

 

:returns: `None` 

:rtype: None 

 

""" 

try: 

renewal.handle_renewal_request(config) 

finally: 

hooks.run_saved_post_hooks() 

 

 

def make_or_verify_needed_dirs(config): 

"""Create or verify existence of config, work, and hook directories. 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:returns: `None` 

:rtype: None 

 

""" 

util.set_up_core_dir(config.config_dir, constants.CONFIG_DIRS_MODE, 

compat.os_geteuid(), config.strict_permissions) 

util.set_up_core_dir(config.work_dir, constants.CONFIG_DIRS_MODE, 

compat.os_geteuid(), config.strict_permissions) 

 

hook_dirs = (config.renewal_pre_hooks_dir, 

config.renewal_deploy_hooks_dir, 

config.renewal_post_hooks_dir,) 

for hook_dir in hook_dirs: 

util.make_or_verify_dir(hook_dir, 

uid=compat.os_geteuid(), 

strict=config.strict_permissions) 

 

 

def set_displayer(config): 

"""Set the displayer 

 

:param config: Configuration object 

:type config: interfaces.IConfig 

 

:returns: `None` 

:rtype: None 

 

""" 

if config.quiet: 

config.noninteractive_mode = True 

displayer = display_util.NoninteractiveDisplay(open(os.devnull, "w")) \ 

# type: Union[None, display_util.NoninteractiveDisplay, display_util.FileDisplay] 

elif config.noninteractive_mode: 

displayer = display_util.NoninteractiveDisplay(sys.stdout) 

else: 

displayer = display_util.FileDisplay(sys.stdout, 

config.force_interactive) 

zope.component.provideUtility(displayer) 

 

 

def main(cli_args=sys.argv[1:]): 

"""Command line argument parsing and main script execution. 

 

:returns: result of requested command 

 

:raises errors.Error: OS errors triggered by wrong permissions 

:raises errors.Error: error if plugin command is not supported 

 

""" 

 

log.pre_arg_parse_setup() 

 

plugins = plugins_disco.PluginsRegistry.find_all() 

logger.debug("certbot version: %s", certbot.__version__) 

# do not log `config`, as it contains sensitive data (e.g. revoke --key)! 

logger.debug("Arguments: %r", cli_args) 

logger.debug("Discovered plugins: %r", plugins) 

 

# note: arg parser internally handles --help (and exits afterwards) 

args = cli.prepare_and_parse_args(plugins, cli_args) 

config = configuration.NamespaceConfig(args) 

zope.component.provideUtility(config) 

 

# On windows, shell without administrative right cannot create symlinks required by certbot. 

# So we check the rights before continuing. 

compat.raise_for_non_administrative_windows_rights(config.verb) 

 

try: 

log.post_arg_parse_setup(config) 

make_or_verify_needed_dirs(config) 

except errors.Error: 

# Let plugins_cmd be run as un-privileged user. 

if config.func != plugins_cmd: 

raise 

 

set_displayer(config) 

 

# Reporter 

report = reporter.Reporter(config) 

zope.component.provideUtility(report) 

util.atexit_register(report.print_messages) 

 

return config.func(config, plugins) 

 

 

if __name__ == "__main__": 

err_string = main() 

if err_string: 

logger.warning("Exiting with message %s", err_string) 

sys.exit(err_string) # pragma: no cover