\\y@sdZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z m Z m Z ddl mZejeZGdddeZddZd d ZdS) z@ApacheParser is a member object of the ApacheConfigurator class.N)DictListSet)errorsc@seZdZdZejdZedddddgZddPdd d Z d dZ ddZ ddZ ddZ ddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zdd-d.Zddd/d0d1Zd2d3Zd4d5Zd6d7Zd8d9Zd:d;Z d<d=Z!d>d?Z"d@dAZ#dBdCZ$dDdEZ%dFdGZ&dHdIZ'dJdKZ(dLdMZ)dNdOZ*dS)Q ApacheParseraClass 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 \$\{[^ \}]*}*?\[]NcCs*||_t|_i|_i|_||_tjj||_ d|j i|_ |j |j d|d kr|j |j|j|j j|jtj|j|_|r|j tjj|d|jjd|d kr&|jdddr&tjd dS) Nrootr r /Z vhost_filesZDefineexcludeFzError parsing runtime variables)r r )r r ) configuratorsetmodules parser_paths variablesaugospathabspathr_find_config_rootloc parse_fileupdate_runtime_variablesstandardize_excl parse_modulesupdate_set_locationscopydeepcopyexisting_pathsoptionfind_dirr PluginError)selfrrZ vhostrootversionrr*7/usr/lib/python3/dist-packages/certbot_apache/parser.py__init__"s(          zApacheParser.__init__cCst|jtd|dkrtjd|t||jt|d|tjj |}tjj |}||j j kr|j |j |n|g|j |Get includes from httpd process, and add them to DOM if neededr-rMz-tz-DZ DUMP_INCLUDESz \(.*\) (.*)N)r&rr%rPparsed_in_currentr)r(_Zinc_cmdrIir*r*r+rLs  zApacheParser.update_includescCsX|jjddddg}|j|d}x!|D]}|j|jq7WdS)z:Get loaded modules from httpd process, and add them to DOMrMz-tz-DZ DUMP_MODULESz (.*)_moduleN)rr%rPr<strip)r(Zmod_cmdrImodr*r*r+r=s   zApacheParser.update_modulescCs%|j|}tj|j|S)zGet values from stdout of subprocess command :param list command: Command to run :param str regexp: Regexp for parsing :returns: list parsed from command output :rtype: list )_get_runtime_cfgrecompilefindall)r(commandZregexpstdoutr*r*r+rPs z"ApacheParser.parse_from_subprocesscCsy=tj|dtjdtjdd}|j\}}Wn@ttfk rtjd|tj t j d|YnX|j dkrtj d|t j d |S) zwGet runtime configuration info. :param command: Command to run :returns: stdout from command rbstderrZuniversal_newlinesTz2Error running command %s for runtime parameters!%sz,Error accessing loaded Apache parameters: %srz$Error in checking parameter list: %sz^Apache is unable to check whether or not the module is loaded because Apache is misconfigured.) subprocessPopenPIPEZ communicateOSErrorrRr0rTrlineseprZMisconfigurationError returncodeZwarning)r(raprocrbrcr*r*r+r]s&     zApacheParser._get_runtime_cfgcCsg}|dkr`xtt|D]4}||jdr%|j||ddq%Wnxtt|D]y}||jd|rs|t|dks||djd|d rs|j||dtd| qsW|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) r?z/argNr z/arg[%d])ranger.endswithr7)r(rIargsZfilteredrZr*r*r+filter_args_nums "*zApacheParser.filter_args_numcCs|j|d}|jj|ddd|d}|jj||t|dkry|jj|d|dn>x;t|D]-\}}|jjd ||df|qWd S) aAdds 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.carg directiveFz directive[1]r?z/argrz %s/arg[%d]N) _get_ifmodrinsertrr. enumerate)r( aug_conf_pathrqrnZ if_mod_pathZnvh_pathrZrpr*r*r+add_dir_to_ifmodssls z ApacheParser.add_dir_to_ifmodsslcCs|jjd||f}t|dkrx|jjd|d|jjd|||jjd||f}|ddt|ddS)zReturns 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 z%s/IfModule/*[self::arg='%s']rz%s/IfModule[last() + 1]z%s/IfModule[last()]/argN)rrVr.r)r(rur\Zif_modsr*r*r+rr,s  zApacheParser._get_ifmodcCs|jj|d|t|trfxTt|dD])\}}|jjd||f|q6Wn|jj|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]r?z%s/directive[last()]/arg[%d]z/directive[last()]/argN)rr isinstancelistrt)r(rurqrnrZvaluer*r*r+r3=s  zApacheParser.add_dircCs|d}|jj|dd|jj||t|trxRt|dD]'\}}|jj|d||qRWn|jj|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]rqTr?z/arg[%d]z/argN)rrsrryrzrt)r(rur4rnZ first_dirrZr{r*r*r+add_dir_beginningQs "zApacheParser.add_dir_beginningcCs|jj|d|dS)zAdds 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(rucommentr*r*r+ add_commentbszApacheParser.add_commentcCsw|st|j}|jjd|}g}x?|D]7}|jj|}|r8||kr8|j|q8W|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'])r2rrrVgetr7)r(rpstartZcommentsZresultsr}Z c_contentr*r*r+ find_commentsks  zApacheParser.find_commentsTc CsC|st|jd}dt|tdtdf}|jjd||f}|ro|j|}|dkrd}ndt|}g}x|D]} |jj| j} | d ks| d kr |j|j |||j |j | d|| |jkr|j|jj| |qW|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)r-ZIncludeOptionalz$%s//*[self::directive=~regexp('%s')]Nz/argz/*[self::arg=~regexp('%s')]includeZincludeoptional) r2rr/rrV _exclude_dirsrlowerextendr&_get_include_pathrG) r(rqrprrZregexrIZ arg_suffixZordered_matchesrVZdir_r*r*r+r&s.        !zApacheParser.find_dirc Cs|jj|}|sdS|jd}tjj|}x]|D]U}y'|j||j|dd}WqDtk rt j d|YqDXqDW|S)zUses augeas.get to get argument value and interprets result. This also converts all variables and parameters appropriately. Nz'"r r?zError Parsing variable: %srB) rrr[rarg_var_interpreterr`replacerKeyErrorrr')r(rVr{rvarr*r*r+rGs ' zApacheParser.get_argcCsjd|jfd|jfg}g}x?|D]7}x.|D]}|j||s8Pq8W|j|q+W|S)z>Exclude directives that are not loaded into the configuration.ZifmoduleZifdefine)rr _pass_filterr7)r(rIfiltersZ valid_matchesrVfilter_r*r*r+rs  zApacheParser._exclude_dirscCs|j}|j|d}x|d kr|jd|}|jj|d|d}|jdr|dd|dkrdSn||dkrdS|j|d|}q"WdS) zDetermine 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)] rr?rNz/arg!FTrB)rfindrr startswith)r(rVrZmatch_lZlast_match_idxZ end_of_ifZ expressionr*r*r+rs  zApacheParser._pass_filtercCs |jd}|jdsEtjjtjj|j|}ntjj|}tjj|r|jtjj|dn |j||j d}xJt |D]<\}}t dd|Drd|j |||?sz1ApacheParser._get_include_path..z* [label()=~regexp('%s')])r[rrrnormpathjoinrisdirrsplitrtany fnmatch_to_rer2)r(rpZ split_argidxrr*r*r+rs' zApacheParser._get_include_pathcCsAtjdkr&tj|ddStj|ddSdS) aMethod 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 http://apache2.sourcearchive.com/documentation/2.2.16-6/apr__fnmatch_8h_source.html :param str clean_fn_match: Apache style filename match, like globs :returns: regex suitable for augeas :rtype: str rxrANr )rxrAi)sys version_infofnmatch translate)r(Zclean_fn_matchr*r*r+rJszApacheParser.fnmatch_to_recCs~|j|\}}|jr+|jj|rz|jjd|}|sz|r`|j||j||jjdS)zParse 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_actionsrZensure_augeas_staterrV_remove_httpd_transform_add_httpd_transformload)r(filepathuse_new remove_oldZinc_testr*r*r+r`s       zApacheParser.parse_filecCs|j||jS)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+rX|s zApacheParser.parsed_in_currentcCs|j||jS)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 )rr$)r(rr*r*r+parsed_in_originals zApacheParser.parsed_in_originalcCsUxN|jD]@}x7||D]+}tj|tjj||rdSqWq WdS)znHelper function that searches through provided paths and returns True if file path is found in the setTF)r6rrrr)r(rpathsZ directoryfilenamer*r*r+rs ! z$ApacheParser._parsed_by_parser_pathsc Csyetjj|}|jtjj|}d|krCd}nd}|dkr^d}nd}Wntk rd}d}YnX||fS)aLDetermine actions to take with a new augeas path This helper function will return a tuple that defines if we should try to append the new filepath to augeas parser paths, and / or remove the old one with more narrow matching. :param str filepath: filepath to check the actions for rFT)rrr5rr4r)r(rZnew_file_matchZexisting_matchesrrr*r*r+rs        z ApacheParser._check_path_actionscCs|jtjj|}tjj|}xF|D]>}|d|}|jjd|}|jj|dq2W|jj|dS)z[Remove path from Augeas transform :param str filepath: filepath to remove rz!/augeas/load/Httpd/incl [. ='%s']rN)rrrr4rrVrQpop)r(rZremove_basenamesZremove_dirnamenameZ remove_pathZ remove_incr*r*r+rs   z$ApacheParser._remove_httpd_transformc Cs|jjd}|rH|jj|ddd|jjd|n&|jjdd|jjd|y0|jtjj|jtjj |Wn:t k rtjj |g|jtjj|rrrKrLr=rPr]rorvrrr3r|r~rr&rGrrrrrrXrrrrrrr!rr*r*r*r+rsL ,              L    5      rcCs#djddtj|DS)a`Returns case insensitive regex. Returns a sloppy, but necessary version of a case insensitive regex. Any string should be able to be submitted and the string is escaped and then made case insensitive. May be replaced by a more proper /i once augeas 1.0 is widely supported. :param str string: string to make case i regex rwcSs@g|]6}|jr6d|j|jdn|qS)r r )isalphaupperr)rr@r*r*r+ ,s zcase_i..)rr^escape)stringr*r*r+r/ s r/cCsd|S)zTReturn augeas path for full filepath. :param str file_path: Full filepath z/files%sr*)Z file_pathr*r*r+r20sr2)rr"rZloggingrr^rdrrEZacme.magic_typingrrrZcertbotrZ getLoggerrr0objectrr/r2r*r*r*r+s"