core.js 25.7 KB
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
'use strict';
/*global Promise*/
require('./compat.js');

var util = require('util');
function promisifyAll(obj) {
	var aobj = {};
	Object.keys(obj).forEach(function(key) {
		if ('function' === typeof obj[key]) {
			aobj[key] = obj[key];
			aobj[key + 'Async'] = util.promisify(obj[key]);
		}
	});
	return aobj;
}

function _log(debug) {
	if (debug) {
		var args = Array.prototype.slice.call(arguments);
		args.shift();
		args.unshift('[greenlock/lib/core.js]');
		console.log.apply(console, args);
	}
}

module.exports.create = function(gl) {
	var utils = require('./utils');
	var RSA = promisifyAll(require('rsa-compat').RSA);
	var log = gl.log || _log; // allow custom log
	var pendingRegistrations = {};

	var core = {
		//
		// Helpers
		//
		getAcmeUrlsAsync: function(args) {
			var now = Date.now();

			// TODO check response header on request for cache time
			if (now - gl._ipc.acmeUrlsUpdatedAt < 10 * 60 * 1000) {
				return Promise.resolve(gl._ipc.acmeUrls);
			}

			// TODO acme-v2/nocompat
			return gl.acme.getAcmeUrlsAsync(args.server).then(function(data) {
				gl._ipc.acmeUrlsUpdatedAt = Date.now();
				gl._ipc.acmeUrls = data;

				return gl._ipc.acmeUrls;
			});
		},

		//
		// The Main Enchilada
		//

		//
		// Accounts
		//
		accounts: {
			// Accounts
			registerAsync: function(args) {
				var err;
				var copy = utils.merge(args, gl);
				var disagreeTos;
				args = utils.tplCopy(copy);
				if (!args.account) {
					args.account = {};
				}
				if ('object' === typeof args.account && !args.account.id) {
					args.account.id = args.accountId || args.email || '';
				}

				disagreeTos =
					!args.agreeTos && 'undefined' !== typeof args.agreeTos;
				if (
					!args.email ||
					disagreeTos ||
					parseInt(args.rsaKeySize, 10) < 2048
				) {
					err = new Error(
						"In order to register an account both 'email' and 'agreeTos' must be present" +
							" and 'rsaKeySize' must be 2048 or greater."
					);
					err.code = 'E_ARGS';
					return Promise.reject(err);
				}

				return utils.testEmail(args.email).then(function() {
					if (
						args.account &&
						args.account.privkey &&
						(args.account.privkey.jwk || args.account.privkey.pem)
					) {
						// TODO import jwk or pem and return it here
						console.warn(
							'TODO: implement accounts.checkKeypairAsync skipping'
						);
					}
					var accountKeypair;
					var newAccountKeypair = true;
					var promise = gl.store.accounts
						.checkKeypairAsync(args)
						.then(function(keypair) {
							if (keypair) {
								// TODO keypairs
								newAccountKeypair = false;
								accountKeypair = RSA.import(keypair);
								return;
							}

							if (args.accountKeypair) {
								// TODO keypairs
								accountKeypair = RSA.import(
									args.accountKeypair
								);
								return;
							}

							var keypairOpts = {
								bitlen: args.rsaKeySize,
								exp: 65537,
								public: true,
								pem: true
							};
							// TODO keypairs
							return (args.generateKeypair ||
								RSA.generateKeypairAsync)(keypairOpts).then(
								function(keypair) {
									keypair.privateKeyPem = RSA.exportPrivatePem(
										keypair
									);
									keypair.publicKeyPem = RSA.exportPublicPem(
										keypair
									);
									keypair.privateKeyJwk = RSA.exportPrivateJwk(
										keypair
									);
									accountKeypair = keypair;
								}
							);
						})
						.then(function() {
							return accountKeypair;
						});

					return promise.then(function(keypair) {
						// Note: the ACME urls are always fetched fresh on purpose
						// TODO acme-v2/nocompat
						return core.getAcmeUrlsAsync(args).then(function(urls) {
							args._acmeUrls = urls;

							// TODO acme-v2/nocompat
							return gl.acme
								.registerNewAccountAsync({
									email: args.email,
									newRegUrl: args._acmeUrls.newReg,
									newAuthzUrl: args._acmeUrls.newAuthz,
									agreeToTerms: function(tosUrl, agreeCb) {
										if (
											true === args.agreeTos ||
											tosUrl === args.agreeTos ||
											tosUrl === gl.agreeToTerms
										) {
											agreeCb(null, tosUrl);
											return;
										}

										// args.email = email;      // already there
										// args.domains = domains   // already there
										args.tosUrl = tosUrl;
										gl.agreeToTerms(args, agreeCb);
									},
									accountKeypair: keypair,

									debug: gl.debug || args.debug
								})
								.then(function(receipt) {
									var reg = {
										keypair: keypair,
										receipt: receipt,
										kid:
											receipt &&
											receipt.key &&
											(receipt.key.kid || receipt.kid),
										email: args.email,
										newRegUrl: args._acmeUrls.newReg,
										newAuthzUrl: args._acmeUrls.newAuthz
									};

									var accountKeypairPromise;
									args.keypair = keypair;
									args.receipt = receipt;
									if (newAccountKeypair) {
										accountKeypairPromise = gl.store.accounts.setKeypairAsync(
											args,
											keypair
										);
									}
									return Promise.resolve(
										accountKeypairPromise
									).then(function() {
										// TODO move templating of arguments to right here?
										if (!gl.store.accounts.setAsync) {
											return Promise.resolve({
												keypair: keypair
											});
										}
										return gl.store.accounts
											.setAsync(args, reg)
											.then(function(account) {
												if (
													account &&
													'object' !== typeof account
												) {
													throw new Error(
														"store.accounts.setAsync should either return 'null' or an object with at least a string 'id'"
													);
												}
												if (!account) {
													account = {};
												}
												account.keypair = keypair;
												return account;
											});
									});
								});
						});
					});
				});
			},

			// Accounts
			// (only used for keypair)
			getAsync: function(args) {
				var accountPromise = null;
				if (gl.store.accounts.checkAsync) {
					accountPromise = core.accounts.checkAsync(args);
				}
				return Promise.resolve(accountPromise).then(function(account) {
					if (!account) {
						return core.accounts.registerAsync(args);
					}
					if (account.keypair) {
						return account;
					}

					if (!args.account) {
						args.account = {};
					}
					if ('object' === typeof args.account && !args.account.id) {
						args.account.id = args.accountId || args.email || '';
					}
					var copy = utils.merge(args, gl);
					args = utils.tplCopy(copy);
					return gl.store.accounts
						.checkKeypairAsync(args)
						.then(function(keypair) {
							if (keypair) {
								return { keypair: keypair };
							}
							return core.accounts.registerAsync(args);
						});
				});
			},

			// Accounts
			checkAsync: function(args) {
				var requiredArgs = ['accountId', 'email', 'domains', 'domain'];
				if (
					!(args.account && (args.account.id || args.account.kid)) &&
					!requiredArgs.some(function(key) {
						return -1 !== Object.keys(args).indexOf(key);
					})
				) {
					return Promise.reject(
						new Error(
							"In order to register or retrieve an account one of '" +
								requiredArgs.join("', '") +
								"' must be present"
						)
					);
				}

				var copy = utils.merge(args, gl);
				args = utils.tplCopy(copy);
				if (!args.account) {
					args.account = {};
				}
				if ('object' === typeof args.account && !args.account.id) {
					args.account.id = args.accountId || args.email || '';
				}

				// we can re-register the same account until we're blue in the face and it's all the same
				// of course, we can also skip the lookup if we do store the account, but whatever
				if (!gl.store.accounts.checkAsync) {
					return Promise.resolve(null);
				}
				return gl.store.accounts
					.checkAsync(args)
					.then(function(account) {
						if (!account) {
							return null;
						}

						args.account = account;
						args.accountId = account.id;

						return account;
					});
			}
		},

		certificates: {
			// Certificates
			registerAsync: function(args) {
				var err;
				var challengeDefaults =
					gl[
						'_challengeOpts_' +
							(args.challengeType || gl.challengeType)
					] || {};
				var copy = utils.merge(args, challengeDefaults || {});
				copy = utils.merge(copy, gl);
				if (!copy.subject) {
					copy.subject = copy.domains[0];
				}
				if (!copy.domain) {
					copy.domain = copy.domains[0];
				}
				args = utils.tplCopy(copy);

				if (!Array.isArray(args.domains)) {
					return Promise.reject(
						new Error('args.domains should be an array of domains')
					);
				}
				//if (-1 === args.domains.indexOf(args.subject)) // TODO relax the constraint once acme-v2 handles subject?
				if (args.subject !== args.domains[0]) {
					console.warn(
						"The certificate's subject (primary domain) should be first in the list of opts.domains"
					);
					console.warn(
						'\topts.subject: (set by you approveDomains(), falling back to opts.domain) ' +
							args.subject
					);
					console.warn(
						'\topts.domain: (set by SNICallback()) ' + args.domain
					);
					console.warn(
						'\topts.domains: (set by you in approveDomains()) ' +
							args.domains.join(',')
					);
					console.warn(
						'Updating your code will prevent weird, random, hard-to-repro bugs during renewals'
					);
					console.warn(
						'(also this will be required in the next major version of greenlock)'
					);
					//return Promise.reject(new Error('certificate subject (primary domain) must be the first in opts.domains'));
				}
				if (
					!(
						args.domains.length &&
						args.domains.every(utils.isValidDomain)
					)
				) {
					// NOTE: this library can't assume to handle the http loopback
					// (or dns-01 validation may be used)
					// so we do not check dns records or attempt a loopback here
					err = new Error(
						"invalid domain name(s): '(" +
							args.subject +
							') ' +
							args.domains.join(',') +
							"'"
					);
					err.code = 'INVALID_DOMAIN';
					return Promise.reject(err);
				}

				// If a previous request to (re)register a certificate is already underway we need
				// to return the same promise created before rather than registering things twice.
				// I'm not 100% sure how to properly handle the case where someone registers domain
				// lists with some but not all elements common, nor am I sure that's even a case that
				// is allowed to happen anyway. But for now we act like the list is completely the
				// same if any elements are the same.
				var promise;
				args.domains.some(function(name) {
					if (pendingRegistrations.hasOwnProperty(name)) {
						promise = pendingRegistrations[name];
						return true;
					}
				});
				if (promise) {
					return promise;
				}

				promise = core.certificates._runRegistration(args);

				// Now that the registration is actually underway we need to make sure any subsequent
				// registration attempts return the same promise until it is completed (but not after
				// it is completed).
				args.domains.forEach(function(name) {
					pendingRegistrations[name] = promise;
				});
				function clearPending() {
					args.domains.forEach(function(name) {
						delete pendingRegistrations[name];
					});
				}
				promise.then(clearPending, clearPending);

				return promise;
			},
			_runRegistration: function(args) {
				// TODO renewal cb
				// accountId and or email
				return core.accounts.getAsync(args).then(function(account) {
					args.account = account;

					if (
						args.certificate &&
						args.certificate.privkey &&
						(args.certificate.privkey.jwk ||
							args.certificate.privkey.pem)
					) {
						// TODO import jwk or pem and return it here
						console.warn(
							'TODO: implement certificates.checkKeypairAsync skipping'
						);
					}
					var domainKeypair;
					var newDomainKeypair = true;
					// This has been done in the getAsync already, so we skip it here
					// if approveDomains doesn't set subject, we set it here
					//args.subject = args.subject || args.domains[0];
					var promise = gl.store.certificates
						.checkKeypairAsync(args)
						.then(function(keypair) {
							if (keypair) {
								domainKeypair = RSA.import(keypair);
								newDomainKeypair = false;
								return;
							}

							if (args.domainKeypair) {
								domainKeypair = RSA.import(args.domainKeypair);
								return;
							}

							var keypairOpts = {
								bitlen: args.rsaKeySize,
								exp: 65537,
								public: true,
								pem: true
							};
							return (args.generateKeypair ||
								RSA.generateKeypairAsync)(keypairOpts).then(
								function(keypair) {
									keypair.privateKeyPem = RSA.exportPrivatePem(
										keypair
									);
									keypair.publicKeyPem = RSA.exportPublicPem(
										keypair
									);
									keypair.privateKeyJwk = RSA.exportPrivateJwk(
										keypair
									);
									domainKeypair = keypair;
								}
							);
						})
						.then(function() {
							return domainKeypair;
						});

					return promise
						.then(function(domainKeypair) {
							args.domainKeypair = domainKeypair;
							//args.registration = domainKey;

							// Note: the ACME urls are always fetched fresh on purpose
							// TODO is this the right place for this?
							return core
								.getAcmeUrlsAsync(args)
								.then(function(urls) {
									args._acmeUrls = urls;

									var certReq = {
										debug: args.debug || gl.debug,

										newAuthzUrl: args._acmeUrls.newAuthz,
										newCertUrl: args._acmeUrls.newCert,

										accountKeypair: RSA.import(
											account.keypair
										),
										domainKeypair: domainKeypair,
										subject: args.subject, // TODO handle this in acme-v2
										domains: args.domains,
										challengeTypes: Object.keys(
											args.challenges
										)
									};

									//
									// IMPORTANT
									//
									// setChallenge and removeChallenge are handed defaults
									// instead of args because getChallenge does not have
									// access to args
									// (args is per-request, defaults is per instance)
									//
									// Each of these fires individually for each domain,
									// even though the certificate on the whole may have many domains
									//
									certReq.setChallenge = function(
										challenge,
										done
									) {
										log(
											args.debug,
											"setChallenge called for '" +
												challenge.altname +
												"'"
										);
										// NOTE: First arg takes precedence
										var copy = utils.merge(
											{ domains: [challenge.altname] },
											args
										);
										copy = utils.merge(copy, gl);
										utils.tplCopy(copy);
										copy.challenge = challenge;

										if (
											1 ===
											copy.challenges[challenge.type].set
												.length
										) {
											copy.challenges[challenge.type]
												.set(copy)
												.then(function(result) {
													done(null, result);
												})
												.catch(done);
										} else if (
											2 ===
											copy.challenges[challenge.type].set
												.length
										) {
											copy.challenges[challenge.type].set(
												copy,
												done
											);
										} else {
											Object.keys(challenge).forEach(
												function(key) {
													done[key] = challenge[key];
												}
											);
											// regression bugfix for le-challenge-cloudflare
											// (_acme-challege => _greenlock-dryrun-XXXX)
											copy.acmePrefix =
												(
													challenge.dnsHost || ''
												).replace(/\.*/, '') ||
												copy.acmePrefix;
											copy.challenges[challenge.type].set(
												copy,
												challenge.altname,
												challenge.token,
												challenge.keyAuthorization,
												done
											);
										}
									};
									certReq.removeChallenge = function(
										challenge,
										done
									) {
										log(
											args.debug,
											"removeChallenge called for '" +
												challenge.altname +
												"'"
										);
										var copy = utils.merge(
											{ domains: [challenge.altname] },
											args
										);
										copy = utils.merge(copy, gl);
										utils.tplCopy(copy);
										copy.challenge = challenge;

										if (
											1 ===
											copy.challenges[challenge.type]
												.remove.length
										) {
											copy.challenges[challenge.type]
												.remove(copy)
												.then(function(result) {
													done(null, result);
												})
												.catch(done);
										} else if (
											2 ===
											copy.challenges[challenge.type]
												.remove.length
										) {
											copy.challenges[
												challenge.type
											].remove(copy, done);
										} else {
											Object.keys(challenge).forEach(
												function(key) {
													done[key] = challenge[key];
												}
											);
											copy.challenges[
												challenge.type
											].remove(
												copy,
												challenge.altname,
												challenge.token,
												done
											);
										}
									};
									certReq.init = function(deps) {
										var copy = utils.merge(deps, args);
										copy = utils.merge(copy, gl);
										utils.tplCopy(copy);

										Object.keys(copy.challenges).forEach(
											function(key) {
												if (
													'function' ===
													typeof copy.challenges[key]
														.init
												) {
													copy.challenges[key].init(
														copy
													);
												}
											}
										);

										return null;
									};
									certReq.getZones = function(challenge) {
										var copy = utils.merge(
											{
												dnsHosts: args.domains.map(
													function(x) {
														return 'xxxx.' + x;
													}
												)
											},
											args
										);
										copy = utils.merge(copy, gl);
										utils.tplCopy(copy);
										copy.challenge = challenge;

										if (
											!copy.challenges[challenge.type] ||
											'function' !==
												typeof copy.challenges[
													challenge.type
												].zones
										) {
											// may not be available, that's fine.
											return Promise.resolve([]);
										}

										return copy.challenges[
											challenge.type
										].zones(copy);
									};

									log(
										args.debug,
										'calling greenlock.acme.getCertificateAsync',
										certReq.subject,
										certReq.domains
									);

									// TODO acme-v2/nocompat
									return gl.acme
										.getCertificateAsync(certReq)
										.then(utils.attachCertInfo);
								});
						})
						.then(function(results) {
							//var requested = {};
							//var issued = {};
							// { cert, chain, privkey /*TODO, subject, altnames, issuedAt, expiresAt */ }

							// args.certs.privkey = RSA.exportPrivatePem(options.domainKeypair);
							args.certs = results;
							// args.pems is deprecated
							args.pems = results;
							// This has been done in the getAsync already, so we skip it here
							// if approveDomains doesn't set subject, we set it here
							//args.subject = args.subject || args.domains[0];
							var promise;
							if (newDomainKeypair) {
								args.keypair = domainKeypair;
								promise = gl.store.certificates.setKeypairAsync(
									args,
									domainKeypair
								);
							}
							return Promise.resolve(promise).then(function() {
								return gl.store.certificates
									.setAsync(args)
									.then(function() {
										return results;
									});
							});
						});
				});
			},
			// Certificates
			renewAsync: function(args, certs) {
				var renewableAt = core.certificates._getRenewableAt(
					args,
					certs
				);
				var err;
				//var halfLife = (certs.expiresAt - certs.issuedAt) / 2;
				//var renewable = (Date.now() - certs.issuedAt) > halfLife;

				log(
					args.debug,
					'(Renew) Expires At',
					new Date(certs.expiresAt).toISOString()
				);
				log(
					args.debug,
					'(Renew) Renewable At',
					new Date(renewableAt).toISOString()
				);

				if (!args.duplicate && Date.now() < renewableAt) {
					err = new Error(
						"[ERROR] Certificate issued at '" +
							new Date(certs.issuedAt).toISOString() +
							"' and expires at '" +
							new Date(certs.expiresAt).toISOString() +
							"'. Ignoring renewal attempt until '" +
							new Date(renewableAt).toISOString() +
							"'. Set { duplicate: true } to force."
					);
					err.code = 'E_NOT_RENEWABLE';
					return Promise.reject(err);
				}

				// Either the cert has entered its renewal period
				// or we're forcing a refresh via 'dupliate: true'
				log(args.debug, 'Renewing!');

				if (!args.domains || !args.domains.length) {
					args.domains =
						args.servernames ||
						[certs.subject].concat(certs.altnames);
				}

				return core.certificates.registerAsync(args);
			},
			// Certificates
			_isRenewable: function(args, certs) {
				var renewableAt = core.certificates._getRenewableAt(
					args,
					certs
				);

				log(
					args.debug,
					'Check Expires At',
					new Date(certs.expiresAt).toISOString()
				);
				log(
					args.debug,
					'Check Renewable At',
					new Date(renewableAt).toISOString()
				);

				if (args.duplicate || Date.now() >= renewableAt) {
					log(args.debug, 'certificates are renewable');
					return true;
				}

				return false;
			},
			_getRenewableAt: function(args, certs) {
				return certs.expiresAt - (args.renewWithin || gl.renewWithin);
			},
			checkAsync: function(args) {
				var copy = utils.merge(args, gl);
				// if approveDomains doesn't set subject, we set it here
				if (!(copy.domains && copy.domains.length)) {
					copy.domains = [copy.subject || copy.domain].filter(
						Boolean
					);
				}
				if (!copy.subject) {
					copy.subject = copy.domains[0];
				}
				if (!copy.domain) {
					copy.domain = copy.domains[0];
				}
				args = utils.tplCopy(copy);

				// returns pems
				return gl.store.certificates
					.checkAsync(args)
					.then(function(cert) {
						if (!cert) {
							log(
								args.debug,
								'checkAsync failed to find certificates'
							);
							return null;
						}

						cert = utils.attachCertInfo(cert);
						if (utils.certHasDomain(cert, args.domain)) {
							log(
								args.debug,
								'checkAsync found existing certificates'
							);

							if (cert.privkey) {
								return cert;
							} else {
								return gl.store.certificates
									.checkKeypairAsync(args)
									.then(function(keypair) {
										cert.privkey =
											keypair.privateKeyPem ||
											RSA.exportPrivatePem(keypair);
										return cert;
									});
							}
						}
						log(
							args.debug,
							'checkAsync found mismatched / incomplete certificates'
						);
					});
			},
			// Certificates
			getAsync: function(args) {
				var copy = utils.merge(args, gl);
				// if approveDomains doesn't set subject, we set it here
				if (!(copy.domains && copy.domains.length)) {
					copy.domains = [copy.subject || copy.domain].filter(
						Boolean
					);
				}
				if (!copy.subject) {
					copy.subject = copy.domains[0];
				}
				if (!copy.domain) {
					copy.domain = copy.domains[0];
				}
				args = utils.tplCopy(copy);

				if (
					args.certificate &&
					args.certificate.privkey &&
					args.certificate.cert &&
					args.certificate.chain
				) {
					// TODO skip fetching a certificate if it's fetched during approveDomains
					console.warn(
						'TODO: implement certificates.checkAsync skipping'
					);
				}
				return core.certificates
					.checkAsync(args)
					.then(function(certs) {
						if (certs) {
							certs = utils.attachCertInfo(certs);
						}
						if (
							!certs ||
							!utils.certHasDomain(certs, args.domain)
						) {
							// There is no cert available
							if (
								false !== args.securityUpdates &&
								!args._communityMemberAdded
							) {
								// We will notify all greenlock users of mandatory and security updates
								// We'll keep track of versions and os so we can make sure things work well
								// { name, version, email, domains, action, communityMember, telemetry }
								require('./community').add({
									name: args._communityPackage,
									version: args._communityPackageVersion,
									email: args.email,
									domains: args.domains || args.servernames,
									action: 'reg',
									communityMember: args.communityMember,
									telemetry: args.telemetry
								});
								args._communityMemberAdded = true;
							}
							return core.certificates.registerAsync(args);
						}

						if (core.certificates._isRenewable(args, certs)) {
							// it's time to renew the available cert
							if (
								false !== args.securityUpdates &&
								!args._communityMemberAdded
							) {
								// We will notify all greenlock users of mandatory and security updates
								// We'll keep track of versions and os so we can make sure things work well
								// { name, version, email, domains, action, communityMember, telemetry }
								require('./community').add({
									name: args._communityPackage,
									version: args._communityPackageVersion,
									email: args.email,
									domains: args.domains || args.servernames,
									action: 'renew',
									communityMember: args.communityMember,
									telemetry: args.telemetry
								});
								args._communityMemberAdded = true;
							}
							certs.renewing = core.certificates.renewAsync(
								args,
								certs
							);
							if (args.waitForRenewal) {
								return certs.renewing;
							}
						}

						// return existing unexpired (although potentially stale) certificates when available
						// there will be an additional .renewing property if the certs are being asynchronously renewed
						return certs;
					})
					.then(function(results) {
						// returns pems
						return results;
					});
			}
		}
	};

	return core;
};