← Back
Editing: parser.cpython-38.pyc
U �]�s � @ sz d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z ddl mZ ddlmZmZmZmZmZmZ e�e�ZG dd � d e�Zd d � Zd<d d �Z dd� Z dd� Z dd� Z dd� Z dd� Z!dd� Z"dd� Z#d d � Z$d Z%e&d d e%d!d"g�Z'd#Z(d$d%e(gZ)d&d'� Z*d(d)� Z+d=d*d+�Z,d,d-� Z-d.d/� Z.d0d1� Z/d2d3� Z0d4d5� Z1d6d7� Z2d8d9� Z3d:d;� Z4dS )>z>NginxParser is a member object of the NginxConfigurator class.� N)�errors)�os)�obj)� nginxparser)�Union�Dict�Set�Any�List�Tuplec @ s� e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dd� Z dd� Z d.dd�Z dd� Zd/dd �Zd d � Zd d � Zd0d!d"�Zd1d#d$�Zd2d&d'�Zd(d)� Zd*d+� Zd3d,d-�Zd%S )4� NginxParserz�Class handles the fine details of parsing the Nginx Configuration. :ivar str root: Normalized absolute path to the server root directory. Without trailing slash. :ivar dict parsed: Mapping of file paths to parsed trees c C s* i | _ tj�|�| _| �� | _| �� d S �N)�parsedr �path�abspath�root�_find_config_root� config_root�load)�selfr � r �6/usr/lib/python3/dist-packages/certbot_nginx/parser.py�__init__ s zNginxParser.__init__c C s i | _ | �| j� dS )z/Loads Nginx files into a parsed tree. N)r �_parse_recursivelyr )r r r r r ( s zNginxParser.loadc C s� | � |�}| �|�}|D ]�}|D ]�}t|�r<| �|d � q |d dgksX|d dgkr |d D ]\}t|�r|| �|d � q`|d dgkr`|d dgkr`|d D ]}t|�r�| �|d � q�q`q qdS )a Parses nginx config files recursively by looking at 'include' directives inside 'http' and 'server' blocks. Note that this only reads Nginx files that potentially declare a virtual host. :param str filepath: The path to the files to parse, as a glob � r Zhttp�serverN)�abs_path� _parse_files�_is_include_directiver )r �filepath�trees�tree�entryZsubentryZ server_entryr r r r / s z NginxParser._parse_recursivelyc C s0 t j�|�s$t j�t j�| j|��S t j�|�S )z�Converts a relative path to an absolute path relative to the root. Does nothing for paths that are already absolute. :param str path: The path :returns: The absolute path :rtype: str )r r �isabs�normpath�joinr )r r r r r r K s zNginxParser.abs_pathc C sn | � � }i }|D ]X}|| D ]J\}}t|�}|d D ]0}|�� }||krR|j||< |jp^|| ||< q4q q|S )zSBuilds a map from address to whether it listens on ssl in any server block �addrs)�_get_raw_servers�_parse_server_raw�normalized_tuple�ssl) r �servers� addr_to_ssl�filenamer �_� parsed_server�addrZ addr_tupler r r �_build_addr_to_sslX s z NginxParser._build_addr_to_sslc sz i }| j D ]j}| j | }g ||< || � t|dd� � fdd�� t|| �D ]&\}\}}| �|�}||f|| |< qLq |S )z0Get a map of unparsed all server blocks c S s t | �dko| d dgkS )N� r r ��len)�xr r r �<lambda>u � z.NginxParser._get_raw_servers.<locals>.<lambda>c s � � | d |f�S )Nr )�append)r5 �y�Zsrvr r r6 v r7 )r �_do_for_subarray� enumerate�_get_included_directives)r r+ r- r! �ir r � new_serverr r: r r' i s � z NginxParser._get_raw_serversc C sn d}| � � }g }|D ]J}|| D ]<\}}t|�}t�||d |d ||d ||�}|�|� q q| �|� |S )a= Gets list of all 'virtual hosts' found in Nginx configuration. Technically this is a misnomer because Nginx does not have virtual hosts, it has 'server blocks'. :returns: List of :class:`~certbot_nginx.obj.VirtualHost` objects found in configuration :rtype: list Tr& r* �names)r' r( r Z VirtualHostr8 �_update_vhosts_addrs_ssl) r �enabledr+ �vhostsr- r r r/ �vhostr r r � get_vhosts~ s" � zNginxParser.get_vhostsc C s< | � � }|D ]*}|jD ] }||�� |_|jrd|_qq dS )zPUpdate a list of raw parsed vhosts to include global address sslishness TN)r1 r& r) r* )r rC r, rD r0 r r r rA � s z$NginxParser._update_vhosts_addrs_sslc C sh t �|�}|D ]T}t|�rt�| �|d ��}|D ].}z|�| j| � W q2 tk r^ Y q2X q2q|S )z�Returns array with the "include" directives expanded out by concatenating the contents of the included file to the block. :param list block: :rtype: list r )�copy�deepcopyr �globr �extendr �KeyError)r �block�result� directiveZincluded_filesZinclr r r r= � s � z$NginxParser._get_included_directivesFc C s� t � |�}g }|D ]�}|| jkr&|s&qz6t|��$}t�|�}|| j|< |�|� W 5 Q R X W q tk r| t�d|� Y q t j k r� } zt� d||� W 5 d}~X Y qX q|S )z�Parse files from a glob :param str filepath: Nginx config file path :param bool override: Whether to parse a file that has been parsed :returns: list of parsed tree structures :rtype: list zCould not open file: %s�"Could not parse file: %s due to %sN) rH r �openr r r8 �IOError�logger�warning� pyparsingZParseException�debug) r r �override�filesr �item�_filer �errr r r r � s "zNginxParser._parse_filesc C sJ dg}|D ]0}t j�t j�| j|��r t j�| j|� S q t�d��dS )z)Return the Nginx Configuration Root file.z nginx.confz9Could not find Nginx root configuration file (nginx.conf)N)r r �isfiler% r r ZNoInstallationError)r �location�namer r r r � s �z NginxParser._find_config_root�tmpTc C s� | j D ]�}| j | }|r(|tjj | }zL|r:|�� s:W qt�|�}t�d||� t |d��}|� |� W 5 Q R X W q t k r� t� d|� Y qX qdS )z�Dumps parsed configurations into files. :param str ext: The file extension to use for the dumped files. If empty, this overrides the existing conf files. :param bool lazy: Only write files that have been modified z!Writing nginx conf tree to %s: %s�wz#Could not open file for writing: %sN) r r r �extsepZis_dirtyr �dumpsrQ rT rO �writerP �error)r ZextZlazyr- r! �outrX r r r �filedump� s zNginxParser.filedumpc C s | � � }t|�}t||� |S )z�Parses a list of server directives, accounting for global address sslishness. :param list server: list of directives in a server block :rtype: dict )r1 r( �_apply_global_addr_ssl)r r r, r/ r r r � parse_server� s zNginxParser.parse_serverc C s* |j }|D ]}|sq q t|�r dS q dS )z�Does vhost have ssl on for all ports? :param :class:`~certbot_nginx.obj.VirtualHost` vhost: The vhost in question :returns: True if 'ssl on' directive is included :rtype: bool TF)�raw�_is_ssl_on_directive)r rD r rM r r r �has_ssl_on_directive s z NginxParser.has_ssl_on_directivec C s | � |t�t||�� dS )a� Add directives to the server block identified by vhost. This method modifies vhost to be fully consistent with the new directives. ..note :: It's an error to try and add a nonrepeatable directive that already exists in the config block with a conflicting value. ..todo :: Doesn't match server blocks whose server_name directives are split across multiple conf files. :param :class:`~certbot_nginx.obj.VirtualHost` vhost: The vhost whose information we use to match on :param list directives: The directives to add :param bool insert_at_top: True if the directives need to be inserted at the top of the server block instead of the bottom N)�_modify_server_directives� functools�partial�_add_directives�r rD � directives� insert_at_topr r r �add_server_directives s �z!NginxParser.add_server_directivesc C s | � |t�t||�� dS )aR Add or replace directives in the server block identified by vhost. This method modifies vhost to be fully consistent with the new directives. ..note :: When a directive with the same name already exists in the config block, the first instance will be replaced. Otherwise, the directive will be appended/prepended to the config block as in add_server_directives. ..todo :: Doesn't match server blocks whose server_name directives are split across multiple conf files. :param :class:`~certbot_nginx.obj.VirtualHost` vhost: The vhost whose information we use to match on :param list directives: The directives to add :param bool insert_at_top: True if the directives need to be inserted at the top of the server block instead of the bottom N)rj rk rl �_update_or_add_directivesrn r r r � update_or_add_server_directives- s �z+NginxParser.update_or_add_server_directivesNc C s | � |t�t||�� dS )ab Remove all directives of type directive_name. :param :class:`~certbot_nginx.obj.VirtualHost` vhost: The vhost to remove directives from :param string directive_name: The directive type to remove :param callable match_func: Function of the directive that returns true for directives to be deleted. N)rj rk rl �_remove_directives)r rD �directive_name� match_funcr r r �remove_server_directivesC s �z$NginxParser.remove_server_directivesc C s< | � |�}| �|�}|d |_|d |_|d |_||_d S )Nr& r* r@ )r= rf r& r* r@ rg )r rD Zdirectives_listr? r/ r r r �%_update_vhost_based_on_new_directivesO s z1NginxParser._update_vhost_based_on_new_directivesc C s� |j }z^| j| }|jD ] }|| }qt|t�r<t|�dkrFt�d��|d }||� | �||� W n: tjk r� } zt�d|t |�f ��W 5 d }~X Y nX d S )Nr2 zNot a server block.r zProblem in %s: %s) �filepr r � isinstance�listr4 r �MisconfigurationErrorrx �str)r rD Z block_funcr- rL �indexrY r r r rj W s z%NginxParser._modify_server_directivesc C s2 t �|�}| j|j }|jdd� D ] }|| }q$t �||jd �}|dk r�t�g �}|d D ] } | r`| d |kr`|�| � q`||d< | �||� |�|� t |�d |jd< |�r.|j D ]} d| _ d| _ q�||jd d D ]L} | r�| d dkr�t d�} | D ]*} dd � | D �} | | k�r | | �| �= �q q�|S ) ar Duplicate the vhost in the configuration files. :param :class:`~certbot_nginx.obj.VirtualHost` vhost_template: The vhost whose information we copy :param bool remove_singleton_listen_params: If we should remove parameters from listen directives in the block that can only be used once per address :param list only_directives: If it exists, only duplicate the named directives. Only looks at first level of depth; does not expand includes. :returns: A vhost object for the newly created vhost :rtype: :class:`~certbot_nginx.obj.VirtualHost` N���r r F�listen) Zdefault_server�defaultZsetfibZfastopenZbacklogZrcvbufZsndbufZ accept_filterZdeferredZbind�ipv6onlyZ reuseportZ so_keepalivec S s g | ]}|� d �d �qS )�=r )�split��.0r5 r r r � <listcomp>� s z/NginxParser.duplicate_vhost.<locals>.<listcomp>)rF rG r ry r r � UnspacedListr8 rx r4 r& r� r� �setr~ )r Zvhost_templateZ remove_singleton_listen_paramsZonly_directivesZ new_vhostZenclosing_blockr~ Z raw_in_parsedZnew_directivesrM r0 ZexcludeZparam�keysr r r �duplicate_vhostf s4 zNginxParser.duplicate_vhost)F)r] T)F)F)N)FN)�__name__� __module__� __qualname__�__doc__r r r r r1 r' rE rA r= r r rd rf ri rq rs rw rx rj r� r r r r r s. ! �r c C s� | d k r�z,t | ��}t�|�W 5 Q R � W S Q R X W nP tk rT t�d| � Y n2 tjk r� } zt�d| |� W 5 d }~X Y nX g S )Nz"Missing NGINX TLS options file: %srN ) rO r r rP rQ rR rS ZParseBaseExceptionrT )Z ssl_optionsrX rY r r r �_parse_ssl_options� s " r� c C sT |dkr g }t | t�rP|| �r*|| |� n&t| �D ] \}}t|||||g � q2dS )a( Executes a function for a subarray of a nested array if it matches the given condition. :param list entry: The list to iterate over :param function condition: Returns true iff func should be executed on item :param function func: The function to call for each matching item N)rz r{ r< r; )r" Z condition�funcr r~ rW r r r r; � s r; c C s� g }g }g }g }|D ]^}t | |�r.|�|� qt| |d�rF|�|� qt| |d�r^|�|� qt| |�r|�|� q|r�t|td�}d|fS |r�t|td�}d|fS |r�t|td�}d|fS |r�|d }d|fS d S ) ah Finds the best match for target_name out of names using the Nginx name-matching rules (exact > longest wildcard starting with * > longest wildcard ending with * > regex). :param str target_name: The name to match :param set names: The candidate server names :returns: Tuple of (type of match, the name that matched) :rtype: tuple TF)�key�exact�wildcard_start� wildcard_endr �regex)NN)� _exact_matchr8 �_wildcard_match� _regex_match�minr4 �max)� target_namer@ r� r� r� r� r\ �matchr r r �get_best_match� s4 r� c C s | |kpd| |kS )N�.r )r� r\ r r r r� � s r� c C st |dkr dS | � d�}|� d�}|s4|�� |�� |�d�}|dkrR|dkrRdS d�|�} d�|�}| �d| �S )N�*Tr� r � F)r� �reverse�popr% �endswith)r� r\ �start�partsZ match_parts�firstr r r r� � s r� c C sZ t |�dk s|d dkr dS z t�|dd � �}t�|| �W S tjk rT Y dS X d S )Nr2 r �~Fr )r4 �re�compiler� rb )r� r\ r� r r r r� s r� c C s2 t | t�o0t| �dko0| d dko0t | d tj�S )z�Checks if an nginx parsed entry is an 'include' directive. :param list entry: the parsed entry :returns: Whether it's an 'include' directive :rtype: bool r2 r �includer )rz r{ r4 �six� string_types�r" r r r r s � ��r c C s. t | t�o,t| �dko,| d dko,| d dkS )z�Checks if an nginx parsed entry is an 'ssl on' directive. :param list entry: the parsed entry :returns: Whether it's an 'ssl on' directive :rtype: bool r2 r r* r Zon)rz r{ r4 r� r r r rh s � � �rh c C s: | D ]}t |||� q|r6d|d kr6|�t�d�� dS )z"Adds directives to a config block.� r N)�_add_directiver8 r r� �ro rp rK rM r r r rm + s rm c C s: | D ]}t |||� q|r6d|d kr6|�t�d�� dS )z.Adds or replaces directives in a config block.r� r N)�_update_or_add_directiver8 r r� r� r r r rr 2 s rr r� � server_namer� ZrewriteZ add_headerz managed by Certbot� �#c C s� |d t | �k r | |d nd}t|t�rv|rvt |�dkrV|d dkrVt|d krVdS t|tj�rn|jd }n|d }| �|d tdd� � |dk r�d|kr�| �|d d� dS ) z�Add a ``#managed by Certbot`` comment to the end of the line at location. :param list block: The block containing the directive to be commented :param int location: The location within ``block`` of the directive to be commented r Nr2 ���r� r r r� ) r4 rz r{ �COMMENTr r� �spaced�insert� COMMENT_BLOCK)rK r[ Z next_entryr r r �comment_directive? s $ r� c C s� d� |�}| | }t�g �}|�|� t�|�}|d | }t�|�}d} |d jd |d d krhd} |d j�| d� |d j�d� t�|�}t�|�}|d | |< dS )z=Comment out the line at location, with a note of explanation.z duplicated in {0}z #r r z# �;N)�formatr r� r8 r` �loadsr� r� ) rK r[ Zinclude_locationZcomment_messagerM Z new_dir_blockZdumpedZ commentedZnew_dirZinsert_locationr r r �_comment_out_directiveR s r� c s t � �fdd�t| �D �d�S )zeFinds the index of the first instance of directive_name in block. If no line exists, use None.c 3 s6 | ].\}}|r|d � kr�dks*�|�r|V qdS )r Nr )r� r~ �line�ru rv r r � <genexpr>l s �z!_find_location.<locals>.<genexpr>N)�nextr< )rK ru rv r r� r �_find_locationi s �r� c C s t | �dkp| d dkS )z;Is this directive either a whitespace or comment directive?r r� r3 �rM r r r �_is_whitespace_or_commento s r� c C sJ t |tj�st�|�}t|�r,| �|� d S t| |d �}|d }dd� }d}|tkr�t|d �}|D ]`}t| |d �} |d } t|�sf|| | �sf| | |kr�t� |� || | ���qft | | |d � qf|||��r"|�r| � dt�d�� | � d|� t | d� n | �|� t | t| �d � n$| | |k�rFt� |� || | ���d S )Nr c S s | dkpt |tj�o|tkS )z, Can we append this directive to the block? N)rz r� r� �REPEATABLE_DIRECTIVES)ZlocZdir_namer r r � can_append� s �z"_add_directive.<locals>.can_appendz<tried to insert directive "{0}" but found conflicting "{1}".r r� )rz r r� r� r8 r� �INCLUDEr� r r| r� r� r� r� r4 ) rK rM rp r[ ru r� Zerr_fmtZincluded_directivesZincluded_directiveZincluded_dir_locZincluded_dir_namer r r r� s s> � � r� c C s || |< t | |� d S r )r� )rK rM r[ r r r �_update_directive� s r� c C sb t |tj�st�|�}t|�r,| �|� d S t| |d �}|d k rRt| ||� d S t| ||� d S )Nr )rz r r� r� r8 r� r� r� )rK rM rp r[ r r r r� � s r� c C s d| kot | kS )Nr� )r� r� r r r �_is_certbot_comment� s r� c C sP t || |d�}|dkrdS |d t|�k rDt||d �rD||d = ||= q dS )zYRemoves directives of name directive_name from a config block if match_func matches. )rv Nr )r� r4 r� )ru rv rK r[ r r r rt � s rt c C s. |d D ] }| |� � |_|jrd|d< qdS )zCApply global sslishness information to the parsed server block r& Tr* N)r) r* )r, r/ r0 r r r re � s re c C s� t � }d}t � }d}| D ]�}|s"q|d dkrbtj�d�|dd� ��}|r�|�|� |jr�d}q|d dkr�|�d d � |dd� D �� qt|�rd}d}q|r�|D ] }d|_q�|||d �S ) zxParses a list of server directives. :param list server: list of directives in a server block :rtype: dict Fr r� r� r NTr� c s s | ]}|� d �V qdS )z"'N)�stripr� r r r r� � s z$_parse_server_raw.<locals>.<genexpr>)r& r* r@ ) r� r ZAddrZ fromstringr% �addr* �updaterh )r r& r* r@ Zapply_ssl_to_all_addrsrM r0 r r r r( � s2 �r( )N)N)5r� rF rk rH Zloggingr� rS r� Zcertbotr Zcertbot.compatr Z certbot_nginxr r Zacme.magic_typingr r r r r r Z getLoggerr� rQ �objectr r� r; r� r� r� r� r rh rm rr r� r� r� r� r� r� r� r� r� r� r� r� r� rt re r( r r r r �<module> sT . 7
Save File
Cancel