o c@sdZddlZddlZddlZddlZddlZddlmZddlmZddlm Z ddlm Z ddlm Z ddl Z ddl mZdd l mZdd lmZeeZd ed e efd dZded e efddZded efddZded e eeffddZdeded eeeffddZd efddZdedeed efddZde ed eeeffd d!Zd"e ed e efd#d$Zd%e ed e efd&d'Z d(e ed)ed e efd*d+Z!d(e ed efd,d-Z"d.ed efd/d0Z#dS)1z- Utility functions for certbot-apache plugin N)Dict)Iterable)List)Optional)Tuple)errors)util)osmod_namereturncCsdddgi}||gS)aGet known module dependencies. .. note:: This does not need to be accurate in order for the client to run. This simply keeps things clean if the user decides to revert changes. .. warning:: If all deps are not included, it may cause incorrect parsing behavior, due to enable_mod's shortcut for updating the parser's currently defined modules (`.ApacheParser.add_mod`) This would only present a major problem in extremely atypical configs that use ifmod for the missing deps. sslsetenvifmime)get)r depsrQ/opt/certbot/lib/python3.10/site-packages/certbot_apache/_internal/apache_util.py get_mod_depss r vhost_pathcCs|r|ds dSt|dS)zGet file path from augeas_vhost_path. Takes in Augeas path and returns the file name :param str vhost_path: Augeas virtual host path :returns: filename of vhost :rtype: str z/files/Nr) startswith_split_aug_pathrrrr get_file_path)s  rcCs t|dS)zGet the Augeas path for a vhost with the file path removed. :param str vhost_path: Augeas virtual host path :returns: Augeas path to vhost relative to the containing file :rtype: str )rrrrrget_internal_aug_path:s rcCsT|dd}g}tj|s!|d\}}}||tj|r|dt|fS)a:Splits an Augeas path into a file path and an internal path. After removing "/files", this function splits vhost_path into the file path and the remaining Augeas path. :param str vhost_path: Augeas virtual host path :returns: file path and internal Augeas path :rtype: `tuple` of `str` N/)r pathexists rpartitionappendjoinreversed)r file_path internal_path_internal_path_partrrrrFs    rfilepathvarnamecCsi}t||}t|D]>\}}|dkr0t||dkr0||dd}|d||d<qt|dkrL|drL|ddd}|d||d<q|S)z Parses Defines from a variable in configuration file :param str filepath: Path of file to parse :param str varname: Name of the variable :returns: Dict of Define:Value pairs :rtype: `dict` z-Dr=rN)rget_var_from_filesplit enumeratelen partitionr)r'r( return_varsa_optsiv var_partsrrrparse_define_file^s r5cCsttddS)z< Returns an unique id to be used as a VirtualHost identifierzutf-8)binasciihexlifyr urandomdecoderrrr unique_idwsr;pathscstfdd|DS)a* Returns true if the filepath is included in the list of paths that may contain full paths or wildcard paths that need to be expanded. :param str filepath: Filepath to check :param list paths: List of paths to check against :returns: True if included :rtype: bool c3s|] }t|VqdS)N)fnmatch).0rr'rr sz$included_in_paths..)any)r'r<rr?rincluded_in_paths|s rB define_cmdcCsri}t|d}z|dWn tyiYSw|D]}|dd}t|dkr.|dnd}|||d<q|S)z Gets Defines from httpd process and returns a dictionary of the defined variables. :param list define_cmd: httpd command to dump defines :returns: dictionary of defined variables :rtype: dict zDefine: ([^ \n]*) DUMP_RUN_CFGr*rr)r)parse_from_subprocessremove ValueErrorr,r.)rC variablesmatchesmatchpartsvaluerrr parse_definess   rNinc_cmdcC t|dS)z Gets Include directives from httpd process and returns a list of their values. :param list inc_cmd: httpd command to dump includes :returns: list of found Include directive values :rtype: list of str z \(.*\) (.*)rF)rOrrrparse_includes rRmod_cmdcCrP)z Get loaded modules from httpd process, and return the list of loaded module names. :param list mod_cmd: httpd command to dump loaded modules :returns: list of found LoadModule module names :rtype: list of str z (.*)_modulerQ)rTrrr parse_modulesrSrUcommandregexpcCst|}t||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)rVrWstdoutrrrrFs rFc Csztj|tjtjddtd}|j|j}}Wnttfy1t d|t j t d|w|jdkrBt d|t d|S) zq Get runtime configuration info. :param command: Command to run :returns: stdout from command TF)r\stderruniversal_newlinescheckenvz2Error running command %s for runtime parameters!%sz-Error accessing loaded Apache parameters: {0}rz$Error in checking parameter list: %sz^Apache is unable to check whether or not the module is loaded because Apache is misconfigured.) subprocessrunPIPErenv_no_snap_for_external_callsr\r]OSErrorrHloggererrorr lineseprMisconfigurationErrorformat returncodewarning)rVprocr\r]rrrrXs6   rXprefixc Cstdtjddd|S)z Find a TLS Apache config file in the dedicated storage. :param str prefix: prefix of the TLS Apache config file to find :return: the path the TLS Apache config file :rtype: str certbot_apache _internal tls_configsz{0}-options-ssl-apache.conf) pkg_resourcesresource_filenamer rr!rj)rnrrrfind_ssl_apache_confsrt)$__doc__r7r=loggingrYratypingrrrrrrrcertbotrrcertbot.compatr getLogger__name__rfstrrrrrr5r;boolrBrNrRrUrFrXrtrrrrs:          $