3
گaQ @ s d Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddlm Z ddlm
Z
ddlm Z ddlm Z ddl
Z
dd lmZ dd
lmZ dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddl m Z ddl m Z ddl m Z ddl m Z ddl m!Z! ddl"m#Z# ddl"m$Z$ ddl%m&Z' dd l(m)Z) dd l*m+Z+ G d d d Z,dS ) z$Certbot command line argument parser N)Any)Dict)Iterable)List)Optional)Union) crypto_util)errors)util) constants)hooks)ARGPARSE_PARAMS_TO_REMOVE)COMMAND_OVERVIEW) EXIT_ACTIONS)HELP_AND_VERSION_USAGE) SHORT_USAGE)ZERO_ARG_ACTIONS)_Default) add_domains)CustomHelpFormatter) flag_default)HelpfulArgumentGroup) VERB_HELP)
VERB_HELP_MAP)obj)disco)osc @ sz e Zd ZdZd2ee ee eddddZddd d
d gZ ed d
dZ
ee e eef edddZ e
jddddZe
jd ddZe
jddddZe
jddddZdd dd Zeee e eef d d d Zee eee ef eedd d!d"Zeeeef d#d$d%Zeedd&d'd(Zf feee ee d)d*d+Z e j dd,d-d.Z e eef eeef d/d0d1Z!dS )3HelpfulArgumentParserzArgparse 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.
FN)argspluginsdetect_defaultsreturnc
C s ddl m} |j|j|j|j|j|j|j|j|j |j
|j |j|j |j
|j|jd| _tjtjj| _dddddg}|t| j| j d g 7 }t|}|| d g | _|| _|| _| jr| jd d
krd | jd< | j | j d | j}| j d | j}| t |t r t |t r |p|| _ nt |t!r,|n|| _ | j"|| j } | j#| j | _$i | _%i | _&t'j(d
| t)ddgt*ddj+dj,t*dd| _-d| j-_.| d S )Nr )main)authcertonlyruninstallr registerupdate_account
unregisterrenewrevokerollback
everythingupdate_symlinks certificatesdeleteenhanceallZsecuritypathsZ
automationZtestingZmanagehelpz--helpz-hcertbotz-cz--configZ config_filesz"path to config file (default: {0})z and )progusageZformatter_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/ r0 r1 VERBS display_objZNoninteractiveDisplaysysstdoutZ notificationnotifylistCOMMANDS_TOPICS help_topicsr r determine_verbprescan_for_flag
isinstanceboolhelp_argstr
_usage_stringdetermine_help_topicsvisible_topicsgroupsdefaultsconfigargparseZ ArgParserr r formatjoinparserZ_add_config_file_help)
selfr r r r" Z HELP_TOPICSZ plugin_namesZhelp1Zhelp2Z short_usage rQ /usr/lib/python3.6/helpful.py__init__0 s^
z HelpfulArgumentParser.__init__ZcommandZcommandsZ
subcommandZ subcommandsverbs)r! c C sX t dd tD }d}x4ttD ](\}}|jdd}|dj|||d7 }q W |d7 }|S ) Nc s s | ]}t |V qd S )N)len).0vrQ rQ rR z s z:HelpfulArgumentParser._list_subcommands..z,The full list of available SUBCOMMANDS is:
short z{0:<{length}} {1}
)ZlengthzG
You can get more help on a specific subcommand with --help SUBCOMMAND
)maxr sortedr getrM )rP ZlongesttextverbZpropsdocrQ rQ rR _list_subcommandsy s z'HelpfulArgumentParser._list_subcommands)r rE r! c C s d|krd}nd}d|kr d}nd}t }|dkrV| j|t||f t tjd nl|| jkr~| j|| j tjd nD|d kr|t||f 7 }n*t|t rt
j |i j 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 r2 r7 N) r r= r r r; exitr? ra rC rF r r] )rP r rE Z nginx_docZ
apache_docr7 ZcustomrQ rQ rR rG s&
z#HelpfulArgumentParser._usage_string) parsed_argsr! c C sL | j dkrHx<| jjj D ],\}}|jdrd|kr| jr>t ng |_qW dS )z8Make "certbot renew" safe if domains are set in cli.ini.r* Z config_filedomainsN)r_ rO Z_source_to_settingsitems
startswithr r rd )rP rc sourceflagsrQ rQ rR &remove_config_file_domains_for_renewal s
zt"|j d kr>t j d |S )
zParses command line arguments and returns the result.
:returns: parsed command line arguments
:rtype: argparse.Namespace
c s i | ]}t j jj||qS rQ )copydeepcopyrO Z get_default)rV key)rP rQ rR
s z4HelpfulArgumentParser.parse_args..r* z {0} cannot be used with renewTz.Flag for non-interactive mode and {0} conflictc s s | ]}t j|V qd S )N)r
Zis_wildcard_domain)rV drQ rQ rR rX s z3HelpfulArgumentParser.parse_args..zFUsing --allow-subset-of-names with a wildcard domain is not supported.z@Parameters --hsts and --auto-hsts cannot be used simultaneously. z8Only *one* --key-type type may be provided at this time.)#rO
parse_argsr r9 r_ funcri r varsrK Zforce_interactiver ErrorrM r ZFORCE_INTERACTIVE_FLAGZnoninteractive_modestagingdry_runset_test_servercsr
handle_csrZ must_stapleZstapleZvalidate_hooksr allow_subset_of_namesanyrd ZhstsZ auto_hstsrC Zkey_typer> rU )rP rc rQ )rP rR rp sH
z HelpfulArgumentParser.parse_argsc C s t dtjf}|jr(|j|kr(tjd|j|kr:tj|_|jr| jd krZtjd| j d |_ |_t
j
t j j
|jtjdrd|_d|_dS )
zGWe have --staging/--dry-run; perform sanity check and set config.serverserverz'--server value conflicts with --stagingr$ r* zN--dry-run currently only works with the 'certonly' or 'renew' subcommands (%r)T*N)r$ r* )r r Z STAGING_URIrt r{ r rs ru r_ Zbreak_my_certsglobr pathrN Z
config_dirZ ACCOUNTS_DIRZtosZ register_unsafely_without_email)rP rc Zdefault_serversrQ rQ rR rv s
z%HelpfulArgumentParser.set_test_serverc
C s |j dkrtjd|jr$tjd|jdd \}}tj||\}}}x|D ]}t|| qNW |sxtjd|jd ||f|_dd |D }t |j
} || krtj d j d
j
|d
j
| d S ) zProcess a --csr flag.r$ zCurrently, 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 | ] }|j qS rQ )lower)rV rn rQ rQ rR " s z3HelpfulArgumentParser.handle_csr..zMInconsistent domain requests:
From the CSR: {0}
From command line/config: {1}z, N)r_ r rs ry rw r Zimport_csr_filer Z
actual_csrsetrd ZConfigurationErrorrM rN )
rP rc Zcsrfilecontentstyprw rd ZdomainZ csr_domainsZconfig_domainsrQ rQ rR rx s&
z HelpfulArgumentParser.handle_csrc C s| d| j ksd| j kr d| _dS xRt| j D ]D\}}|| jkr*|}|dkrLd}|dkrXd}|| _| j j| dS q*W d| _dS ) zDetermines the verb/subcommand provided by the user.
This function works around some of the limitations of argparse.
z-hz--helpr4 Nr# r$ r- r% )r r_ enumerater9 pop)rP itokenr_ rQ rQ rR rA * s
z$HelpfulArgumentParser.determine_verb)flagpossible_argumentsr! c C sR || j krdS | j j|}y | j |d }||kr6|S W n tk
rL Y nX 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.
Fro T)r index
IndexError)rP r r posZnxtrQ rQ rR rB B s
z&HelpfulArgumentParser.prescan_for_flag)topicsr kwargsr! c O s |j d}|tjkr&| jj|| dS t|trJ| j|kr@| jn|d }n|}| jr`| j f |}t|t
r| j | r|| j kr| j | }|j|| q| jj|| nt
j|d< | jj|| 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
actionNr r4 )r] r
ZDeprecatedArgumentActionrO add_argumentrC r> rE r #modify_kwargs_for_default_detectionrF rI rJ argparseZSUPPRESS)rP r r r r topicgrouprQ rQ rR addW s
zHelpfulArgumentParser.add)r r! c K sP |j dd}|tkrL|tkr dnd|d< t |d< xtD ]}|j|d q8W |S )a_ Modify an arg so we can check if it was set by the user.
Changes the parameters given to argparse when adding an argument
so we can properly detect if the value was set by the user.
:param dict kwargs: various argparse settings for this argument
:returns: a modified versions of kwargs
:rtype: dict
r N
store_trueZstoredefault)r] r r r r
r )rP r r ZparamrQ rQ rR r s
z9HelpfulArgumentParser.modify_kwargs_for_default_detection)
argument_namenum_argsr! c C s t j| jd}tj||| 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) functoolspartialr r
add_deprecated_argument)rP r r Zadd_funcrQ rQ rR r s z-HelpfulArgumentParser.add_deprecated_argument)r rT r r! c K sZ | j | rP| jj|f|| j|< | jrPx(|D ] }| j| j|t| d d q,W 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`
rY )r4 )rI rO Zadd_argument_grouprJ rE r r r )rP r rT r rW rQ rQ rR add_group s
z HelpfulArgumentParser.add_group)r r! c C s8 x2|j D ]&\}}| j||jd}|jj|| q
W dS )z
Let each of the plugins add its own command line arguments, which
may or may not be displayed as help topics.
) descriptionN)re r Zlong_descriptionZ
plugin_clsZinject_parser_options)rP r nameZ plugin_epZparser_or_grouprQ rQ rR 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% r2 c S s i | ]}|d k|qS )zcertbot-route53:authrQ )rV trQ rQ rR rm s z?HelpfulArgumentParser.determine_help_topics..c S s i | ]
}d |qS )FrQ )rV r rQ rQ rR rm s c s i | ]}| k|qS rQ rQ )rV r )r rQ rR rm s )r@ )rP r rQ )r rR rH s z+HelpfulArgumentParser.determine_help_topics)F)"__name__
__module__ __qualname____doc__r rF r rD rS r? ra r rG r Z Namespaceri rp rv rx rA rB r r r r r intr r r r ZPluginsRegistryr rH rQ rQ rQ rR r ( s& F #< " - r )-r r rj r r} r; Ztypingr r r r r r rL r5 r r r
r8 r r Z#certbot._internal.cli.cli_constantsr
r r r 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.compatr r rQ rQ rQ rR sD