File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/proxy/__pycache__/panos.cpython-310.pyc
o
�N�g�< � @ s� d Z ddlZddlm mZ ddlZddlm m
Z dgZ ddiZ
i Ze�e�ZdZdd� Zdd � Zd
d � Zdd d
�Zd dd�Zdd� Zdd� Zdd� Zdd� Zdd� Z dS ) a
Proxy Minion interface module for managing Palo Alto firewall devices
=====================================================================
.. versionadded:: 2018.3.0
:codeauthor: ``Spencer Ervin <spencer_ervin@hotmail.com>``
:maturity: new
:depends: none
:platform: unix
This proxy minion enables Palo Alto firewalls (hereafter referred to
as simply 'panos') to be treated individually like a Salt Minion.
The panos proxy leverages the XML API functionality on the Palo Alto
firewall. The Salt proxy must have access to the Palo Alto firewall on
HTTPS (tcp/443).
More in-depth conceptual reading on Proxy Minions can be found in the
:ref:`Proxy Minion <proxy-minion>` section of Salt's
documentation.
Configuration
=============
To use this integration proxy module, please configure the following:
Pillar
------
Proxy minions get their configuration from Salt's Pillar. Every proxy must
have a stanza in Pillar and a reference in the Pillar top-file that matches
the ID. There are four connection options available for the panos proxy module.
- Direct Device (Password)
- Direct Device (API Key)
- Panorama Pass-Through (Password)
- Panorama Pass-Through (API Key)
Direct Device (Password)
------------------------
The direct device configuration configures the proxy to connect directly to
the device with username and password.
.. code-block:: yaml
proxy:
proxytype: panos
host: <ip or dns name of panos host>
username: <panos username>
password: <panos password>
verify_ssl: True
proxytype
^^^^^^^^^
The ``proxytype`` key and value pair is critical, as it tells Salt which
interface to load from the ``proxy`` directory in Salt's install hierarchy,
or from ``/srv/salt/_proxy`` on the Salt Master (if you have created your
own proxy module, for example). To use this panos Proxy Module, set this to
``panos``.
host
^^^^
The location, or ip/dns, of the panos host. Required.
username
^^^^^^^^
The username used to login to the panos host. Required.
password
^^^^^^^^
The password used to login to the panos host. Required.
Direct Device (API Key)
------------------------
Palo Alto devices allow for access to the XML API with a generated 'API key'_
instead of username and password.
.. _API key: https://www.paloaltonetworks.com/documentation/71/pan-os/xml-api/get-started-with-the-pan-os-xml-api/get-your-api-key
.. code-block:: yaml
proxy:
proxytype: panos
host: <ip or dns name of panos host>
apikey: <panos generated api key>
proxytype
^^^^^^^^^
The ``proxytype`` key and value pair is critical, as it tells Salt which
interface to load from the ``proxy`` directory in Salt's install hierarchy,
or from ``/srv/salt/_proxy`` on the Salt Master (if you have created your
own proxy module, for example). To use this panos Proxy Module, set this to
``panos``.
host
^^^^
The location, or ip/dns, of the panos host. Required.
apikey
^^^^^^
The generated XML API key for the panos host. Required.
Panorama Pass-Through (Password)
--------------------------------
The Panorama pass-through method sends all connections through the Panorama
management system. It passes the connections to the appropriate device using
the serial number of the Palo Alto firewall.
This option will reduce the number of connections that must be present for the
proxy server. It will only require a connection to the Panorama server.
The username and password will be for authentication to the Panorama server,
not the panos device.
.. code-block:: yaml
proxy:
proxytype: panos
serial: <serial number of panos host>
host: <ip or dns name of the panorama server>
username: <panorama server username>
password: <panorama server password>
proxytype
^^^^^^^^^
The ``proxytype`` key and value pair is critical, as it tells Salt which
interface to load from the ``proxy`` directory in Salt's install hierarchy,
or from ``/srv/salt/_proxy`` on the Salt Master (if you have created your
own proxy module, for example). To use this panos Proxy Module, set this to
``panos``.
serial
^^^^^^
The serial number of the panos host. Required.
host
^^^^
The location, or ip/dns, of the Panorama server. Required.
username
^^^^^^^^
The username used to login to the Panorama server. Required.
password
^^^^^^^^
The password used to login to the Panorama server. Required.
Panorama Pass-Through (API Key)
-------------------------------
The Panorama server can also utilize a generated 'API key'_ for authentication.
.. _API key: https://www.paloaltonetworks.com/documentation/71/pan-os/xml-api/get-started-with-the-pan-os-xml-api/get-your-api-key
.. code-block:: yaml
proxy:
proxytype: panos
serial: <serial number of panos host>
host: <ip or dns name of the panorama server>
apikey: <panos generated api key>
proxytype
^^^^^^^^^
The ``proxytype`` key and value pair is critical, as it tells Salt which
interface to load from the ``proxy`` directory in Salt's install hierarchy,
or from ``/srv/salt/_proxy`` on the Salt Master (if you have created your
own proxy module, for example). To use this panos Proxy Module, set this to
``panos``.
serial
^^^^^^
The serial number of the panos host. Required.
host
^^^^
The location, or ip/dns, of the Panorama server. Required.
apikey
^^^^^^^^
The generated XML API key for the Panorama server. Required.
� NZpanos�vendorz Palo Altoc C s t S )z7
Only return if all the modules are available.
)�__virtualname__� r r �D/opt/saltstack/salt/lib/python3.10/site-packages/salt/proxy/panos.py� __virtual__� s r c C sD | j �dd�}|r| j �dd� | j �dd� | D ]}t|�}q| S )z�
Removes dirtyID tags from the candidate config result. Palo Alto devices will make the candidate configuration with
a dirty ID after a change. This can cause unexpected results when parsing.
ZdirtyIdNZadmin�time)Zattrib�pop� _strip_dirty)ZxmltreeZdirty�childr r r r � s
r c C s� d| d vr
t �d� dS d| d vr-d| d vr t �d� dS d| d vr-t �d � dS d
�| d d �td < | d d td< | d �d d
�td < d| d v r�| d �d�td< d| d v rrt �d� dtd< | d �d�td< nPt �d� dtd< | d �d�td< | d �d�td< n4d| d v r�t �d� dtd< | d �d�td< nt �d� dtd< | d �d�td< | d �d�td< t �d� ddd�}t|� t �d � d
td < d S ) z�
This function gets called when the proxy starts up. For
panos devices, a determination is made on the connection type
and the appropriate connection details that must be cached.
�host�proxyz-No 'host' key found in pillar for this proxy.F�apikey�usernamez1No 'username' key found in pillar for this proxy.�passwordz2No 'passwords' key found in pillar for this proxy.zhttps://{}/api/�url�
verify_sslT�serialz/Selected pan_key method for panos proxy module.�pan_key�methodz0Selected pan_pass method for panos proxy module.�pan_passz/Selected dev_key method for panos proxy module.�dev_keyz0Selected dev_pass method for panos proxy module.�dev_passz*Attempting to connect to panos proxy host.�op�+<show><system><info></info></system></show>��type�cmdz+Successfully connected to panos proxy host.� initializedN)�log�critical�format�DETAILS�get�debug�call)�opts�queryr r r �init� sH
r' c C s. d}z�t d dkr'dt d i}| �|� td t d | dd d
t d d
d
d �}not d d
krFtd t d t d t d | dd d
t d d
d
d�
}nPt d dkrmt d t d d�}| �|� td t d | dd d
t d d
d
d �}n)t d dkr�dt d i}| �|� td t d t d t d | dd d
t d d
d
d�
}W n ty� } ztj�d��d}~ww |s�tj�d��t|d �dvr�t|d �dkr�tj�d��t|d �dkr�tj�d ��t|d �d kr�tj�d ��t|d �d kr�tj�d ��tj�d��t� |d! �}| d" d#k�r| d$ d%k�rt
|�}t � |d
�S )&zW
This function captures the query string and sends it to the Palo Alto device.
Nr r �keyr
z
http.queryr �POST�plainTr )�datar � decode_type�decoder �status� raise_errorr r r ) r r r+ r r, r- r r. r/ r r )r( �targetr r0 z+Did not receive a valid response from host.r. )Z200Z201Z204Z400z<The server cannot process the request due to a client error.Z401zpThe server cannot process the request because it lacks valid authentication credentials for the target resource.Z403z,The server refused to authorize the request.Z404z*The requested resource could not be found.�textr Zconfig�actionr" )
r! �updateZ __utils__�KeyError�salt�
exceptionsZCommandExecutionError�str�ETZ
fromstringr �xmlZto_dict)�payload�rZconditional_payload�errZxmldatar r r r$ / s�
�
� �
�
�� ��������� r$ �0.0.0c
C s dt d v r
t d d }ndS | �d�}|�d�}z]t|d �t|d �kr)W dS t|d �t|d �k r8W dS t|d �t|d �krGW dS t|d �t|d �k rVW dS t|d �t|d �kreW dS t|d �t|d �k rtW dS W dS ty� } zW Y d }~dS d }~ww )
z�
Because different versions of Palo Alto support different command sets, this function
will return true if the current version of Palo Alto supports the required command.
z
sw-version� grains_cacheF�.r T� � N)r! �split�int� Exception)Zrequired_versionZcurrent_versionZrequired_version_splitZcurrent_version_splitr< r r r �is_required_version� s.
��rE c C s t �dd�S )z�
Since grains are loaded in many different places and some of those
places occur before the proxy can be initialized, return whether
our init() function has been called
r F)r! r" r r r r r � s r c
C sp t �di �s4tt d< zddd�} t| �d d t d< W t d S ty3 } z W Y d}~t d S d}~ww t d S )z0
Get the grains from the proxied device
r> r r r �result�systemN)r! r" � GRAINS_CACHEr$ rD �r& r< r r r �grains� s
�
��rJ c C s dt d< t� S )z4
Refresh the grains from the proxied device
Nr> )r! rJ r r r r �grains_refresh� s rK c
C sJ zddd�} dt | �v rW dS W dS ty$ } zW Y d}~dS d}~ww )z>
Returns true if the device is reachable, else false.
r r r rF TFN)r$ rD rI r r r �ping� s
��rL c C s t �d� dS )z_
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no-op.
z Panos proxy shutdown() called.N)r r# r r r r �shutdown� s rM )N)r= ) �__doc__�loggingZxml.etree.ElementTreeZetreeZ ElementTreer8 Zsalt.exceptionsr5 Zsalt.utils.xmlutil�utilsZxmlutilr9 Z__proxyenabled__rH r! � getLogger�__file__r r r r r' r$ rE r rJ rK rL rM r r r r �<module> s* N
6
m$