← Back
Editing: renewal.py
"""Functionality for autorenewal and associated juggling of configurations""" import copy import datetime import itertools import logging import random import sys import time import traceback from typing import Any from typing import Dict from typing import Iterable from typing import List from typing import Mapping from typing import Optional from typing import Union from cryptography.hazmat.backends import default_backend from cryptography.hazmat.primitives.asymmetric import ec from cryptography.hazmat.primitives.asymmetric import rsa from cryptography.hazmat.primitives.serialization import load_pem_private_key from cryptography import x509 from acme import client as acme_client from certbot import configuration from certbot import crypto_util from certbot import errors from certbot import util from certbot._internal import cli from certbot._internal import client from certbot._internal import constants from certbot._internal import hooks from certbot._internal import storage from certbot._internal import updater from certbot._internal.display import obj as display_obj from certbot._internal.plugins import disco as plugins_disco from certbot.compat import os from certbot.display import util as display_util logger = logging.getLogger(__name__) # These are the items which get pulled out of a renewal configuration # file's renewalparams and actually used in the client configuration # during the renewal process. We have to record their types here because # the renewal configuration process loses this information. STR_CONFIG_ITEMS = ["config_dir", "logs_dir", "work_dir", "user_agent", "server", "account", "authenticator", "installer", "renew_hook", "pre_hook", "post_hook", "http01_address", "preferred_chain", "key_type", "elliptic_curve", "preferred_profile", "required_profile"] INT_CONFIG_ITEMS = ["rsa_key_size", "http01_port"] BOOL_CONFIG_ITEMS = ["must_staple", "allow_subset_of_names", "reuse_key", "autorenew"] CONFIG_ITEMS = set(itertools.chain( BOOL_CONFIG_ITEMS, INT_CONFIG_ITEMS, STR_CONFIG_ITEMS, ('pref_challs',))) def reconstitute(config: configuration.NamespaceConfig, full_path: str) -> Optional[storage.RenewableCert]: """Try to instantiate a RenewableCert, updating config with relevant items. This is specifically for use in renewal and enforces several checks and policies to ensure that we can try to proceed with the renewal request. The config argument is modified by including relevant options read from the renewal configuration file. :param configuration.NamespaceConfig config: configuration for the current lineage :param str full_path: Absolute path to the configuration file that defines this lineage :returns: the RenewableCert object or None if a fatal error occurred :rtype: `storage.RenewableCert` or NoneType """ try: renewal_candidate = storage.RenewableCert(full_path, config) except (OSError, errors.CertStorageError) as error: logger.error("Renewal configuration file %s is broken.", full_path) logger.error("The error was: %s\nSkipping.", str(error)) logger.debug("Traceback was:\n%s", traceback.format_exc()) return None if "renewalparams" not in renewal_candidate.configuration: logger.error("Renewal configuration file %s lacks " "renewalparams. Skipping.", full_path) return None renewalparams = renewal_candidate.configuration["renewalparams"] if "authenticator" not in renewalparams: logger.error("Renewal configuration file %s does not specify " "an authenticator. Skipping.", full_path) return None # Prior to Certbot v1.25.0, the default value of key_type (rsa) was not persisted to the # renewal params. If the option is absent, it means the certificate was an RSA key. # Restoring the option here is necessary to preserve the certificate key_type if # the user has upgraded directly from Certbot <v1.25.0 to >=v2.0.0, where the default # key_type was changed to ECDSA. See https://github.com/certbot/certbot/issues/9635. renewalparams["key_type"] = renewalparams.get("key_type", "rsa") # Now restore specific values along with their data types, if # those elements are present. renewalparams = _remove_deprecated_config_elements(renewalparams) try: restore_required_config_elements(config, renewalparams) _restore_plugin_configs(config, renewalparams) except (ValueError, errors.Error) as error: logger.error( "An error occurred while parsing %s. The error was %s. " "Skipping the file.", full_path, str(error)) logger.debug("Traceback was:\n%s", traceback.format_exc()) return None try: config.domains = [util.enforce_domain_sanity(d) for d in renewal_candidate.names()] except errors.ConfigurationError as error: logger.error("Renewal configuration file %s references a certificate " "that contains an invalid domain name. The problem " "was: %s. Skipping.", full_path, error) return None return renewal_candidate def _restore_webroot_config(config: configuration.NamespaceConfig, renewalparams: Mapping[str, Any]) -> None: """ webroot_map is, uniquely, a dict, and the general-purpose configuration restoring logic is not able to correctly parse it from the serialized form. """ if "webroot_map" in renewalparams and not config.set_by_user("webroot_map"): config.webroot_map = renewalparams["webroot_map"] # To understand why webroot_path and webroot_map processing are not mutually exclusive, # see https://github.com/certbot/certbot/pull/7095 if "webroot_path" in renewalparams and not config.set_by_user("webroot_path"): wp = renewalparams["webroot_path"] if isinstance(wp, str): # prior to 0.1.0, webroot_path was a string wp = [wp] config.webroot_path = wp def _restore_plugin_configs(config: configuration.NamespaceConfig, renewalparams: Mapping[str, Any]) -> None: """Sets plugin specific values in config from renewalparams :param configuration.NamespaceConfig config: configuration for the current lineage :param configobj.Section renewalparams: Parameters from the renewal configuration file that defines this lineage """ # Now use parser to get plugin-prefixed items with correct types # XXX: the current approach of extracting only prefixed items # related to the actually-used installer and authenticator # works as long as plugins don't need to read plugin-specific # variables set by someone else (e.g., assuming Apache # configurator doesn't need to read webroot_ variables). # Note: if a parameter that used to be defined in the parser is no # longer defined, stored copies of that parameter will be # deserialized as strings by this logic even if they were # originally meant to be some other type. plugin_prefixes: List[str] = [] if renewalparams["authenticator"] == "webroot": _restore_webroot_config(config, renewalparams) else: plugin_prefixes.append(renewalparams["authenticator"]) if renewalparams.get("installer") is not None: plugin_prefixes.append(renewalparams["installer"]) for plugin_prefix in set(plugin_prefixes): plugin_prefix = plugin_prefix.replace('-', '_') for config_item, config_value in renewalparams.items(): if config_item.startswith(plugin_prefix + "_") and not config.set_by_user(config_item): # Values None, True, and False need to be treated specially, # As their types aren't handled correctly by configobj if config_value in ("None", "True", "False"): # bool("False") == True # pylint: disable=eval-used setattr(config, config_item, eval(config_value)) else: cast = cli.argparse_type(config_item) setattr(config, config_item, cast(config_value)) def restore_required_config_elements(config: configuration.NamespaceConfig, renewalparams: Mapping[str, Any]) -> None: """Sets non-plugin specific values in config from renewalparams :param configuration.NamespaceConfig config: configuration for the current lineage :param configobj.Section renewalparams: parameters from the renewal configuration file that defines this lineage """ updated_values = {} required_items = itertools.chain( (("pref_challs", _restore_pref_challs),), zip(BOOL_CONFIG_ITEMS, itertools.repeat(_restore_bool)), zip(INT_CONFIG_ITEMS, itertools.repeat(_restore_int)), zip(STR_CONFIG_ITEMS, itertools.repeat(_restore_str))) for item_name, restore_func in required_items: if item_name in renewalparams and not config.set_by_user(item_name): value = restore_func(item_name, renewalparams[item_name]) updated_values[item_name] = value for key, value in updated_values.items(): setattr(config, key, value) def _remove_deprecated_config_elements(renewalparams: Mapping[str, Any]) -> Dict[str, Any]: """Removes deprecated config options from the parsed renewalparams. :param dict renewalparams: list of parsed renewalparams :returns: list of renewalparams with deprecated config options removed :rtype: dict """ return {option_name: v for (option_name, v) in renewalparams.items() if option_name not in cli.DEPRECATED_OPTIONS} def _restore_pref_challs(unused_name: str, value: Union[List[str], str]) -> List[str]: """Restores preferred challenges from a renewal config file. If value is a `str`, it should be a single challenge type. :param str unused_name: option name :param value: option value :type value: `list` of `str` or `str` :returns: converted option value to be stored in the runtime config :rtype: `list` of `str` :raises errors.Error: if value can't be converted to a bool """ # If pref_challs has only one element, configobj saves the value # with a trailing comma so it's parsed as a list. If this comma is # removed by the user, the value is parsed as a str. value = [value] if isinstance(value, str) else value return cli.parse_preferred_challenges(value) def _restore_bool(name: str, value: str) -> bool: """Restores a boolean key-value pair from a renewal config file. :param str name: option name :param str value: option value :returns: converted option value to be stored in the runtime config :rtype: bool :raises errors.Error: if value can't be converted to a bool """ lowercase_value = value.lower() if lowercase_value not in ("true", "false"): raise errors.Error(f"Expected True or False for {name} but found {value}") return lowercase_value == "true" def _restore_int(name: str, value: str) -> int: """Restores an integer key-value pair from a renewal config file. :param str name: option name :param str value: option value :returns: converted option value to be stored in the runtime config :rtype: int :raises errors.Error: if value can't be converted to an int """ if name == "http01_port" and value == "None": logger.info("updating legacy http01_port value") return cli.flag_default("http01_port") try: return int(value) except ValueError: raise errors.Error(f"Expected a numeric value for {name}") def _restore_str(name: str, value: str) -> Optional[str]: """Restores a string key-value pair from a renewal config file. :param str name: option name :param str value: option value :returns: converted option value to be stored in the runtime config :rtype: str or None """ # To automatically migrate users from Let's Encrypt's old ACMEv1 URL, we replace the it here # with the default ACME URL. It is still possible to override this choice with the explicit # `--server` CLI flag. if name == "server" and value == constants.V1_URI: logger.info("Using server %s instead of legacy %s", constants.CLI_DEFAULTS["server"], value) return constants.CLI_DEFAULTS["server"] return None if value == "None" else value def should_renew(config: configuration.NamespaceConfig, lineage: storage.RenewableCert, acme_clients: Dict[str, acme_client.ClientV2]) -> bool: """Return true if any of the circumstances for automatic renewal apply.""" if config.renew_by_default: logger.debug("Auto-renewal forced with --force-renewal...") return True if config.dry_run: logger.info("Certificate not due for renewal, but simulating renewal for dry run") return True if should_autorenew(config, lineage, acme_clients): logger.info("Certificate is due for renewal, auto-renewing...") return True display_util.notify("Certificate not yet due for renewal") return False def _ari_renewal_time(config: configuration.NamespaceConfig, lineage: storage.RenewableCert, acme_clients: Dict[str, acme_client.ClientV2], cert_pem: bytes, )-> Optional[datetime.datetime]: """Return the ARI suggested renewal time if it's available.""" # For ARI requests, we want to use the ACME directory URL from which the # cert was originally requested. Since `config.server` can be overridden on # the command line, we're using the server stored in the cert's renewal # conf, i.e. `lineage.server` # # Fixes https://github.com/certbot/certbot/issues/10339 if not lineage.server: renewal_conf_file = storage.renewal_filename_for_lineagename(config, lineage.lineagename) logger.warning("Skipping ARI check because %s has no 'server' field. This issue will not " "prevent certificate renewal", renewal_conf_file) return None try: # Creating a new ACME client makes a network request, so check if we have # one cached for this cert's server already if lineage.server not in acme_clients: acme_clients[lineage.server] = \ client.create_acme_client(config, server_override=lineage.server) acme = acme_clients.get(lineage.server, None) # Attempt to get the ARI-defined renewal time if acme: return acme.renewal_time(cert_pem)[0] except Exception: # pylint: disable=broad-except # We want to stop errors around ARI preventing renewal so we catch all exceptions here # with a warning asking users to tell us about any problems they are experiencing logger.warning("An error occurred requesting ACME Renewal Information (ARI). If this " "problem persists and you think it's a bug in Certbot, please open an " "issue at https://github.com/certbot/certbot/issues/new/choose.") logger.debug("Error while requesting ARI was:", exc_info=True) return None def _default_renewal_time(cert_pem: bytes) -> datetime.datetime: """Return an reasonable default time to attempt renewal of the certificate based on the certificate lifetime. :param bytes cert_pem: cert as pem file :returns: Time to attempt renewal :rtype: `datetime.datetime` """ cert = x509.load_pem_x509_certificate(cert_pem) not_before = cert.not_valid_before_utc lifetime = cert.not_valid_after_utc - not_before if lifetime.total_seconds() < 10 * 86400: default_rt = not_before + lifetime / 2 else: default_rt = not_before + lifetime * 2 / 3 return default_rt def should_autorenew(config: configuration.NamespaceConfig, lineage: storage.RenewableCert, acme_clients: Dict[str, acme_client.ClientV2]) -> bool: """Should we now try to autorenew the most recent cert version? If automatic renewal is disabled for the lineage, this function immediately returns False. Otherwise, if any of ACME Renewal Info (ARI), OCSP, or the renew_before_expiry config option indicates we should renew, we return True. If none of those values say we should renew and at least one of ARI or renew_before_expiry has an available value, we return False. We otherwise decide whether to renew based on the certificate's remaining lifetime. Note that this examines the numerically most recent cert version, not the currently deployed version. :returns: whether an attempt should now be made to autorenew the most current cert version in this lineage :rtype: bool """ if not lineage.autorenewal_is_enabled(): return False cert = lineage.version("cert", lineage.latest_common_version()) with open(cert, 'rb') as f: cert_pem = f.read() renewal_time = _ari_renewal_time(config, lineage, acme_clients, cert_pem) now = datetime.datetime.now(datetime.timezone.utc) if renewal_time and now > renewal_time: return True # Renewals on the basis of revocation if lineage.ocsp_revoked(lineage.latest_common_version()): logger.debug("Should renew, certificate is revoked.") return True # If the renew_before_expiry config field is set, check if it says we should renew config_interval = lineage.configuration.get("renew_before_expiry") if config_interval is not None: notAfter = crypto_util.notAfter(cert) if notAfter < storage.add_time_interval(now, config_interval): logger.debug("Should renew, less than %s before certificate " "expiry %s.", config_interval, notAfter.strftime("%Y-%m-%d %H:%M:%S %Z")) return True # Only use the default if we don't have an ARI or renew_before_expiry value elif renewal_time is None: default_renewal_time = _default_renewal_time(cert_pem) if now > default_renewal_time: return True return False def _avoid_invalidating_lineage(config: configuration.NamespaceConfig, lineage: storage.RenewableCert, original_server: str) -> None: """Do not renew a valid cert with one from a staging server!""" if util.is_staging(config.server): if not util.is_staging(original_server): if not config.break_my_certs: names = ", ".join(lineage.names()) raise errors.Error( "You've asked to renew/replace a seemingly valid certificate with " f"a test certificate (domains: {names}). We will not do that " "unless you use the --break-my-certs flag!") def _avoid_reuse_key_conflicts(config: configuration.NamespaceConfig, lineage: storage.RenewableCert) -> None: """Don't allow combining --reuse-key with any flags that would conflict with key reuse (--key-type, --rsa-key-size, --elliptic-curve), unless --new-key is also set. """ # If --no-reuse-key is set, no conflict if config.set_by_user("reuse_key") and not config.reuse_key: return # If reuse_key is not set on the lineage and --reuse-key is not # set on the CLI, no conflict. if not lineage.reuse_key and not config.reuse_key: return # If --new-key is set, no conflict if config.new_key: return kt = config.key_type.lower() # The remaining cases where conflicts are present: # - --key-type is set on the CLI and doesn't match the stored private key # - It's an RSA key and --rsa-key-size is set and doesn't match # - It's an ECDSA key and --eliptic-curve is set and doesn't match potential_conflicts = [ ("--key-type", lambda: kt != lineage.private_key_type.lower()), ("--rsa-key-size", lambda: kt == "rsa" and config.rsa_key_size != lineage.rsa_key_size), ("--elliptic-curve", lambda: kt == "ecdsa" and lineage.elliptic_curve and \ config.elliptic_curve.lower() != lineage.elliptic_curve.lower()) ] for conflict in potential_conflicts: if conflict[1](): raise errors.Error( f"Unable to change the {conflict[0]} of this certificate because --reuse-key " "is set. To stop reusing the private key, specify --no-reuse-key. " "To change the private key this one time and then reuse it in future, " "add --new-key.") def renew_cert(config: configuration.NamespaceConfig, domains: Optional[List[str]], le_client: client.Client, lineage: storage.RenewableCert) -> None: """Renew a certificate lineage.""" renewal_params = lineage.configuration["renewalparams"] original_server = renewal_params.get("server", cli.flag_default("server")) _avoid_invalidating_lineage(config, lineage, original_server) _avoid_reuse_key_conflicts(config, lineage) if not domains: domains = lineage.names() # The private key is the existing lineage private key if reuse_key is set. # Otherwise, generate a fresh private key by passing None. if config.reuse_key and not config.new_key: new_key = os.path.normpath(lineage.privkey) _update_renewal_params_from_key(new_key, config) else: new_key = None new_cert, new_chain, new_key, _ = le_client.obtain_certificate(domains, new_key) if config.dry_run: logger.debug("Dry run: skipping updating lineage at %s", os.path.dirname(lineage.cert)) else: prior_version = lineage.latest_common_version() # TODO: Check return value of save_successor lineage.save_successor(prior_version, new_cert, new_key.pem, new_chain, config) lineage.update_all_links_to(lineage.latest_common_version()) lineage.truncate() hooks.renew_hook(config, domains, lineage.live_dir) def report(msgs: Iterable[str], category: str) -> str: """Format a results report for a category of renewal outcomes""" lines = ("%s (%s)" % (m, category) for m in msgs) return " " + "\n ".join(lines) def _renew_describe_results(config: configuration.NamespaceConfig, renew_successes: List[str], renew_failures: List[str], renew_skipped: List[str], parse_failures: List[str]) -> None: """ Print a report to the terminal about the results of the renewal process. :param configuration.NamespaceConfiguration config: Configuration :param list renew_successes: list of fullchain paths which were renewed :param list renew_failures: list of fullchain paths which failed to be renewed :param list renew_skipped: list of messages to print about skipped certificates :param list parse_failures: list of renewal parameter paths which had errors """ notify = display_util.notify notify_error = logger.error notify(f'\n{display_obj.SIDE_FRAME}') renewal_noun = "simulated renewal" if config.dry_run else "renewal" if renew_skipped: notify("The following certificates are not due for renewal yet:") notify(report(renew_skipped, "skipped")) if not renew_successes and not renew_failures: notify(f"No {renewal_noun}s were attempted.") if (config.pre_hook is not None or config.renew_hook is not None or config.post_hook is not None): notify("No hooks were run.") elif renew_successes and not renew_failures: notify(f"Congratulations, all {renewal_noun}s succeeded: ") notify(report(renew_successes, "success")) elif renew_failures and not renew_successes: notify_error("All %ss failed. The following certificates could " "not be renewed:", renewal_noun) notify_error(report(renew_failures, "failure")) elif renew_failures and renew_successes: notify(f"The following {renewal_noun}s succeeded:") notify(report(renew_successes, "success") + "\n") notify_error("The following %ss failed:", renewal_noun) notify_error(report(renew_failures, "failure")) if parse_failures: notify("\nAdditionally, the following renewal configurations " "were invalid: ") notify(report(parse_failures, "parsefail")) notify(display_obj.SIDE_FRAME) def handle_renewal_request(config: configuration.NamespaceConfig) -> None: """Examine each lineage; renew if due and report results""" # This is trivially False if config.domains is empty if any(domain not in config.webroot_map for domain in config.domains): # If more plugins start using cli.add_domains, # we may want to only log a warning here raise errors.Error("Currently, the renew verb is capable of either " "renewing all installed certificates that are due " "to be renewed or renewing a single certificate specified " "by its name. If you would like to renew specific " "certificates by their domains, use the certonly command " "instead. The renew verb may provide other options " "for selecting certificates to renew in the future.") if config.certname: conf_files = [storage.renewal_file_for_certname(config, config.certname)] else: conf_files = storage.renewal_conf_files(config) renew_successes = [] renew_failures = [] renew_skipped = [] parse_failures = [] renewed_domains = [] failed_domains = [] # Noninteractive renewals include a random delay in order to spread # out the load on the certificate authority servers, even if many # users all pick the same time for renewals. This delay precedes # running any hooks, so that side effects of the hooks (such as # shutting down a web service) aren't prolonged unnecessarily. apply_random_sleep = not sys.stdin.isatty() and config.random_sleep_on_renew # We initialize acme clients on a per-server basis, but most # lineages use the same server. Memoize clients here so we can # share the connection pool and reuse a single fetched directory. acme_clients: Dict[str, acme_client.ClientV2] = {} for renewal_file in conf_files: display_util.notification("Processing " + renewal_file, pause=False) lineage_config = copy.deepcopy(config) assert renewal_file.endswith(".conf") # make sure lineagename_for_filename will not error lineagename = storage.lineagename_for_filename(renewal_file) # Note that this modifies config (to add back the configuration # elements from within the renewal configuration file). try: renewal_candidate = reconstitute(lineage_config, renewal_file) except Exception as e: # pylint: disable=broad-except logger.error("Renewal configuration file %s (cert: %s) " "produced an unexpected error: %s. Skipping.", renewal_file, lineagename, e) logger.debug("Traceback was:\n%s", traceback.format_exc()) parse_failures.append(renewal_file) continue try: if not renewal_candidate: parse_failures.append(renewal_file) else: renewal_candidate.ensure_deployed() from certbot._internal import main plugins = plugins_disco.PluginsRegistry.find_all() if should_renew(lineage_config, renewal_candidate, acme_clients): # Apply random sleep upon first renewal if needed if apply_random_sleep: sleep_time = random.uniform(1, 60 * 8) logger.info("Non-interactive renewal: random delay of %s seconds", sleep_time) time.sleep(sleep_time) # We will sleep only once this day, folks. apply_random_sleep = False # domains have been restored into lineage_config by reconstitute # but they're unnecessary anyway because renew_cert here # will just grab them from the certificate # we already know it's time to renew based on should_renew # and we have a lineage in renewal_candidate main.renew_cert(lineage_config, plugins, renewal_candidate) renew_successes.append(renewal_candidate.fullchain) renewed_domains.extend(renewal_candidate.names()) else: expiry = crypto_util.notAfter(renewal_candidate.version( "cert", renewal_candidate.latest_common_version())) renew_skipped.append("%s expires on %s" % (renewal_candidate.fullchain, expiry.strftime("%Y-%m-%d"))) # Run updater interface methods updater.run_generic_updaters(lineage_config, renewal_candidate, plugins) except Exception as e: # pylint: disable=broad-except # obtain_cert (presumably) encountered an unanticipated problem. logger.error( "Failed to renew certificate %s with error: %s", lineagename, e ) logger.debug("Traceback was:\n%s", traceback.format_exc()) if renewal_candidate: renew_failures.append(renewal_candidate.fullchain) failed_domains.extend(renewal_candidate.names()) # Describe all the results _renew_describe_results(config, renew_successes, renew_failures, renew_skipped, parse_failures) hooks.run_saved_post_hooks(renewed_domains, failed_domains) if renew_failures or parse_failures: raise errors.Error( f"{len(renew_failures)} renew failure(s), {len(parse_failures)} parse failure(s)") logger.debug("no renewal failures") def _update_renewal_params_from_key(key_path: str, config: configuration.NamespaceConfig) -> None: with open(key_path, 'rb') as file_h: key = load_pem_private_key(file_h.read(), password=None, backend=default_backend()) if isinstance(key, rsa.RSAPrivateKey): config.key_type = 'rsa' config.rsa_key_size = key.key_size elif isinstance(key, ec.EllipticCurvePrivateKey): config.key_type = 'ecdsa' config.elliptic_curve = key.curve.name else: raise errors.Error(f'Key at {key_path} is of an unsupported type: {type(key)}.')
Save File
Cancel