a
}|g @ sp U d Z ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lm Z dd
l
m Z dd l
m Z dd l
mZ g d
Ze jeeeef ddf dddZe jedddZe je e j edddZe e j ee e e j e jddddZed dddd ZG d d d eejd Z d d!d"ej d# d$d%gd#d&e d'd(d)d* gZ eeeef e d+< dS ),z(New interface style Certbot enhancements N)Any)Callable)Dict) Generator)Iterable)List)Optional)
configuration)
interfaces) constants)Zredirectzensure-http-headerz
ocsp-stapling)configreturnc c s" t D ]}t| |d r|V qdS )z
Generator to yield the enabled new style enhancements.
:param config: Configuration.
:type config: certbot.configuration.NamespaceConfig
cli_destN)_INDEXgetattr)r enh r @/usr/lib/python3.9/site-packages/certbot/plugins/enhancements.pyenabled_enhancements s r c C s t t| S )z
Checks if one or more of the requested enhancements are those of the new
enhancement interfaces.
:param config: Configuration.
:type config: certbot.configuration.NamespaceConfig
)anyr )r r r r
are_requested( s r )r installerr
c C s& t | D ]}t||d s dS qdS )ai
Checks that all of the requested enhancements are supported by the
installer.
:param config: Configuration.
:type config: certbot.configuration.NamespaceConfig
:param installer: Installer object
:type installer: interfaces.Installer
:returns: If all the requested enhancements are supported by the installer
:rtype: bool
classFT)r
isinstance)r r r r r r
are_supported3 s r )lineagedomainsr r r
c C s* |r&t |D ]}t||d | | q dS )a
Run enable method for each requested enhancement that is supported.
:param lineage: Certificate lineage object
:type lineage: certbot.interfaces.RenewableCert
:param domains: List of domains in certificate to enhance
:type domains: str
:param installer: Installer object
:type installer: interfaces.Installer
:param config: Configuration.
:type config: certbot.configuration.NamespaceConfig
enable_functionN)r r )r r r r r r r r enableH s r ).N)addr
c C s: t D ]0}| |d |d |d |d |d |d d qdS ) z
Populates the command line flags for certbot._internal.cli.HelpfulParser
:param add: Add function of certbot._internal.cli.HelpfulParser
:type add: func
cli_groupscli_flag
cli_actionr cli_flag_defaultcli_help)actiondestdefaulthelpN)r )r r r r r populate_cli_ s
r) c @ sn e Zd ZdZejejeeddddZ ejejeeddddZ
eje ej e e
eeddd d
ZdS ) AutoHSTSEnhancementa;
Enhancement interface that installer plugins can implement in order to
provide functionality that configures the software to have a
'Strict-Transport-Security' with initially low max-age value that will
increase over time.
The plugins implementing new style enhancements are responsible of handling
the saving of configuration checkpoints as well as calling possible restarts
of managed software themselves. For update_autohsts method, the installer may
have to call prepare() to finalize the plugin initialization.
Methods:
enable_autohsts is called when the header is initially installed using a
low max-age value.
update_autohsts is called every time when Certbot is run using 'renew'
verb. The max-age value should be increased over time using this method.
deploy_autohsts is called for every lineage that has had its certificate
renewed. A long HSTS max-age value should be set here, as we should be
confident that the user is able to automatically renew their certificates.
N)r argskwargsr
c O s dS )a
Gets called for each lineage every time Certbot is run with 'renew' verb.
Implementation of this method should increase the max-age value.
:param lineage: Certificate lineage object
:type lineage: certbot.interfaces.RenewableCert
.. note:: prepare() method inherited from `interfaces.Plugin` might need
to be called manually within implementation of this interface method
to finalize the plugin initialization.
Nr selfr r+ r, r r r update_autohsts s z#AutoHSTSEnhancement.update_autohstsc O s dS )a
Gets called for a lineage when its certificate is successfully renewed.
Long max-age value should be set in implementation of this method.
:param lineage: Certificate lineage object
:type lineage: certbot.interfaces.RenewableCert
Nr r- r r r deploy_autohsts s z#AutoHSTSEnhancement.deploy_autohsts)r r r+ r, r
c O s dS )a
Enables the AutoHSTS enhancement, installing
Strict-Transport-Security header with a low initial value to be increased
over the subsequent runs of Certbot renew.
:param lineage: Certificate lineage object
:type lineage: certbot.interfaces.RenewableCert
:param domains: List of domains in certificate to enhance
:type domains: `list` of `str`
Nr )r. r r r+ r, r r r enable_autohsts s z#AutoHSTSEnhancement.enable_autohsts)__name__
__module__ __qualname____doc__abcabstractmethodr
RenewableCertr r/ r0 r r strr1 r r r r r* l s
r* ) metaclassZAutoHSTSzUGradually increasing max-age value for HTTP Strict Transport Security security headerz --auto-hstsZ auto_hstsZsecurityZenhance
store_truer/ r0 r1 ) namer$ r! r# r r r" r Zupdater_functionZdeployer_functionr r ) r5 r6 typingr r r r r r r Zcertbotr r
Zcertbot._internalr Z ENHANCEMENTSZNamespaceConfigr9 r boolr Z Installerr r8 r r) objectABCMetar* Z CLI_DEFAULTSr __annotations__r r r r sJ
G