certbot package

Certbot client.

Subpackages

• certbot.compat package
  • Submodules
    • certbot.compat.filesystem module
      • chmod()
      • umask()
      • temp_umask()
      • copy_ownership_and_apply_mode()
      • copy_ownership_and_mode()
      • check_mode()
      • check_owner()
      • check_permissions()
      • open()
      • makedirs()
      • mkdir()
      • replace()
      • realpath()
      • readlink()
      • is_executable()
      • has_world_permissions()
      • compute_private_key_mode()
      • has_same_ownership()
      • has_min_permissions()
    • certbot.compat.misc module
      • raise_for_non_administrative_windows_rights()
      • prepare_virtual_console()
      • readline_with_timeout()
      • get_default_folder()
      • underscores_for_unsupported_characters_in_path()
      • execute_command_status()
    • certbot.compat.os module
      • access()
      • chmod()
      • chown()
      • fstat()
      • mkdir()
      • open()
      • rename()
      • replace()
      • stat()
      • umask()
      • makedirs()
• certbot.display package
  • Submodules
    • certbot.display.ops module
      • get_email()
      • choose_account()
      • choose_values()
      • choose_names()
      • get_valid_domains()
      • success_installation()
      • success_renewal()
      • success_revocation()
      • report_executed_command()
      • validated_input()
      • validated_directory()
    • certbot.display.util module
      • OK
      • CANCEL
      • notify()
      • notification()
      • menu()
      • input_text()
      • yesno()
      • checklist()
      • directory_select()
      • assert_valid_call()
• certbot.plugins package
  • Submodules
    • certbot.plugins.common module
      • option_namespace()
      • dest_namespace()
      • Plugin
        • Plugin.add_parser_arguments()
        • Plugin.inject_parser_options()
        • Plugin.option_namespace
        • Plugin.option_name()
        • Plugin.dest_namespace
        • Plugin.dest()
        • Plugin.conf()
        • Plugin.auth_hint()
      • Installer
        • Installer.add_to_checkpoint()
        • Installer.finalize_checkpoint()
        • Installer.recovery_routine()
        • Installer.revert_temporary_config()
        • Installer.rollback_checkpoints()
        • Installer.ssl_dhparams
        • Installer.updated_ssl_dhparams_digest
        • Installer.install_ssl_dhparams()
      • Configurator
      • Addr
        • Addr.fromstring()
        • Addr.normalized_tuple()
        • Addr.get_addr()
        • Addr.get_port()
        • Addr.get_addr_obj()
        • Addr.get_ipv6_exploded()
      • ChallengePerformer
        • ChallengePerformer.add_chall()
        • ChallengePerformer.perform()
      • install_version_controlled_file()
      • dir_setup()
    • certbot.plugins.dns_common module
      • DNSAuthenticator
        • DNSAuthenticator.add_parser_arguments()
        • DNSAuthenticator.auth_hint()
        • DNSAuthenticator.get_chall_pref()
        • DNSAuthenticator.prepare()
        • DNSAuthenticator.more_info()
        • DNSAuthenticator.perform()
        • DNSAuthenticator.cleanup()
      • CredentialsConfiguration
        • CredentialsConfiguration.require()
        • CredentialsConfiguration.conf()
      • validate_file()
      • validate_file_permissions()
      • base_domain_name_guesses()
    • certbot.plugins.dns_common_lexicon module
      • LexiconClient
        • LexiconClient.add_txt_record()
        • LexiconClient.del_txt_record()
      • build_lexicon_config()
      • LexiconDNSAuthenticator
    • certbot.plugins.dns_test_common module
      • BaseAuthenticatorTest
        • BaseAuthenticatorTest.achall
        • BaseAuthenticatorTest.test_more_info()
        • BaseAuthenticatorTest.test_get_chall_pref()
        • BaseAuthenticatorTest.test_parser_arguments()
      • write()
    • certbot.plugins.dns_test_common_lexicon module
      • BaseLexiconAuthenticatorTest
        • BaseLexiconAuthenticatorTest.test_perform()
        • BaseLexiconAuthenticatorTest.test_cleanup()
      • BaseLexiconClientTest
        • BaseLexiconClientTest.DOMAIN_NOT_FOUND
        • BaseLexiconClientTest.GENERIC_ERROR
        • BaseLexiconClientTest.LOGIN_ERROR
        • BaseLexiconClientTest.UNKNOWN_LOGIN_ERROR
        • BaseLexiconClientTest.record_prefix
        • BaseLexiconClientTest.record_name
        • BaseLexiconClientTest.record_content
        • BaseLexiconClientTest.test_add_txt_record()
        • BaseLexiconClientTest.test_add_txt_record_try_twice_to_find_domain()
        • BaseLexiconClientTest.test_add_txt_record_fail_to_find_domain()
        • BaseLexiconClientTest.test_add_txt_record_fail_to_authenticate()
        • BaseLexiconClientTest.test_add_txt_record_fail_to_authenticate_with_unknown_error()
        • BaseLexiconClientTest.test_add_txt_record_error_finding_domain()
        • BaseLexiconClientTest.test_add_txt_record_error_adding_record()
        • BaseLexiconClientTest.test_del_txt_record()
        • BaseLexiconClientTest.test_del_txt_record_fail_to_find_domain()
        • BaseLexiconClientTest.test_del_txt_record_fail_to_authenticate()
        • BaseLexiconClientTest.test_del_txt_record_fail_to_authenticate_with_unknown_error()
        • BaseLexiconClientTest.test_del_txt_record_error_finding_domain()
        • BaseLexiconClientTest.test_del_txt_record_error_deleting_record()
      • BaseLexiconDNSAuthenticatorTest
        • BaseLexiconDNSAuthenticatorTest.DOMAIN_NOT_FOUND
        • BaseLexiconDNSAuthenticatorTest.GENERIC_ERROR
        • BaseLexiconDNSAuthenticatorTest.LOGIN_ERROR
        • BaseLexiconDNSAuthenticatorTest.UNKNOWN_LOGIN_ERROR
        • BaseLexiconDNSAuthenticatorTest.test_perform_succeed()
        • BaseLexiconDNSAuthenticatorTest.test_perform_with_one_domain_resolution_failure_succeed()
        • BaseLexiconDNSAuthenticatorTest.test_perform_with_two_domain_resolution_failures_raise()
        • BaseLexiconDNSAuthenticatorTest.test_perform_with_domain_resolution_general_failure_raise()
        • BaseLexiconDNSAuthenticatorTest.test_perform_with_auth_failure_raise()
        • BaseLexiconDNSAuthenticatorTest.test_perform_with_unknown_auth_failure_raise()
        • BaseLexiconDNSAuthenticatorTest.test_perform_with_create_record_failure_raise()
        • BaseLexiconDNSAuthenticatorTest.test_cleanup_success()
        • BaseLexiconDNSAuthenticatorTest.test_cleanup_with_auth_failure_ignore()
        • BaseLexiconDNSAuthenticatorTest.test_cleanup_with_unknown_auth_failure_ignore()
        • BaseLexiconDNSAuthenticatorTest.test_cleanup_with_domain_resolution_failure_ignore()
        • BaseLexiconDNSAuthenticatorTest.test_cleanup_with_domain_resolution_general_failure_ignore()
        • BaseLexiconDNSAuthenticatorTest.test_cleanup_with_delete_record_failure_ignore()
    • certbot.plugins.enhancements module
      • ENHANCEMENTS
      • enabled_enhancements()
      • are_requested()
      • are_supported()
      • enable()
      • populate_cli()
      • AutoHSTSEnhancement
        • AutoHSTSEnhancement.update_autohsts()
        • AutoHSTSEnhancement.deploy_autohsts()
        • AutoHSTSEnhancement.enable_autohsts()
    • certbot.plugins.storage module
      • PluginStorage
        • PluginStorage.save()
        • PluginStorage.put()
        • PluginStorage.fetch()
    • certbot.plugins.util module
      • get_prefixes()
      • path_surgery()
• certbot.tests package
  • Submodules
    • certbot.tests.acme_util module
      • chall_to_challb()
      • gen_authzr()
    • certbot.tests.util module
      • DummyInstaller
        • DummyInstaller.get_all_names()
        • DummyInstaller.deploy_cert()
        • DummyInstaller.enhance()
        • DummyInstaller.supported_enhancements()
        • DummyInstaller.save()
        • DummyInstaller.config_test()
        • DummyInstaller.restart()
        • DummyInstaller.add_parser_arguments()
        • DummyInstaller.prepare()
        • DummyInstaller.more_info()
      • vector_path()
      • load_vector()
      • load_cert()
      • load_jose_rsa_private_key_pem()
      • load_rsa_private_key_pem()
      • make_lineage()
      • patch_display_util()
      • patch_display_util_with_stdout()
      • FreezableMock
        • FreezableMock.freeze()
      • TempDirTestCase
        • TempDirTestCase.setUp()
        • TempDirTestCase.tearDown()
      • ConfigTestCase
        • ConfigTestCase.setUp()
      • lock_and_call()
      • skip_on_windows()
      • temp_join()

Submodules

• certbot.achallenges module
  • AnnotatedChallenge
    • AnnotatedChallenge.challb
  • KeyAuthorizationAnnotatedChallenge
    • KeyAuthorizationAnnotatedChallenge.response_and_validation()
    • KeyAuthorizationAnnotatedChallenge.challb
    • KeyAuthorizationAnnotatedChallenge.domain
    • KeyAuthorizationAnnotatedChallenge.account_key
  • DNS
    • DNS.acme_type
    • DNS.challb
    • DNS.domain
  • Other
    • Other.acme_type
    • Other.challb
    • Other.domain
• certbot.crypto_util module
  • generate_key()
  • generate_csr()
  • valid_csr()
  • csr_matches_pubkey()
  • import_csr_file()
  • make_key()
  • valid_privkey()
  • verify_renewable_cert()
  • verify_renewable_cert_sig()
  • verify_signed_payload()
  • verify_cert_matches_priv_key()
  • verify_fullchain()
  • get_sans_from_cert()
  • get_names_from_cert()
  • get_names_from_req()
  • notBefore()
  • notAfter()
  • sha256sum()
  • cert_and_chain_from_fullchain()
  • get_serial_from_cert()
  • find_chain_with_issuer()
• certbot.errors module
  • Error
  • AccountStorageError
  • AccountNotFound
  • ReverterError
  • SubprocessError
  • CertStorageError
  • HookCommandNotFound
  • SignalExit
  • OverlappingMatchFound
  • LockError
  • AuthorizationError
  • FailedChallenges
  • PluginError
  • PluginEnhancementAlreadyPresent
  • PluginSelectionError
  • NoInstallationError
  • MisconfigurationError
  • NotSupportedError
  • PluginStorageError
  • StandaloneBindError
  • ConfigurationError
  • MissingCommandlineFlag
• certbot.interfaces module
  • AccountStorage
    • AccountStorage.find_all()
    • AccountStorage.load()
    • AccountStorage.save()
  • Plugin
    • Plugin.description
    • Plugin.name
    • Plugin.prepare()
    • Plugin.more_info()
    • Plugin.inject_parser_options()
  • Authenticator
    • Authenticator.get_chall_pref()
    • Authenticator.perform()
    • Authenticator.cleanup()
  • Installer
    • Installer.get_all_names()
    • Installer.deploy_cert()
    • Installer.enhance()
    • Installer.supported_enhancements()
    • Installer.save()
    • Installer.rollback_checkpoints()
    • Installer.recovery_routine()
    • Installer.config_test()
    • Installer.restart()
  • RenewableCert
    • RenewableCert.cert_path
    • RenewableCert.key_path
    • RenewableCert.chain_path
    • RenewableCert.fullchain_path
    • RenewableCert.lineagename
    • RenewableCert.names()
  • GenericUpdater
    • GenericUpdater.generic_updates()
  • RenewDeployer
    • RenewDeployer.renew_deploy()
• certbot.main module
  • main()
• certbot.ocsp package
  • RevocationChecker
    • RevocationChecker.ocsp_revoked()
    • RevocationChecker.ocsp_revoked_by_paths()
• certbot.reverter module
  • Reverter
    • Reverter.revert_temporary_config()
    • Reverter.rollback_checkpoints()
    • Reverter.add_to_temp_checkpoint()
    • Reverter.add_to_checkpoint()
    • Reverter.register_file_creation()
    • Reverter.register_undo_command()
    • Reverter.recovery_routine()
    • Reverter.finalize_checkpoint()
• certbot.util module
  • Key
    • Key.file
    • Key.pem
  • CSR
    • CSR.file
    • CSR.data
    • CSR.form
  • LooseVersion
    • LooseVersion.try_risky_comparison()
  • env_no_snap_for_external_calls()
  • run_script()
  • exe_exists()
  • lock_dir_until_exit()
  • set_up_core_dir()
  • make_or_verify_dir()
  • safe_open()
  • unique_file()
  • unique_lineage_name()
  • safely_remove()
  • get_filtered_names()
  • get_os_info()
  • get_os_info_ua()
  • get_systemd_os_like()
  • get_var_from_file()
  • get_python_os_info()
  • safe_email()
  • DeprecatedArgumentAction
  • add_deprecated_argument()
  • enforce_le_validity()
  • enforce_domain_sanity()
  • is_ipaddress()
  • is_wildcard_domain()
  • is_staging()
  • atexit_register()
  • parse_loose_version()