certbot.plugins.common
¶
Plugin common functions.
-
certbot.plugins.common.
option_namespace
(name)[source]¶ ArgumentParser options namespace (prefix of all options).
-
certbot.plugins.common.
dest_namespace
(name)[source]¶ ArgumentParser dest namespace (prefix of all destinations).
-
class
certbot.plugins.common.
Plugin
(config, name)[source]¶ Bases:
object
Generic plugin.
-
classmethod
add_parser_arguments
(add)[source]¶ Add plugin arguments to the CLI argument parser.
NOTE: If some of your flags interact with others, you can use cli.report_config_interaction to register this to ensure values are correctly saved/overridable during renewal.
Parameters: add (callable) – Function that proxies calls to argparse.ArgumentParser.add_argument
prepending options with unique plugin name prefix.
-
classmethod
inject_parser_options
(parser, name)[source]¶ Inject parser options.
See
inject_parser_options
for docs.
-
option_namespace
¶ ArgumentParser options namespace (prefix of all options).
-
dest_namespace
¶ ArgumentParser dest namespace (prefix of all destinations).
-
classmethod
-
class
certbot.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 “”
-
class
certbot.plugins.common.
TLSSNI01
(configurator)[source]¶ Bases:
object
Abstract base for TLS-SNI-01 challenge performers
-
add_chall
(achall, idx=None)[source]¶ Add challenge to TLSSNI01 object to perform at once.
Parameters: - achall (KeyAuthorizationAnnotatedChallenge) – Annotated TLSSNI01 challenge.
- idx (int) – index to challenge in a larger array
-
get_cert_path
(achall)[source]¶ Returns standardized name for challenge certificate.
Parameters: achall (KeyAuthorizationAnnotatedChallenge) – Annotated tls-sni-01 challenge. Returns: certificate file name Return type: str
-
-
certbot.plugins.common.
install_ssl_options_conf
(options_ssl, options_ssl_digest, mod_ssl_conf_src, all_ssl_options_hashes)[source]¶ Copy Certbot’s SSL options file into the system’s config dir if required.
Parameters: - options_ssl (str) – destination path for file containing ssl options
- options_ssl_digest (str) – path to save a digest of options_ssl in
- mod_ssl_conf_src (str) – path to file containing ssl options found in distribution
- all_ssl_options_hashes (list) – hashes of every released version of options_ssl