certbot.plugins.common module

內部類給模塊，并在訪問與TLS-SNI-01相關的屬性時顯示警告。

certbot.plugins.common.``option_namespace(name)[source]
ArgumentParser選項名稱空間（所有選項的前綴）。

certbot.plugins.common.``dest_namespace(name)[source]
ArgumentParser dest名稱空間（所有目標的前綴）。

classcertbot.plugins.common.``Plugin(config, name)[source]
Bases: object
通用插件
classmethodadd_parser_arguments(add)[source]
將插件參數添加到CLI參數解析器。
注意：如果您的某些標志與其他標志交互，則可以使用cli.report_config_interaction進行注冊，以確保在更新期間正確保存/覆蓋值。
Parameters: add (callable) – 該函數argparse.ArgumentParser.add_argument使用唯一的插件名稱前綴代理對前置選項的調用 。
classmethodinject_parser_options(parser, name)[source]
注入解析器選項。
請參閱inject_parser_options以獲取文檔。
option_namespace
ArgumentParser選項名稱空間（所有選項的前綴）。
option_name(name)[source]
選項名稱（包括插件名稱空間）。
dest_namespace
ArgumentParser dest名稱空間（所有目標的前綴）。
dest（var *）[資源]
查找給定變量的目的地var。
conf（var *）[資源]
查找變量的配置值var。

classcertbot.plugins.common.Installer(args, kwargs)[source]
Based： certbot.plugins.common.Plugin
安裝程序基類，其中定義了reverter和ssl_dhparam方法。
安裝程序插件不必從此類繼承。
add_to_checkpoint(save_files, save_notes, temporary=False)[source]
Parameters:

• save_files (set) – 要保存的文件路徑集
• save_notes (str) – 關于保存期間更改的注釋
• temporary (bool) – 如果文件應添加到臨時檢查點而不是永久檢查點，則為true。通常用于即將恢復的更改。
  Raises: errors.PluginError – 無法添加到檢查點時
  finalize_checkpoint(title)[source]
  時間戳記并保存通過還原器進行的更改。
  Parameters: title (str) -描述檢查點的標題
  Raises: errors.PluginError -發生錯誤
  recovery_routine()[source]
  還原所有先前修改的文件。
  還原所有尚未保存為檢查點的已修改文件
  Raises: errors.PluginError -如果無法恢復配置
  revert_temporary_config()[source]
  Rollback temporary checkpoint.
  Raises: errors.PluginError – when unable to revert config
  rollback_checkpoints(rollback=1)[source]
  Rollback saved checkpoints.
  Parameters: rollback (int) – Number of checkpoints to revert
  Raises: errors.PluginError – If there is a problem with the input or the function is unable to correctly revert the configuration
  ssl_dhparams
  Full absolute path to ssl_dhparams file.
  updated_ssl_dhparams_digest
  Full absolute path to digest of updated ssl_dhparams file.
  install_ssl_dhparams()[source]
  Copy Certbot’s ssl_dhparams file into the system’s config dir if required.

classcertbot.plugins.common.Addr(tup, ipv6=False)source
Bases: object
Represents an virtual host address.
Parameters: - addr (str) – addr part of vhost address- port (str) – port number or , or “”
*classmethodfromstring(str_addr)[source]
Initialize Addr from string.
normalized_tuple()[source]
Normalized representation of addr/port tuple
get_addr()[source]
Return addr part of Addr object.
get_port()[source]
Return port.
get_addr_obj(port)[source]
Return new address object with same addr and new port.
get_ipv6_exploded()[source]
Return IPv6 in normalized form

classcertbot.plugins.common.ChallengePerformer(configurator)source
Bases: object
Abstract base for challenge performers.
Variables: - configurator – Authenticator and installer plugin- achalls (list of KeyAuthorizationAnnotatedChallenge) – Annotated challenges- indices (list of int) – Holds the indices of challenges from a larger array so the user of the class doesn’t have to.
add_chall(achall, idx=None)[source]
Store challenge to be performed when perform() is called.
Parameters: - achall (KeyAuthorizationAnnotatedChallenge) – Annotated challenge.- idx (int) – index to challenge in a larger array
perform()[source]
Perform all added challenges.
Returns: challenge responses
Return type: list of acme.challenges.KeyAuthorizationChallengeResponse

certbot.plugins.common.install_version_controlled_file(dest_path, digest_path, src_path, all_hashes)source
Copy a file into an active location (likely the system’s config dir) if required.
Parameters:

• dest_path (str) – destination path for version controlled file
• digest_path (str) – path to save a digest of the file in
• src_path (str) – path to version controlled file found in distribution
• all_hashes (list) – hashes of every released version of the file

certbot.plugins.common.dir_setup(test_dir, pkg)[source]
Setup the directories necessary for the configurator.