← Back
Editing: common.cpython-38.pyc
U �]�J � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl m Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lmZ dd lmZ ddlm Z dd lmZ dd lmZ dd lmZ e� e �Z dd� Z dd� Z e�!d�Z"e�!dej#�Z$e j%�&ej'�G dd� de(��Z)G dd� de)�Z*G dd� de(�Z+G dd� de(�Z,G d d � d e,�Z-d d � Z.d d!� Z/G d"d#� d#e(�Z0e0ej1e �ej1e < dS )$zPlugin common functions.� N)�util)�List)� achallenges)� constants)� crypto_util)�errors)� interfaces)�reverter)�os)� filesystem)� PluginStoragec C s | d S )�9ArgumentParser options namespace (prefix of all options).�-� ��namer r �8/usr/lib/python3/dist-packages/certbot/plugins/common.py�option_namespace s r c C s | � dd�d S )�;ArgumentParser dest namespace (prefix of all destinations).r �_)�replacer r r r �dest_namespace$ s r zX(^127\.0\.0\.1)|(^10\.)|(^172\.1[6-9]\.)|(^172\.2[0-9]\.)|(^172\.3[0-1]\.)|(^192\.168\.)z3^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*[a-z]+$c @ sb e Zd ZdZdd� Zejdd� �Zedd� �Z e dd � �Z d d � Z e d d � �Z dd� Zdd� ZdS )�PluginzGeneric plugin.c C s || _ || _d S �N)�configr )�selfr r r r r �__init__5 s zPlugin.__init__c C s dS )a� 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. :param callable add: Function that proxies calls to `argparse.ArgumentParser.add_argument` prepending options with unique plugin name prefix. Nr )�cls�addr r r �add_parser_arguments9 s zPlugin.add_parser_argumentsc s � �fdd�}| � |�S )zYInject parser options. See `~.IPlugin.inject_parser_options` for docs. c s �j d�t� �| �f|�|�S )Nz--{0}{1})� add_argument�formatr )Zarg_name_no_prefix�args�kwargs�r �parserr r r O s ���z)Plugin.inject_parser_options.<locals>.add)r )r r% r r r r$ r �inject_parser_optionsG s z Plugin.inject_parser_optionsc C s t | j�S )r )r r �r r r r r V s zPlugin.option_namespacec C s | j | S )z'Option name (include plugin namespace).)r )r r r r r � option_name[ s zPlugin.option_namec C s t | j�S )r )r r r' r r r r _ s zPlugin.dest_namespacec C s | j |�dd� S )z.Find a destination for given variable ``var``.r r )r r �r �varr r r �destd s z Plugin.destc C s t | j| �|��S )z0Find a configuration value for variable ``var``.)�getattrr r+ r) r r r �confj s z Plugin.confN)�__name__� __module__� __qualname__�__doc__r � jose_util�abstractclassmethodr � classmethodr& �propertyr r( r r+ r- r r r r r / s r c st e Zd ZdZ� fdd�Zddd�Zdd� Zd d � Zd d � Zddd�Z dd� Z e dd� �Z e dd� �Z dd� Z� ZS )� Installerz�An installer base class with reverter and ssl_dhparam methods defined. Installer plugins do not have to inherit from this class. c s4 t t| �j||� t| j| j�| _t�| j�| _d S r ) �superr6 r r r r Zstorager ZReverter)r r" r# �� __class__r r r u s zInstaller.__init__Fc C s\ |r| j j}n| j j}z|||� W n2 tjk rV } zt�t|���W 5 d}~X Y nX dS )a� Add files to a checkpoint. :param set save_files: set of filepaths to save :param str save_notes: notes about changes during the save :param bool temporary: True if the files should be added to a temporary checkpoint rather than a permanent one. This is usually used for changes that will soon be reverted. :raises .errors.PluginError: when unable to add to checkpoint N)r Zadd_to_temp_checkpoint�add_to_checkpointr � ReverterError� PluginError�str)r Z save_filesZ save_notesZ temporaryZcheckpoint_func�errr r r r: z s zInstaller.add_to_checkpointc C sH z| j �|� W n2 tjk rB } zt�t|���W 5 d}~X Y nX dS )z�Timestamp and save changes made through the reverter. :param str title: Title describing checkpoint :raises .errors.PluginError: when an error occurs N)r �finalize_checkpointr r; r< r= )r �titler> r r r r? � s z Installer.finalize_checkpointc C sF z| j �� W n2 tjk r@ } zt�t|���W 5 d}~X Y nX dS )z�Revert all previously modified files. Reverts all modified files that have not been saved as a checkpoint :raises .errors.PluginError: If unable to recover the configuration N)r �recovery_routiner r; r< r= �r r> r r r rA � s zInstaller.recovery_routinec C sF z| j �� W n2 tjk r@ } zt�t|���W 5 d}~X Y nX dS )zkRollback temporary checkpoint. :raises .errors.PluginError: when unable to revert config N)r �revert_temporary_configr r; r< r= rB r r r rC � s z!Installer.revert_temporary_config� c C sH z| j �|� W n2 tjk rB } zt�t|���W 5 d}~X Y nX dS )z�Rollback saved checkpoints. :param int rollback: 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 N)r �rollback_checkpointsr r; r< r= )r Zrollbackr> r r r rE � s z Installer.rollback_checkpointsc C sx t jdtdd� t �� �V t �ddt� z| j�� W n2 tjk rh } zt� t |���W 5 d}~X Y nX W 5 Q R X dS )z�Show all of the configuration changes that have taken place. :raises .errors.PluginError: If there is a problem while processing the checkpoints directories. z�The view_config_changes method is no longer part of Certbot's plugin interface, has been deprecated, and will be removed in a future release.� �� stacklevel�ignorez.*view_config_changesN) �warnings�warn�DeprecationWarning�catch_warnings�filterwarningsr �view_config_changesr r; r< r= rB r r r rO � s � z Installer.view_config_changesc C s t j�| jjtj�S )z(Full absolute path to ssl_dhparams file.)r �path�joinr � config_dirr ZSSL_DHPARAMS_DESTr' r r r � ssl_dhparams� s zInstaller.ssl_dhparamsc C s t j�| jjtj�S )z:Full absolute path to digest of updated ssl_dhparams file.)r rP rQ r rR r ZUPDATED_SSL_DHPARAMS_DIGESTr' r r r �updated_ssl_dhparams_digest� s z%Installer.updated_ssl_dhparams_digestc C s t | j| jtjtj�S )zJCopy Certbot's ssl_dhparams file into the system's config dir if required.)� install_version_controlled_filerS rT r ZSSL_DHPARAMS_SRCZALL_SSL_DHPARAMS_HASHESr' r r r �install_ssl_dhparams� s �z Installer.install_ssl_dhparams)F)rD )r. r/ r0 r1 r r: r? rA rC rE rO r5 rS rT rV � __classcell__r r r8 r r6 o s r6 c @ sv e Zd ZdZd dd�Zedd� �Zdd� Zd d � Zd d � Z d d� Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� ZdS ) �Addrz�Represents an virtual host address. :param str addr: addr part of vhost address :param str port: port number or \*, or "" Fc C s || _ || _d S r )�tup�ipv6)r rY rZ r r r r � s z Addr.__init__c C s� |� d�rh|�d�}|d|d � }d}t|�|d krX||d dkrX||d d� }| ||fdd �S |�d�}| |d |d f�S dS ) z Initialize Addr from string.�[�]NrD � rF �:T)rZ r )� startswith�rfind�len� partition)r Zstr_addrZendIndexZhost�portrY r r r � fromstring� s zAddr.fromstringc C s | j d rd| j S | j d S )NrD z%s:%sr �rY r' r r r �__str__ s z Addr.__str__c C s | j r| �� | jd fS | jS )z5Normalized representation of addr/port tuple rD )rZ �get_ipv6_explodedrY r' r r r �normalized_tuple s zAddr.normalized_tuplec C s t || j�r | �� |�� kS dS )NF)� isinstancer9 rh )r �otherr r r �__eq__ s z Addr.__eq__c C s t | j�S r )�hashrY r' r r r �__hash__ s z Addr.__hash__c C s | j d S )z Return addr part of Addr object.r re r' r r r �get_addr s z Addr.get_addrc C s | j d S )z Return port.rD re r' r r r �get_port s z Addr.get_portc C s | � | jd |f| j�S )z6Return new address object with same addr and new port.r )r9 rY rZ )r rc r r r � get_addr_obj# s zAddr.get_addr_objc C s |� d�}|�d�}| �|�S )z7Return IPv6 address in normalized form, helper functionr[ r\ )�lstrip�rstrip� _explode_ipv6)r �addrr r r �_normalize_ipv6' s zAddr._normalize_ipv6c C s | j r d�| �| jd ��S dS )z Return IPv6 in normalized formr^ r r] )rZ rQ ru rY r' r r r rg - s zAddr.get_ipv6_explodedc C s� ddddddddg}|� d�}t|�t|�kr>|dt|�� }d}t|�D ]P\}}|s^d}qJnt|�dkrt|�d�}|s�t|�||< qJt|�||t|� < qJ|S )z#Explode IPv6 address for comparison�0r^ r FTrD )�splitra � enumeraterq r= )r rt �resultZ addr_listZ append_to_end�i�blockr r r rs 3 s zAddr._explode_ipv6N)F)r. r/ r0 r1 r r4 rd rf rh rk rm rn ro rp ru rg rs r r r r rX � s rX c @ s* e Zd ZdZdd� Zd dd�Zdd� ZdS ) �ChallengePerformerav Abstract base for challenge performers. :ivar configurator: Authenticator and installer plugin :ivar achalls: Annotated challenges :vartype achalls: `list` of `.KeyAuthorizationAnnotatedChallenge` :ivar indices: Holds the indices of challenges from a larger array so the user of the class doesn't have to. :vartype indices: `list` of `int` c C s || _ g | _g | _d S r )� configurator�achalls�indices�r r} r r r r X s zChallengePerformer.__init__Nc C s$ | j �|� |dk r | j�|� dS )z�Store challenge to be performed when perform() is called. :param .KeyAuthorizationAnnotatedChallenge achall: Annotated challenge. :param int idx: index to challenge in a larger array N)r~ �appendr )r �achall�idxr r r � add_chall] s z ChallengePerformer.add_challc C s t � �dS )z�Perform all added challenges. :returns: challenge responses :rtype: `list` of `acme.challenges.KeyAuthorizationChallengeResponse` N)�NotImplementedErrorr' r r r �performi s zChallengePerformer.perform)N)r. r/ r0 r1 r r� r� r r r r r| L s r| c sB e Zd ZdZ� fdd�Zdd� Zdd� Zdd � Zd d d �Z� Z S )�TLSSNI01z1Abstract base for TLS-SNI-01 challenge performersc s( t t| ��|� tj�|jjd�| _d S )Nz!le_tls_sni_01_cert_challenge.conf) r7 r� r r rP rQ r rR Zchallenge_confr� r8 r r r x s �zTLSSNI01.__init__c C s t j�| jjj|j�d�d �S )z�Returns standardized name for challenge certificate. :param .KeyAuthorizationAnnotatedChallenge achall: Annotated tls-sni-01 challenge. :returns: certificate file name :rtype: str �tokenz.crt�r rP rQ r} r �work_dirZchall�encode�r r� r r r � get_cert_path~ s �zTLSSNI01.get_cert_pathc C s t j�| jjj|j�d�d �S )z'Get standardized path to challenge key.r� z.pemr� r� r r r � get_key_path� s �zTLSSNI01.get_key_pathc C s |� |j�j�d�S )z.Returns z_domain (SNI) name for the challenge.zutf-8)�responseZ account_keyZz_domain�decoder� r r r � get_z_domain� s zTLSSNI01.get_z_domainNc C s� | � |�}| �|�}| jj�d|� | jj�d|� |j|d�\}\}}tj�tjj |�}tj� tjj |�} t |d��} | � |� W 5 Q R X t j|ddd��} | � | � W 5 Q R X |S )z-Generate and write out challenge certificate.T)�cert_key�wb� )�chmod)r� r� r} r Zregister_file_creationZresponse_and_validation�OpenSSLZcryptoZdump_certificateZ FILETYPE_PEMZdump_privatekey�open�writer Z safe_open) r r� r� Z cert_pathZkey_pathr� Zcert�keyZcert_pemZkey_pemZ cert_chall_fdZkey_filer r r �_setup_challenge_cert� s( � � � z TLSSNI01._setup_challenge_cert)N) r. r/ r0 r1 r r� r� r� r� rW r r r8 r r� t s r� c s� t ������fdd�� � ��fdd�}tj���s>|� dS t ���}|�krTdS ||krd|� nLtj���r�t�d��}|�� }W 5 Q R X |�kr�dS � � t�d���� dS )a� Copy a file into an active location (likely the system's config dir) if required. :param str dest_path: destination path for version controlled file :param str digest_path: path to save a digest of the file in :param str src_path: path to version controlled file found in distribution :param list all_hashes: hashes of every released version of the file c s$ t �d��} | �� � W 5 Q R X d S )N�w)r� r� )�f)� current_hash� digest_pathr r �_write_current_hash� s z<install_version_controlled_file.<locals>._write_current_hashc s t ���� � � d S r )�shutilZcopyfiler )r� � dest_path�src_pathr r �_install_current_file� s z>install_version_controlled_file.<locals>._install_current_fileN�rzh%s has been manually modified; updated file saved to %s. We recommend updating %s for security purposes.) r Z sha256sumr rP �isfiler� �read�loggerZwarning)r� r� r� Z all_hashesr� Zactive_file_digestr� Z saved_digestr )r� r� r� r� r� r rU � s, �rU c C s� dd� }|d�}|d�}|d�}t �|tj� t �|tj� t �|tj� t�|tj�d| ��}t j |tj�|| �dd� |||fS ) z5Setup the directories necessary for the configurator.c S s t �t�| ��S )a� Return the real path of a temp directory with the specified prefix Some plugins rely on real paths of symlinks for working correctly. For example, certbot-apache uses real paths of configuration files to tell a virtual host from another. On systems where TMP itself is a symbolic link, (ex: OS X) such plugins will be confused. This function prevents such a case. )r �realpath�tempfileZmkdtemp)�prefixr r r �expanded_tempdir� s z#dir_setup.<locals>.expanded_tempdirZtempr ZworkZtestdataT)Zsymlinks) r r� r ZCONFIG_DIRS_MODE� pkg_resourcesZresource_filenamer rP rQ r� Zcopytree)Ztest_dir�pkgr� Ztemp_dirrR r� Z test_configsr r r � dir_setup� s" � �r� c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd S ) �_TLSSNI01DeprecationModulez� Internal class delegating to a module, and displaying warnings when attributes related to TLS-SNI-01 are accessed. c C s || j d< d S �N�_module)�__dict__)r �moduler r r r s z#_TLSSNI01DeprecationModule.__init__c C s$ |dkrt jdtdd� t| j|�S )Nr� z0TLSSNI01 is deprecated and will be removed soon.rF rG )rJ rK rL r, r� �r �attrr r r � __getattr__ s �z&_TLSSNI01DeprecationModule.__getattr__c C s t | j||� d S r )�setattrr� )r r� �valuer r r � __setattr__ s z&_TLSSNI01DeprecationModule.__setattr__c C s t | j|� d S r )�delattrr� r� r r r � __delattr__ s z&_TLSSNI01DeprecationModule.__delattr__c C s dgt | j� S r� )�dirr� r' r r r �__dir__ s z"_TLSSNI01DeprecationModule.__dir__N) r. r/ r0 r1 r r� r� r� r� r r r r r� s r� )2r1 Zlogging�rer� �sysr� rJ r� r� Zzope.interface�zopeZjosepyr r2 Zacme.magic_typingr Zcertbotr r r r r r Zcertbot.compatr r Zcertbot.plugins.storager Z getLoggerr. r� r r �compileZprivate_ips_regex� IGNORECASEZhostname_regexZ interfaceZ implementerZIPlugin�objectr r6 rX r| r� rU r� r� �modulesr r r r �<module> sR � � ?{b(92!
Save File
Cancel