Module Expr Str Import alias Import alias ClassDef bases NameLoad body Expr Str Assign NameStore AttributeLoad NameLoad attr FunctionDef arguments args NameParam defaults body Expr Str Raise Call NameLoad decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call NameLoad decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call NameLoad decorator_list AttributeLoad NameLoad attr decorator_list ClassDef bases AttributeLoad AttributeLoad NameLoad attr attr body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str FunctionDef arguments args NameParam NameParam defaults body Expr Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str decorator_list decorator_list ClassDef bases AttributeLoad AttributeLoad NameLoad attr attr body Expr Str FunctionDef arguments args defaults body Expr Str decorator_list FunctionDef arguments args defaults body Expr Str decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults body Expr Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str decorator_list decorator_list ClassDef bases AttributeLoad AttributeLoad NameLoad attr attr body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args defaults body Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults body Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str decorator_list FunctionDef arguments args defaults body Expr Str decorator_list FunctionDef arguments args defaults body Expr Str decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str decorator_list FunctionDef arguments args NameParam defaults Num body Expr Str decorator_list FunctionDef arguments args defaults body Expr Str decorator_list FunctionDef arguments args defaults body Expr Str decorator_list FunctionDef arguments args defaults body Expr Str decorator_list FunctionDef arguments args defaults body Expr Str decorator_list decorator_list ClassDef bases AttributeLoad AttributeLoad NameLoad attr attr body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults Str Str Str NameLoad NameLoad body Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults Str Str NameLoad NameLoad body Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str decorator_list decorator_list ClassDef bases AttributeLoad AttributeLoad NameLoad attr attr body Expr Str FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad Num body Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Num NameLoad body Expr Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str decorator_list decorator_list ClassDef bases AttributeLoad AttributeLoad NameLoad attr attr body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad body Expr Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str decorator_list decorator_list
N/A N/A Certbot client interfaces. N/A abc N/A zope.interface AccountStorage N/A object N/A N/A Accounts storage interface. N/A __metaclass__ N/A abc ABCMeta find_all N/A N/A self N/A N/A N/A Find all accounts.

        :returns: All found accounts.
        :rtype: list

         N/A N/A NotImplementedError N/A N/A abc abstractmethod load N/A N/A self account_id N/A N/A N/A Load an account by its id.

        :raises .AccountNotFound: if account could not be found
        :raises .AccountStorageError: if account could not be loaded

         N/A N/A NotImplementedError N/A N/A abc abstractmethod save N/A N/A self account N/A N/A N/A Save account.

        :raises .AccountStorageError: if account could not be saved

         N/A N/A NotImplementedError N/A N/A abc abstractmethod N/A IPluginFactory N/A N/A N/A zope interface Interface N/A N/A IPlugin factory.

    Objects providing this interface will be called without satisfying
    any entry point "extras" (extra dependencies) you might have defined
    for your plugin, e.g (excerpt from ``setup.py`` script)::

      setup(
          ...
          entry_points={
              'certbot.plugins': [
                  'name=example_project.plugin[plugin_deps]',
              ],
          },
          extras_require={
              'plugin_deps': ['dep1', 'dep2'],
          }
      )

    Therefore, make sure such objects are importable and usable without
    extras. This is necessary, because CLI does the following operations
    (in order):

      - loads an entry point,
      - calls `inject_parser_options`,
      - requires an entry point,
      - creates plugin instance (`__call__`).

     N/A description N/A N/A N/A zope interface Attribute Short plugin description __call__ N/A N/A config name N/A N/A N/A Create new `IPlugin`.

        :param IConfig config: Configuration.
        :param str name: Unique plugin name.

         N/A inject_parser_options N/A N/A parser name N/A N/A N/A Inject argument parser options (flags).

        1. Be nice and prepend all options and destinations with
        `~.common.option_namespace` and `~common.dest_namespace`.

        2. Inject options (flags) only. Positional arguments are not
        allowed, as this would break the CLI.

        :param ArgumentParser parser: (Almost) top-level CLI parser.
        :param str name: Unique plugin name.

         N/A N/A IPlugin N/A N/A N/A zope interface Interface N/A N/A Certbot plugin. prepare N/A N/A N/A N/A N/A Prepare the plugin.

        Finish up any additional initialization.

        :raises .PluginError:
            when full initialization cannot be completed.
        :raises .MisconfigurationError:
            when full initialization cannot be completed. Plugin will
            be displayed on a list of available plugins.
        :raises .NoInstallationError:
            when the necessary programs/files cannot be located. Plugin
            will NOT be displayed on a list of available plugins.
        :raises .NotSupportedError:
            when the installation is recognized, but the version is not
            currently supported.

         N/A more_info N/A N/A N/A N/A N/A Human-readable string to help the user.

        Should describe the steps taken and any relevant info to help the user
        decide which plugin to use.

        :rtype str:

         N/A N/A IAuthenticator N/A IPlugin N/A N/A Generic Certbot Authenticator.

    Class represents all possible tools processes that have the
    ability to perform challenges and attain a certificate.

     get_chall_pref N/A N/A domain N/A N/A N/A Return list of challenge preferences.

        :param str domain: Domain for which challenge preferences are sought.

        :returns: List of challenge types (subclasses of
            :class:`acme.challenges.Challenge`) with the most
            preferred challenges first. If a type is not specified, it means the
            Authenticator cannot perform the challenge.
        :rtype: list

         N/A perform N/A N/A achalls N/A N/A N/A Perform the given challenge.

        :param list achalls: Non-empty (guaranteed) list of
            :class:`~certbot.achallenges.AnnotatedChallenge`
            instances, such that it contains types found within
            :func:`get_chall_pref` only.

        :returns: List of ACME
            :class:`~acme.challenges.ChallengeResponse` instances
            or if the :class:`~acme.challenges.Challenge` cannot
            be fulfilled then:

            ``None``
              Authenticator can perform challenge, but not at this time.
            ``False``
              Authenticator will never be able to perform (error).

        :rtype: :class:`list` of
            :class:`acme.challenges.ChallengeResponse`,
            where responses are required to be returned in
            the same order as corresponding input challenges

        :raises .PluginError: If challenges cannot be performed

         N/A cleanup N/A N/A achalls N/A N/A N/A Revert changes and shutdown after challenges complete.

        :param list achalls: Non-empty (guaranteed) list of
            :class:`~certbot.achallenges.AnnotatedChallenge`
            instances, a subset of those previously passed to :func:`perform`.

        :raises PluginError: if original configuration cannot be restored

         N/A N/A IConfig N/A N/A N/A zope interface Interface N/A N/A Certbot user-supplied configuration.

    .. warning:: The values stored in the configuration have not been
        filtered, stripped or sanitized.

     N/A server N/A N/A N/A zope interface Attribute ACME Directory Resource URI. N/A email N/A N/A N/A zope interface Attribute Email used for registration and recovery contact. N/A rsa_key_size N/A N/A N/A zope interface Attribute Size of the RSA key. N/A config_dir N/A N/A N/A zope interface Attribute Configuration directory. N/A work_dir N/A N/A N/A zope interface Attribute Working directory. N/A accounts_dir N/A N/A N/A zope interface Attribute Directory where all account information is stored. N/A backup_dir N/A N/A N/A zope interface Attribute Configuration backups directory. N/A csr_dir N/A N/A N/A zope interface Attribute Directory where newly generated Certificate Signing Requests (CSRs) are saved. N/A in_progress_dir N/A N/A N/A zope interface Attribute Directory used before a permanent checkpoint is finalized. N/A key_dir N/A N/A N/A zope interface Attribute Keys storage. N/A temp_checkpoint_dir N/A N/A N/A zope interface Attribute Temporary checkpoint directory. N/A renewer_config_file N/A N/A N/A zope interface Attribute Location of renewal configuration file. N/A no_verify_ssl N/A N/A N/A zope interface Attribute Disable SSL certificate verification. N/A tls_sni_01_port N/A N/A N/A zope interface Attribute Port number to perform tls-sni-01 challenge. Boulder in testing mode defaults to 5001. N/A http01_port N/A N/A N/A zope interface Attribute Port used in the SimpleHttp challenge. N/A IInstaller N/A IPlugin N/A N/A Generic Certbot Installer Interface.

    Represents any server that an X509 certificate can be placed.

     get_all_names N/A N/A N/A N/A N/A Returns all names that may be authenticated.

        :rtype: `list` of `str`

         N/A deploy_cert N/A N/A domain cert_path key_path chain_path fullchain_path N/A N/A N/A Deploy certificate.

        :param str domain: domain to deploy certificate file
        :param str cert_path: absolute path to the certificate file
        :param str key_path: absolute path to the private key file
        :param str chain_path: absolute path to the certificate chain file
        :param str fullchain_path: absolute path to the certificate fullchain
            file (cert plus chain)

        :raises .PluginError: when cert cannot be deployed

         N/A enhance N/A N/A domain enhancement options N/A None N/A N/A Perform a configuration enhancement.

        :param str domain: domain for which to provide enhancement
        :param str enhancement: An enhancement as defined in
            :const:`~certbot.constants.ENHANCEMENTS`
        :param options: Flexible options parameter for enhancement.
            Check documentation of
            :const:`~certbot.constants.ENHANCEMENTS`
            for expected options for each enhancement.

        :raises .PluginError: If Enhancement is not supported, or if
            an error occurs during the enhancement.

         N/A supported_enhancements N/A N/A N/A N/A N/A Returns a list of supported enhancements.

        :returns: supported enhancements which should be a subset of
            :const:`~certbot.constants.ENHANCEMENTS`
        :rtype: :class:`list` of :class:`str`

         N/A get_all_certs_keys N/A N/A N/A N/A N/A Retrieve all certs and keys set in configuration.

        :returns: tuples with form `[(cert, key, path)]`, where:

            - `cert` - str path to certificate file
            - `key` - str path to associated key file
            - `path` - file path to configuration file

        :rtype: list

         N/A save N/A N/A title temporary N/A None False N/A N/A Saves all changes to the configuration files.

        Both title and temporary are needed because a save may be
        intended to be permanent, but the save is not ready to be a full
        checkpoint. If an exception is raised, it is assumed a new
        checkpoint was not created.

        :param str title: The title of the save. If a title is given, the
            configuration will be saved as a new checkpoint and put in a
            timestamped directory. `title` has no effect if temporary is true.

        :param bool temporary: Indicates whether the changes made will
            be quickly reversed in the future (challenges)

        :raises .PluginError: when save is unsuccessful

         N/A rollback_checkpoints N/A N/A rollback N/A 1 N/A N/A Revert `rollback` number of configuration checkpoints.

        :raises .PluginError: when configuration cannot be fully reverted

         N/A recovery_routine N/A N/A N/A N/A N/A Revert configuration to most recent finalized checkpoint.

        Remove all changes (temporary and permanent) that have not been
        finalized. This is useful to protect against crashes and other
        execution interruptions.

        :raises .errors.PluginError: If unable to recover the configuration

         N/A view_config_changes N/A N/A N/A N/A N/A Display all of the LE config changes.

        :raises .PluginError: when config changes cannot be parsed

         N/A config_test N/A N/A N/A N/A N/A Make sure the configuration is valid.

        :raises .MisconfigurationError: when the config is not in a usable state

         N/A restart N/A N/A N/A N/A N/A Restart or refresh the server content.

        :raises .PluginError: when server cannot be restarted

         N/A N/A IDisplay N/A N/A N/A zope interface Interface N/A N/A Generic display. notification N/A N/A message height pause N/A N/A N/A Displays a string message

        :param str message: Message to display
        :param int height: Height of dialog box if applicable
        :param bool pause: Whether or not the application should pause for
            confirmation (if available)

         N/A menu N/A N/A message choices ok_label cancel_label help_label default cli_flag N/A OK Cancel None None N/A N/A Displays a generic menu.

        :param str message: message to display

        :param choices: choices
        :type choices: :class:`list` of :func:`tuple` or :class:`str`

        :param str ok_label: label for OK button
        :param str cancel_label: label for Cancel button
        :param str help_label: label for Help button
        :param int default: default (non-interactive) choice from the menu
        :param str cli_flag: to automate choice from the menu, eg "--keep"

        :returns: tuple of (`code`, `index`) where
            `code` - str display exit code
            `index` - int index of the user's selection

        :raises errors.MissingCommandlineFlag: if called in non-interactive
            mode without a default set

         N/A input N/A N/A message default cli_args N/A None None N/A N/A Accept input from the user.

        :param str message: message to display to the user

        :returns: tuple of (`code`, `input`) where
            `code` - str display exit code
            `input` - str of the user's input
        :rtype: tuple

        :raises errors.MissingCommandlineFlag: if called in non-interactive
            mode without a default set

         N/A yesno N/A N/A message yes_label no_label default cli_args N/A Yes No None None N/A N/A Query the user with a yes/no question.

        Yes and No label must begin with different letters.

        :param str message: question for the user
        :param str default: default (non-interactive) choice from the menu
        :param str cli_flag: to automate choice from the menu, eg "--redirect / --no-redirect"

        :returns: True for "Yes", False for "No"
        :rtype: bool

        :raises errors.MissingCommandlineFlag: if called in non-interactive
            mode without a default set

         N/A checklist N/A N/A message tags default_state default cli_args N/A None None N/A N/A Allow for multiple selections from a menu.

        :param str message: message to display to the user
        :param list tags: where each is of type :class:`str` len(tags) > 0
        :param bool default_status: If True, items are in a selected state by default.
        :param str default: default (non-interactive) state of the checklist
        :param str cli_flag: to automate choice from the menu, eg "--domains"

        :returns: tuple of the form (code, list_tags) where
            `code` - int display exit code
            `list_tags` - list of str tags selected by the user
        :rtype: tuple

        :raises errors.MissingCommandlineFlag: if called in non-interactive
            mode without a default set

         N/A directory_select N/A N/A self message default cli_flag N/A None None N/A N/A Display a directory selection screen.

        :param str message: prompt to give the user
        :param default: the default value to return, if one exists, when
            using the NoninteractiveDisplay
        :param str cli_flag: option used to set this value with the CLI,
            if one exists, to be included in error messages given by
            NoninteractiveDisplay

        :returns: tuple of the form (`code`, `string`) where
            `code` - int display exit code
            `string` - input entered by the user

         N/A N/A IValidator N/A N/A N/A zope interface Interface N/A N/A Configuration validator. certificate N/A N/A cert name alt_host port N/A None 443 N/A N/A Verifies the certificate presented at name is cert

        :param OpenSSL.crypto.X509 cert: Expected certificate
        :param str name: Server's domain name
        :param bytes alt_host: Host to connect to instead of the IP
            address of host
        :param int port: Port to connect to

        :returns: True if the certificate was verified successfully
        :rtype: bool

         N/A redirect N/A N/A name port headers N/A 80 None N/A N/A Verify redirect to HTTPS

        :param str name: Server's domain name
        :param int port: Port to connect to
        :param dict headers: HTTP headers to include in request

        :returns: True if redirect is successfully enabled
        :rtype: bool

         N/A hsts N/A N/A name N/A N/A N/A Verify HSTS header is enabled

        :param str name: Server's domain name

        :returns: True if HSTS header is successfully enabled
        :rtype: bool

         N/A ocsp_stapling N/A N/A name N/A N/A N/A Verify ocsp stapling for domain

        :param str name: Server's domain name

        :returns: True if ocsp stapling is successfully enabled
        :rtype: bool

         N/A N/A IReporter N/A N/A N/A zope interface Interface N/A N/A Interface to collect and display information to the user. N/A HIGH_PRIORITY N/A N/A N/A zope interface Attribute Used to denote high priority messages N/A MEDIUM_PRIORITY N/A N/A N/A zope interface Attribute Used to denote medium priority messages N/A LOW_PRIORITY N/A N/A N/A zope interface Attribute Used to denote low priority messages add_message N/A N/A self msg priority on_crash N/A True N/A N/A Adds msg to the list of messages to be printed.

        :param str msg: Message to be displayed to the user.

        :param int priority: One of HIGH_PRIORITY, MEDIUM_PRIORITY, or
            LOW_PRIORITY.

        :param bool on_crash: Whether or not the message should be printed if
            the program exits abnormally.

         N/A print_messages N/A N/A self N/A N/A N/A Prints messages to the user and clears the message queue. N/A N/A