o

�N�g�
�@s~dZd
dl
Z
d
dlmZ
d
dlmZ
e
�e�
Zz
d
dl	m
Z
dZWne
y,


dZYn
wdd	�ZGd
d�de�Zdd
�ZdS)a
Retrieve Pillar data by running a SQLCipher query

.. versionadded:: 2016.3.0

Python SQLCipher support is provided by the pysqlcipher
Python package. You need this module installed to query
Pillar data from a SQLCipher database.

This module is a concrete implementation of the sql_base
ext_pillar for SQLCipher.

:maturity: new
:depends: pysqlcipher (for py2) or pysqlcipher3 (for py3)
:platform: all

Configuring the sqlcipher ext_pillar
====================================

Use the 'sqlcipher' key under ext_pillar for configuration of queries.

SQLCipher database connection configuration requires the following values
configured in the master config:

   * ``sqlcipher.database`` - The SQLCipher database to connect to.
     Defaults to ``'/var/lib/salt/pillar-sqlcipher.db'``.
   * ``sqlcipher.pass`` - The SQLCipher database decryption password.
   * ``sqlcipher.timeout`` - The connection timeout in seconds.

Example configuration

.. code-block:: yaml

    sqlcipher:
      database: /var/lib/salt/pillar-sqlcipher.db
      pass: strong_pass_phrase
      timeout: 5.0

Complete Example
================

.. code-block:: yaml

    sqlcipher:
      database: '/var/lib/salt/pillar-sqlcipher.db'
      pass: strong_pass_phrase
      timeout: 5.0

    ext_pillar:
      - sqlcipher:
          fromdb:
            query: 'SELECT col1,col2,col3,col4,col5,col6,col7
                      FROM some_random_table
                     WHERE minion_pattern LIKE ?'
            depth: 5
            as_list: True
            with_lists: [1,3]
�N)
�contextmanager)
�SqlBaseExtPillar)
�dbapi2TFc
Cstsd
SdS)NFT)
�
HAS_SQLCIPHER�rr�I/opt/saltstack/salt/lib/python3.10/site-packages/salt/pillar/sqlcipher.py�__virtual__Ls


rc@s0eZ
dZd
Zedd��
Zdd�Zedd��
ZdS)	�SQLCipherExtPillarzM
    This class receives and processes the database rows from SQLCipher.
    c


Csd
S)NZ	SQLCipherr)
�clsrrr�_db_nameWszSQLCipherExtPillar._db_namec
CsXd
ddd�}
i}t�
di�}|
D]}||v
r#t�d|�
|
|||<q||||<q|S)zD
        Returns options used for the SQLCipher connection.
        z!/var/lib/salt/pillar-sqlcipher.dbZstrong_pass_phraseg@)�database�pass�timeout�	sqlcipherz%Using default for SQLCipher pillar %s)Z__opts__�get�log�debug)�self�defaults�_optionsZ_opts�attrrrr�_get_options[s

�






zSQLCipherExtPillar._get_optionsc

cs��|��}
t
j|
�d
�
t|
�d�
�
d�}|�d�|
�d�
�
�

|��}z.z|V
Wnt
jyC
}
z
t	�
d|j�
WYd}~nd}~w
wW|��
dSW|��
dS|��
w)z*
        Yield a SQLCipher cursor
        rr)
rzpragma key="{}"r
z!Error in ext_pillar SQLCipher: %sN)
rr�connectr�floatZexecute�format�cursor�Errorr�	exception�args�close)rr�connr�errrrr�_get_cursoros"�

�





����zSQLCipherExtPillar._get_cursorN)	�__name__�
__module__�__qualname__�__doc__�classmethodrrrr"rrrrr	Rs



r	cOst�j
||
g|�
Ri|�
�
S)
zG
    Execute queries against SQLCipher, merge and return as a dict
    )r	Zfetch)Z	minion_idZpillarr�kwargsrrr�
ext_pillar�sr))r&�logging�
contextlibrZsalt.pillar.sql_baser�	getLoggerr#rZpysqlcipherrrr�ImportErrorrr	r)rrrr�<module>
s;




�0