File: //lib/python3.9/site-packages/certbot/_internal/cli/__pycache__/helpful.cpython-39.pyc
a
}|�gyX � @ sn d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm
Z
dd lm Z ddl Z dd
l
mZ dd l
mZ dd l
mZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm Z ddl m Z ddl m Z ddl!m"Z# ddl$m%Z% ddl&m'Z' dd l&m(Z( G d d � d �Z)dS ) z$Certbot command line argument parser� N)�Any)�Dict)�Iterable)�List)�Optional)�Tuple)�Union)� crypto_util)�errors)�util)� constants)�hooks)�COMMAND_OVERVIEW)�HELP_AND_VERSION_USAGE)� SHORT_USAGE)� add_domains)�CustomHelpFormatter)� flag_default)�HelpfulArgumentGroup)�set_test_server_options)� VERB_HELP)�
VERB_HELP_MAP)�obj)�disco)�ArgumentSource)�NamespaceConfigc @ s� e Zd ZdZee ee dd�dd�Zg d�Zed�dd �Z ee e
ee f ed
�d d �Z e
dd
�dd�Zeeef d�dd�Zeejd�dd�Ze
d�dd�Ze
dd
�dd�Ze
dd
�dd�Zdd�dd �Zeeee e
ee f d �d d �Zee
eee ef eedd �d!d"�Z ee
eee ef eeejd �d#d$�Z ee dd%�d&d'�Z d2eee ee d)�d*d+�Z!e"j#dd,�d-d.�Z$e
ee f eee e f d/�d0d1�Z%dS )3�HelpfulArgumentParserz�Argparse Wrapper.
This class wraps argparse, adding the ability to make --help less
verbose, and request help on specific subcategories at a time, eg
'certbot --help security' for security options.
N)�args�plugins�returnc C s� ddl m} |j|j|j|j|j|j|j|j|j |j
|j |j |j|j
|j|j|jd�| _t�tj�j| _g | _g d�}|t| j�| j dg 7 }t|�}|| d g | _|| _ | j r�| j d dkr�d| j d< | � � | � d| j�}| � d| j�}| t |t ��rt |t ��r|�p|| _!nt |t"��r*|n|| _!| �#|| j!�}| �$| j!�| _%i | _&t'j(d |t)d
d gt*d �d
�+d�,t*d ���d�| _-d| j-_.| d S )Nr )�main)�auth�certonly�run�installr �register�update_account� show_account�
unregister�renew�revoke�rollback�
everything� certificates�delete�enhance� reconfigure)�allZsecurity�pathsZ
automationZtestingZmanage�help�--help�-h�certbot�-c�--configZ config_filesz"path to config file (default: {0})z and )�prog�usage�formatter_classZ args_for_setting_config_pathZdefault_config_filesZconfig_arg_help_messageF)/�certbot._internalr r" r# r$ Z plugins_cmdr% r& r' r( r) r* r+ r- r. r/ r0 �VERBS� display_objZNoninteractiveDisplay�sys�stdoutZ notification�notify�actions�list�COMMANDS_TOPICS� help_topicsr �determine_verb�prescan_for_flag�
isinstance�bool�help_arg�str�
_usage_string�determine_help_topics�visible_topics�groups�configargparseZ ArgParserr r �format�join�parserZ_add_config_file_help) �selfr r r Z HELP_TOPICSZ plugin_namesZhelp1Zhelp2Z short_usage� rU �A/usr/lib/python3.9/site-packages/certbot/_internal/cli/helpful.py�__init__- sd �
��
z HelpfulArgumentParser.__init__)ZcommandZcommandsZ
subcommand� subcommands�verbs)r c C sT t dd� tD ��}d}tt�D ](\}}|�dd�}|dj|||d�7 }q |d7 }|S ) Nc s s | ]}t |�V qd S �N)�len)�.0�vrU rU rV � <genexpr>v � z:HelpfulArgumentParser._list_subcommands.<locals>.<genexpr>z,The full list of available SUBCOMMANDS is:
�short� z{0:<{length}} {1}
)�lengthzG
You can get more help on a specific subcommand with --help SUBCOMMAND
)�maxr �sortedr �getrQ )rT Zlongest�text�verbZprops�docrU rU rV �_list_subcommandsu s z'HelpfulArgumentParser._list_subcommands)r rJ r c C s� d|v rd}nd}d|v r d}nd}t }|du rV| �|t||f t � t�d� nl|| jv r~| �|| �� � t�d� nD|d kr�|t||f 7 }n*t|t �r�t
� |i �� d
d �}|r�|n|}|S ) a# Make usage strings late so that plugins can be initialised late
:param plugins: all discovered plugins
:param help_arg: False for none; True for --help; "TOPIC" for --help TOPIC
:rtype: str
:returns: a short usage string for the top of --help TOPIC)
ZnginxzH--nginx Use the Nginx plugin for authentication & installationz+(the certbot nginx plugin is not installed)ZapachezI--apache Use the Apache plugin for authentication & installationz,(the certbot apache plugin is not installed)Tr r1 r: N) r rA r r r? �exitrD ri rH rK r re )rT r rJ Z nginx_docZ
apache_docr: ZcustomrU rU rV rL � s&
z#HelpfulArgumentParser._usage_string)�configr c C s2 |j dusJ �|j d tjkr.| jdkr.g |_dS )z8Make "certbot renew" safe if domains are set in cli.ini.N�domainsr) )Zargument_sourcesr � CONFIG_FILErg rl �rT rk rU rU rV �&remove_config_file_domains_for_renewal� s
�z<HelpfulArgumentParser.remove_config_file_domains_for_renewalc sX dd� �j D �� �j�� }ttttjtf f td d�� �fdd� }|D ] }|� d�rH||| tj
� qH||� di �tj � d|v �rT|d }|d \}}g }|D ]�}|� d
�s�q�|d v r�tj
� d < q�d
|v r�|�d
�d }nd|v r�|�d�d }|� d��r |�|� q�|dd � D ]} |�d
| � �� �qq�|D ] }��|�}
tj
� |
j< �q6� S )Nc S s i | ]}|j tj�qS rU )�destr ZDEFAULT�r\ �actionrU rU rV �
<dictcomp>� r_ z=HelpfulArgumentParser._build_sources_dict.<locals>.<dictcomp>)�
settings_dict�sourcer c s2 �fdd�| � � D �}��� fdd�|D �� d S )Nc s* g | ]"\}\}}|d u r"� � |�n|�qS rZ )�_find_action_for_arg)r\ �argrr �_)rT rU rV �
<listcomp>� s
�zTHelpfulArgumentParser._build_sources_dict.<locals>.update_result.<locals>.<listcomp>c s i | ] }|j � �qS rU )rp rq �ru rU rV rs � r_ zTHelpfulArgumentParser._build_sources_dict.<locals>.update_result.<locals>.<dictcomp>)�items�update)rt ru rB ��resultrT rz rV �
update_result� s
�z@HelpfulArgumentParser._build_sources_dict.<locals>.update_resultZ config_fileZenv_varZ command_linera �-)r7 r8 Z
config_dir�=r � �--� )rB rS Zget_source_to_settings_dictr rK r rP �Actionr �
startswithrm re ZENV_VARZ COMMAND_LINE�split�appendrv rp ) rT Zsource_to_settings_dictr Z
source_keyrt rx Zunprocessed_argsr rw Z short_argrr rU r} rV �_build_sources_dict� s>
�
z)HelpfulArgumentParser._build_sources_dict)rw r c C st |d dkrd| }| j D ]}||jv r| S q| j D ]&}|jD ]}|�|�rB| S qBq8td|� d���d S )Nr r� r� z!Action corresponding to argument z is None)rB �option_stringsr� �AssertionError)rT rw rr �
option_stringrU rU rV rv � s
z*HelpfulArgumentParser._find_action_for_argc C s< | j �| j�}| j| j |_| j|_t|�}|�| �� � | � |� | jdkrl|j
rft � d�
tj���d|_|j
r�|jr�t � d�
tj���|js�|jr�| �|� |jr�| �|� |jr�|js�d|_|jr�t�|� |jr�tdd� |j D ��r�t � d��|j �r|j �rt � d��t |j t!��r8t"|j �d k�r8t � d
��|S ) z�Parses command line arguments and returns the result.
:returns: parsed command line arguments
:rtype: configuration.NamespaceConfig
r) z {0} cannot be used with renewTz.Flag for non-interactive mode and {0} conflictc s s | ]}t �|�V qd S rZ )r Zis_wildcard_domain�r\ �drU rU rV r^ 0 r_ z3HelpfulArgumentParser.parse_args.<locals>.<genexpr>zFUsing --allow-subset-of-names with a wildcard domain is not supported.z@Parameters --hsts and --auto-hsts cannot be used simultaneously.r� z8Only *one* --key-type type may be provided at this time.)#rS �
parse_argsr r= rg �funcr Zset_argument_sourcesr� ro Zforce_interactiver
�ErrorrQ r ZFORCE_INTERACTIVE_FLAGZnoninteractive_modeZstaging�dry_run�set_test_server�csr�
handle_csrZ must_stapleZstapleZvalidate_hooksr
�allow_subset_of_names�anyrl ZhstsZ auto_hstsrH Zkey_typerC r[ )rT Z parsed_argsrk rU rU rV r� sP
�� ��
� �z HelpfulArgumentParser.parse_argsc C s t | j|�S )z�Updates server, break_my_certs, staging, tos, and
register_unsafely_without_email in config as necessary to prepare
to use the test server.)r rg rn rU rU rV r� > s z%HelpfulArgumentParser.set_test_serverc
C s� |j dkrt�d��|jr$t�d��|jdd� \}}t�||�\}}}|D ]}t||� qL|stt�d|jd ��||f|_dd� |D �}t |j
�} || kr�t� d � d
�
|�d
�
| ����d S ) zProcess a --csr flag.r" z�Currently, a CSR file may only be specified when obtaining a new or replacement via the certonly command. Please try the certonly command instead.z1--allow-subset-of-names cannot be used with --csrr � zJUnfortunately, your CSR %s needs to have a SubjectAltName for every domainc S s h | ] }|� � �qS rU )�lowerr� rU rU rV � <setcomp>^ r_ z3HelpfulArgumentParser.handle_csr.<locals>.<setcomp>zMInconsistent domain requests:
From the CSR: {0}
From command line/config: {1}z, N)rg r
r� r� r� r Zimport_csr_filer Z
actual_csr�setrl ZConfigurationErrorrQ rR )
rT rk Zcsrfile�contents�typr� rl �domainZ csr_domainsZconfig_domainsrU rU rV r� D s.
��
��z HelpfulArgumentParser.handle_csrc C sz d| j v sd| j v r d| _dS t| j �D ]F\}}|| jv r(|}|dkrJd}|dkrVd}|| _| j �|� dS q(d| _dS ) z�Determines the verb/subcommand provided by the user.
This function works around some of the limitations of argparse.
r5 r4 r3 Nr! r" r, r# )r rg � enumerater= �pop)rT �i�tokenrg rU rU rV rF f s
z$HelpfulArgumentParser.determine_verb)�flag�possible_argumentsr c C sR || j vrdS | j �|�}z | j |d }||v r8|W S W n tyL Y n0 dS )as Checks cli input for flags.
Check for a flag, which accepts a fixed set of possible arguments, in
the command line; we will use this information to configure argparse's
help correctly. Return the flag's argument, if it has one that matches
the sequence @possible_arguments; otherwise return whether the flag is
present.
Fr� T)r �index�
IndexError)rT r� r� �posZnxtrU rU rV rG ~ s
z&HelpfulArgumentParser.prescan_for_flag)�topicsr �kwargsr c O s$ | j �| j|g|�R i |��� dS )a1 Add a new command line argument.
:param topics: str or [str] help topic(s) this should be listed under,
or None for options that don't fit under a specific
topic which will only be shown in "--help all" output.
The first entry determines where the flag lives in the
"--help all" output (None -> "optional arguments").
:param list *args: the names of this argument flag
:param dict **kwargs: various argparse settings for this argument
N)rB r� �_add)rT r� r r� rU rU rV �add� s
zHelpfulArgumentParser.addc O s� |� d�}|tju r&| jj|i |��S t|t�rJ| j|v r@| jn|d }n|}t|t�s�| j | r�|| j
v r�| j
| }|j|i |��S | jj|i |��S n t j |d< | jj|i |��S d S )Nrr r r3 )
re r ZDeprecatedArgumentActionrS � add_argumentrH rC rJ rI rN rO �argparse�SUPPRESS)rT r� r r� rr �topic�grouprU rU rV r� � s
zHelpfulArgumentParser._add)�
argument_name�num_argsr c C s t �| jd�}t�|||� dS )a� Adds a deprecated argument with the name argument_name.
Deprecated arguments are not shown in the help. If they are used
on the command line, a warning is shown stating that the
argument is deprecated and no other action is taken.
:param str argument_name: Name of deprecated argument.
:param int num_args: Number of arguments the option takes.
N)� functools�partialr� r �add_deprecated_argument)rT r� r� Zadd_funcrU rU rV r� � s z-HelpfulArgumentParser.add_deprecated_argumentrU )r� rY r� r c K sZ | j | rP| jj|fi |��| j|< | jrP|D ] }| j| j|t| d d� q.t| |�S )a� Create a new argument group.
This method must be called once for every topic, however, calls
to this function are left next to the argument definitions for
clarity.
:param str topic: Name of the new argument group.
:param str verbs: List of subcommands that should be documented as part of
this help group / topic
:returns: The new argument group.
:rtype: `HelpfulArgumentGroup`
r` )r3 )rN rS �add_argument_grouprO rJ r� r r )rT r� rY r� r] rU rU rV � add_group� s
z HelpfulArgumentParser.add_group)r r c C s4 |� � D ]&\}}| j||jd�}|j�||� qdS )z�
Let each of the plugins add its own command line arguments, which
may or may not be displayed as help topics.
)� descriptionN)r{ r� Zlong_descriptionZ
plugin_clsZinject_parser_options)rT r �nameZ plugin_epZparser_or_grouprU rU rV �add_plugin_args� s
�z%HelpfulArgumentParser.add_plugin_args)� chosen_topicr c sX � dkr d� � dkrd� � dkr0dd� | j D �S � sDdd� | j D �S � fd d�| j D �S )
z�
The user may have requested help on a topic, return a dict of which
topics to display. @chosen_topic has prescan_for_flag's return type
:returns: dict
r! r" r, r# r1 c S s i | ]}||d k�qS )zcertbot-route53:authrU �r\ �trU rU rV rs r_ z?HelpfulArgumentParser.determine_help_topics.<locals>.<dictcomp>c S s i | ]
}|d �qS )FrU r� rU rU rV rs r_ c s i | ]}||� k�qS rU rU r� �r� rU rV rs r_ )rE )rT r� rU r� rV rM s z+HelpfulArgumentParser.determine_help_topics)rU )&�__name__�
__module__� __qualname__�__doc__r rK r rW rD ri r rI rL r ro r r r� rP r� rv r� r� r� rF r rG r r� r� �intr� r r� r ZPluginsRegistryr� rM rU rU rU rV r % s: F #D8"
� � �
�
�r )*r� r� r� r? �typingr r r r r r r rP r6 r r
r r< r r
Z#certbot._internal.cli.cli_constantsr r r Z certbot._internal.cli.cli_utilsr r r r r Z certbot._internal.cli.verb_helpr r Zcertbot._internal.displayr r> Zcertbot._internal.pluginsr Zcertbot.configurationr r r rU rU rU rV �<module> s>