a Z,É_7ã@sªdZddlZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z ddl m Z ddlmZddlmZe e¡ZGd d „d eƒZd d „Zd d„ZdS)z@ApacheParser is a member object of the ApacheConfigurator class.éN)ÚDict)ÚList)Úerrors)Úos)Ú apache_util)Ú constantsc@s„eZdZdZe d¡Zhd£Zd^dd„Zdd „Z d d „Z d d „Z dd„Z dd„Z dd„Zdd„Zdd„Zdd„Zdd„Zdd„Zdd„Zd d!„Zd"d#„Zd$d%„Zd&d'„Zd(d)„Zd_d+d,„Zd`d-d.„Zd/d0„Zd1d2„Zd3d4„Zdad5d6„Zdbd8d9„Z d:d;„Z!dd?„Z#d@dA„Z$dBdC„Z%dDdE„Z&dFdG„Z'dHdI„Z(dJdK„Z)dLdM„Z*dNdO„Z+dPdQ„Z,dRdS„Z-dTdU„Z.dVdW„Z/dXdY„Z0dZd[„Z1d\d]„Z2dS)cÚ ApacheParseraÉClass handles the fine details of parsing the Apache Configuration. .. todo:: Make parsing general... remove sites-available etc... :ivar str root: Normalized absolute path to the server root directory. Without trailing slash. :ivar set modules: All module names that are currently enabled. :ivar dict loc: Location to place directives, root - configuration origin, default - user config file, name - NameVirtualHost, z \$\{[^ \}]*}>ú?Ú*ú]ú\ú[N©éécCsì||_d|_| ¡| ¡s&t d¡‚i|_i|_i|_t j   |¡|_ d|  ¡i|_| |jd¡|dkrt| ¡| ¡| ¡|j | ¡¡t |j¡|_|rÈ| t j   |¡d|j d¡¡|dkrè|jdddrèt d ¡‚dS) NzˆApache plugin support requires libaugeas0 and augeas-lenses version 1.2.0 or higher, please make sure you have you have those installed.Úrootrú/Z vhost_filesZDefineF)ÚexcludezError parsing runtime variables)Ú configuratorÚaugÚ init_augeasÚcheck_aug_versionrZNotSupportedErrorÚmodulesÚ parser_pathsÚ variablesrÚpathÚabspathrÚ_find_config_rootÚlocÚ parse_fileÚupdate_runtime_variablesÚstandardize_exclÚ parse_modulesÚupdateÚ_set_locationsÚcopyÚdeepcopyÚexisting_pathsÚoptionÚfind_dirÚ PluginError)ÚselfrZ vhostrootÚversionr©r-úA/usr/lib/python3/dist-packages/certbot_apache/_internal/parser.pyÚ__init__#s4ÿ ÿzApacheParser.__init__cCsTz ddl}Wnty(t d¡‚Yn0|jtj|jj|jjB|jj Bd|_ dS)z' Initialize the actual Augeas instance rNzProblem in Augeas installation)ZloadpathÚflags) ÚaugeasÚ ImportErrorrÚNoInstallationErrorZAugeasrZAUGEAS_LENS_DIRZNONEZNO_MODL_AUTOLOADZ ENABLE_SPANr)r+r1r-r-r.rYs  ÿþûzApacheParser.init_augeasc Csv|j d¡}|D]`}|j |d¡}|r||vrd |dt|ƒd…|j |d¡|j |d¡¡}t |¡‚qdS) zÜVerify Augeas can parse all of the lens files. :param str lens: lens to check for errors :raises .errors.PluginError: If there has been an error in parsing with the specified lens. ú/augeas//errorz/lensz@There has been an error in parsing the file {0} on line {1}: {2}é éz/linez/messageN)rÚmatchÚgetÚformatÚlenrr*)r+ZlensZ error_filesrZ lens_pathÚmsgr-r-r.Úcheck_parsing_errorsjs  ûÿz!ApacheParser.check_parsing_errorscCsP|j dd¡z|j d¡}Wn ty>|j d¡YdS0|j d¡|S)z Checks that we have recent enough version of libaugeas. If augeas version is recent enough, it will support case insensitive regexp matchingz/test/path/testing/argZaRgUMeNTz,/test//*[self::arg=~regexp('argument', 'i')]z /test/pathF)rÚsetr7Ú RuntimeErrorÚremove)r+Úmatchesr-r-r.r„sÿ   zApacheParser.check_aug_versionc Cs´|j d¡}|j dd¡|j d¡}z|j ¡Wn2ttfyf| |¡d|j_ t   d¡‚Yn0|j d|¡|j d¡}tƒ}|r°|D]}|  |j |¡dd…¡q|S) a™Lists files that have modified Augeas DOM but the changes have not been written to the filesystem yet, used by `self.save()` and ApacheConfigurator to check the file state. :raises .errors.PluginError: If there was an error in Augeas, in an attempt to save the configuration, or an error creating a checkpoint :returns: `set` of unsaved files z /augeas/saveZnoopr4Úz-Error saving files, check logs for more info.z/augeas/events/savedr6N) rr8r=r7Úsaver>ÚIOErrorÚ_log_save_errorsrÚ save_notesrr*Úadd)r+Z save_stateÚex_errsZ save_pathsÚ save_filesrr-r-r.Ú unsaved_files“s$   ÿ  zApacheParser.unsaved_filescCs&| ¡r"|jjd7_|j ¡dS)zÙMakes sure that all Augeas dom changes are written to files to avoid loss of configuration directives when doing additional augeas parsing, causing a possible augeas.load() resulting dom reset z (autosave)N)rIrrErB©r+r-r-r.Úensure_augeas_stateºsz ApacheParser.ensure_augeas_statecCs>d|j_|j ¡|r:|D]}|j d|¡q|j ¡dS)zõSaves all changes to the configuration files. save() is called from ApacheConfigurator to handle the parser specific tasks of saving. :param list save_files: list of strings of file paths that we need to save. rAz/files/N)rrErrBr?Úload)r+rHZsfr-r-r.rBÄs  zApacheParser.savecs6|j d¡}t dd ‡fdd„|Dƒ¡|jj¡dS)zfLog errors due to bad Augeas save. :param list ex_errs: Existing errors before save r4z2Unable to save files: %s. Attempted Save Notes: %sz, c3s*|]"}|ˆvr|dt|ƒd…VqdS)r5r6N)r:)Ú.0Úerr©rGr-r.Ú ásþz0ApacheParser._log_save_errors..N)rr7ÚloggerÚerrorÚjoinrrE)r+rGZnew_errsr-rOr.rD×s  ýzApacheParser._log_save_errorscCsd| tdƒ|¡s`t d|t|ƒ¡| t|ƒd|¡tj |¡}tj  |¡}|j   |g¡  |¡dS)zÃAdd Include for a new configuration file if one does not exist :param str main_config: file path to main Apache config file :param str inc_path: path of file to include ÚIncludezAdding Include %s to %sN) r)Úcase_irQÚdebugÚ get_aug_pathÚadd_dirrrÚdirnameÚbasenamer'Ú setdefaultÚappend)r+Z main_configZinc_pathZnew_dirZnew_filer-r-r.Ú add_includeåsÿþ  zApacheParser.add_includecCsD|d|jvrd|j|d<d|d|jvr@d|jd|d<dS)z%Shortcut for updating parser modules.Ú_moduleNZmod_z.c)r)r+Úmod_namer-r-r.Úadd_modøszApacheParser.add_modcCsi|_| ¡| ¡dS)zgReset the loaded modules list. This is called from cleanup to clear temporarily loaded modules.N)rÚupdate_modulesr"rJr-r-r.Ú reset_modulesÿszApacheParser.reset_modulesc Cs®i}| d¡}t|ƒ}d}t|ƒ|kržt|ƒ}tj ||¡D]^\}}| |¡}| |¡}|r†|r†|||<||tj  |¡dd…d<qUpdates the dictionary of known variables in the configurationÚctlN)rZ parse_definesrr(rrJr-r-r.rk)szApacheParser.update_definescCsB| d¡}t |j d¡¡}|r>|D]}| |¡s$| |¡q$dS)z>Get includes from httpd process, and add them to DOM if neededrTrmN)r)rZparse_includesrr(Úparsed_in_currentr)r+Ú_r@Úir-r-r.rl.s   zApacheParser.update_includescCs.t |j d¡¡}|D]}| | ¡¡qdS)z:Get loaded modules from httpd process, and add them to DOMrmN)rr"rr(r`Ústrip)r+r@Úmodr-r-r.ra<szApacheParser.update_modulescCs®g}|dkr@t|ƒD](\}}| d¡r| ||dd…¡qnjt|ƒD]`\}}| d|¡rH|t|ƒdksˆ||d d|d¡sH| ||dtd|ƒ …¡qH|S)aFilter out directives with specific number of arguments. This function makes the assumption that all related arguments are given in order. Thus /files/apache/directive[5]/arg[2] must come immediately after /files/apache/directive[5]/arg[1]. Runs in 1 linear pass. :param string matches: Matches of all directives with arg nodes :param int args: Number of args you would like to filter :returns: List of directives that contain # of arguments. (arg is stripped off) éú/argNéüÿÿÿú/arg[%d])Ú enumerateÚendswithr\r:)r+r@ÚargsZfilteredrpr7r-r-r.Úfilter_args_numCs ÿÿ"zApacheParser.filter_args_numcCsŠ| |d¡}|j |ddd¡|d}|j ||¡t|ƒdkrZ|j |d|d¡n,t|ƒD]"\}}|j d ||df|¡qbd S) aáAdds directive and value to IfMod ssl block. Adds given directive and value along configuration path within an IfMod mod_ssl.c block. If the IfMod block does not exist in the file, it is created. :param str aug_conf_path: Desired Augeas config path to add directive :param str directive: Directive you would like to add, e.g. Listen :param args: Values of the directive; str "443" or list of str :type args: list z mod_ssl.cÚargÚ directiveFz directive[1]rsrtrz %s/arg[%d]N)Ú get_ifmodrÚinsertr=r:rw)r+Ú aug_conf_pathr|ryZ if_mod_pathZnvh_pathrpr{r-r-r.Úadd_dir_to_ifmodsslbs  z ApacheParser.add_dir_to_ifmodsslFcCs8|j d||f¡}|s&| |||¡S|d d¡dS)aReturns the path to and creates one if it doesn't exist. :param str aug_conf_path: Augeas configuration path :param str mod: module ie. mod_ssl.c :param bool beginning: If the IfModule should be created to the beginning of augeas path DOM tree. :returns: Augeas path of the requested IfModule directive that pre-existed or was created during the process. The path may be dynamic, i.e. .../IfModule[last()] :rtype: str z%s/IfModule/*[self::arg='%s']rr{)rr7Ú create_ifmodÚ rpartition)r+rrrÚ beginningZif_modsr-r-r.r}|s ÿzApacheParser.get_ifmodcCsn|r0d |¡}|j d |¡dd¡d |¡}n,d |¡}d |¡}|j |d¡d  |¡}|j ||¡|S) aµCreates a new and returns its path. :param str aug_conf_path: Augeas configuration path :param str mod: module ie. mod_ssl.c :param bool beginning: If the IfModule should be created to the beginning of augeas path DOM tree. :returns: Augeas path of the newly created IfModule directive. The path may be dynamic, i.e. .../IfModule[last()] :rtype: str z{}/IfModule[1]/argz{}/directive[1]ZIfModuleTz{}/IfModule[1]/z{}/IfModule[last() + 1]z{}/IfModule[last()]/argrAz{}/IfModule[last()]/)r9rr~r=)r+rrrrƒZ c_path_argZretpathZc_pathr-r-r.r’s  ÿ    zApacheParser.create_ifmodcCs^|j |d|¡t|tƒrHt|dƒD]\}}|j d||f|¡q&n|j |d|¡dS)aAppends directive to the end fo the file given by aug_conf_path. .. note:: Not added to AugeasConfigurator because it may depend on the lens :param str aug_conf_path: Augeas configuration path to add directive :param str directive: Directive to add :param args: Value of the directive. ie. Listen 443, 443 is arg :type args: list or str z/directive[last() + 1]rsz%s/directive[last()]/arg[%d]z/directive[last()]/argN)rr=Ú isinstanceÚlistrw)r+rr|ryrpÚvaluer-r-r.rX­s   ÿzApacheParser.add_dircCsr|d}|j |dd¡|j ||¡t|tƒr\t|dƒD]\}}|j |d||¡q:n|j |d|¡dS)a)Adds the directive to the beginning of defined aug_conf_path. :param str aug_conf_path: Augeas configuration path to add directive :param str dirname: Directive to add :param args: Value of the directive. ie. Listen 443, 443 is arg :type args: list or str z /directive[1]r|TrsrvrtN)rr~r=r„r…rw)r+rrYryZ first_dirrpr†r-r-r.Úadd_dir_beginningÁs zApacheParser.add_dir_beginningcCs|j |d|¡dS)z§Adds the comment to the augeas path :param str aug_conf_path: Augeas configuration path to add directive :param str comment: Comment content z/#comment[last() + 1]N)rr=)r+rÚcommentr-r-r.Ú add_commentÒszApacheParser.add_commentcCsR|st|jƒ}|j d|¡}g}|D]&}|j |¡}|r&||vr&| |¡q&|S)aFinds a comment with specified content from the provided DOM path :param str arg: Comment content to search :param str start: Beginning Augeas path to begin looking :returns: List of augeas paths containing the comment content :rtype: list z%s//*[label() = '#comment'])rWrrr7r8r\)r+r{ÚstartZcommentsZresultsrˆZ c_contentr-r-r.Ú find_commentsÛs     zApacheParser.find_commentsTc CsÚ|st|jdƒ}dt|ƒtdƒtdƒf}|j d||f¡}|rN| |¡}|dur\d}n dt|ƒ}g}|D]d} |j | ¡ ¡} | d vr²| |  |||  |  | d¡¡|¡¡| | ¡krp| |j | |¡¡qp|S) a Finds directive in the configuration. Recursively searches through config files to find directives Directives should be in the form of a case insensitive regex currently .. todo:: arg should probably be a list .. todo:: arg search currently only supports direct matching. It does not handle the case of variables or quoted arguments. This should be adapted to use a generic search for the directive and then do a case-insensitive self.get_arg filter Note: Augeas is inherently case sensitive while Apache is case insensitive. Augeas 1.0 allows case insensitive regexes like regexp(/Listen/, "i"), however the version currently supported by Ubuntu 0.10 does not. Thus I have included my own case insensitive transformation by calling case_i() on everything to maintain compatibility. :param str directive: Directive to look for :param arg: Specific value directive must have, None if all should be considered :type arg: str or None :param str start: Beginning Augeas path to begin looking :param bool exclude: Whether or not to exclude directives based on variables and enabled modules rz(%s)|(%s)|(%s)rTZIncludeOptionalz$%s//*[self::directive=~regexp('%s')]Nrtz/*[self::arg=~regexp('%s')])ZincludeZincludeoptional) rWrrUrr7Ú exclude_dirsr8ÚlowerÚextendr)Ú_get_include_pathri) r+r|r{rŠrZregexr@Z arg_suffixZordered_matchesr7Zdir_r-r-r.r)ñs4þ ÿ  ý zApacheParser.find_dircs6|ddkr|d}ˆj |d¡}‡fdd„|DƒS)zÑ Tries to fetch all arguments for a directive. See get_arg. Note that if match is an ancestor node, it returns all names of child directives as well as the list of arguments. rcrr csg|]}ˆ |¡‘qSr-)ri)rMr{rJr-r.Ú Ióz-ApacheParser.get_all_args..)rr7)r+r7Zallargsr-rJr.Ú get_all_args=s zApacheParser.get_all_argsc Csx|j |¡}|sdS| d¡}tj |¡}|D]D}z| ||j|dd…¡}Wq.typt   d|¡‚Yq.0q.|S)zŽUses augeas.get to get argument value and interprets result. This also converts all variables and parameters appropriately. Nú'"rrczError Parsing variable: %s) rr8rqrÚarg_var_interpreterÚfindallÚreplacerÚKeyErrorrr*)r+r7r†rÚvarr-r-r.riKs    zApacheParser.get_argcCst|jdƒS)z@ Returns the Augeas path of root configuration. r)rWrrJr-r-r.Úget_root_augpathgszApacheParser.get_root_augpathcCsNd|j ¡fd|jfg}g}|D](}|D]}| ||¡s(q q(| |¡q |S)z>Exclude directives that are not loaded into the configuration.ZifmoduleZifdefine)rÚkeysrÚ _pass_filterr\)r+r@ÚfiltersZ valid_matchesr7Úfilter_r-r-r.rŒms  zApacheParser.exclude_dirscCsŒ| ¡}| |d¡}|dkrˆ| d|¡}|j |d|…d¡}| d¡rf|dd…|dvrvdSn||dvrvdS| |d|¡}qd S) zÐDetermine if directive passes a filter. :param str match: Augeas path :param list filter: list of tuples of form [("lowercase if directive", set of relevant parameters)] rrcrNrtú!rsFT)rÚfindrr8Ú startswith)r+r7rZmatch_lZlast_match_idxZ end_of_ifZ expressionr-r-r.r›{s   zApacheParser._pass_filtercCs>| d¡}| d¡s.tj tj |j|¡¡}n tj |¡}|S)z¢Ensure paths are consistent and absolute :param str arg: Argument of directive :returns: Standardized argument path :rtype: str r“r)rqr rrÚnormpathrSr)r+r{r-r-r.Ústandard_path_from_server_root˜s   z+ApacheParser.standard_path_from_server_rootcCsˆ| |¡}tj |¡r,| tj |d¡¡n | |¡| d¡}t|ƒD],\}}tdd„|DƒƒrHd|  |¡||<qHd |¡}t |ƒS)a@Converts an Apache Include directive into Augeas path. Converts an Apache Include directive argument into an Augeas searchable path .. todo:: convert to use os.path.join() :param str arg: Argument of Include directive :returns: Augeas path string :rtype: str r rcss|]}|tjvVqdS)N)rÚ fnmatch_chars)rMÚcharr-r-r.rPÌr‘z1ApacheParser._get_include_path..z* [label()=~regexp('%s')]) r¢rrÚisdirrrSÚsplitrwÚanyÚ fnmatch_to_rerW)r+r{Z split_argÚidxr¦r-r-r.r«s    ÿ  zApacheParser._get_include_pathcCs.tjdkrt |¡dd…St |¡dd…S)aˆMethod converts Apache's basic fnmatch to regular expression. Assumption - Configs are assumed to be well-formed and only writable by privileged users. https://apr.apache.org/docs/apr/2.0/apr__fnmatch_8h_source.html :param str clean_fn_match: Apache style filename match, like globs :returns: regex suitable for augeas :rtype: str )ér6Niùÿÿÿréýÿÿÿ)ÚsysÚ version_infoÚfnmatchÚ translate)r+Zclean_fn_matchr-r-r.r¨×s zApacheParser.fnmatch_to_recCsT| |¡\}}| ¡|rP|j d|¡}|sP|r<| |¡| |¡|j ¡dS)zÙParse file with Augeas Checks to see if file_path is parsed by Augeas If filepath isn't parsed, the file is added and Augeas is reloaded :param str filepath: Apache config file path z&/augeas/load/Httpd['%s' =~ glob(incl)]N)Ú_check_path_actionsrKrr7Ú_remove_httpd_transformÚ_add_httpd_transformrL)r+ÚfilepathÚuse_newÚ remove_oldZinc_testr-r-r.rës ÿ  zApacheParser.parse_filecCs| ||j¡S)a<Checks if the file path is parsed by current Augeas parser config ie. returns True if the file is found on a path that's found in live Augeas configuration. :param str filep: Path to match :returns: True if file is parsed in existing configuration tree :rtype: bool )Ú_parsed_by_parser_pathsr©r+Úfilepr-r-r.rns zApacheParser.parsed_in_currentcCs| ||j¡S)a[Checks if the file path is parsed by existing Apache config. ie. returns True if the file is found on a path that matches Include or IncludeOptional statement in the Apache configuration. :param str filep: Path to match :returns: True if file is parsed in existing configuration tree :rtype: bool )r¶r'r·r-r-r.Úparsed_in_originals zApacheParser.parsed_in_originalc Cs:|D]0}||D]"}t |tj ||¡¡rdSqqdS)znHelper function that searches through provided paths and returns True if file path is found in the setTF)r®rrrS)r+r¸ÚpathsZ directoryÚfilenamer-r-r.r¶s   z$ApacheParser._parsed_by_parser_pathscCs`z.)rSrÇÚescape)Ústringr-r-r.rU§s ÿrUcCsd|S)zTReturn augeas path for full filepath. :param str file_path: Full filepath z/files%sr-)Z file_pathr-r-r.rW·srW)rÆr%r®ZloggingrÇr¬rgZacme.magic_typingrrZcertbotrZcertbot.compatrZcertbot_apache._internalrrZ getLoggerrÃrQÚobjectrrUrWr-r-r-r.Ús.