Gecko [ goons4good.org ]

Name	Size	Permission	Date
__pycache__	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
__init__.py	48.88 KB	-rw-r--r--	2022-05-16 09:16
azureblob.py	13.88 KB	-rw-r--r--	2022-05-16 09:16
cmd_json.py	787 B	-rw-r--r--	2022-05-16 09:16
cmd_yaml.py	893 B	-rw-r--r--	2022-05-16 09:16
cmd_yamlex.py	674 B	-rw-r--r--	2022-05-16 09:16
cobbler.py	1.64 KB	-rw-r--r--	2022-05-16 09:16
confidant.py	3.29 KB	-rw-r--r--	2022-05-16 09:16
consul_pillar.py	11.61 KB	-rw-r--r--	2022-05-16 09:16
csvpillar.py	1.85 KB	-rw-r--r--	2022-05-16 09:16
digicert.py	1007 B	-rw-r--r--	2022-05-16 09:16
django_orm.py	7.74 KB	-rw-r--r--	2022-05-16 09:16
ec2_pillar.py	10.12 KB	-rw-r--r--	2022-05-16 09:16
etcd_pillar.py	2.36 KB	-rw-r--r--	2022-05-16 09:16
extra_minion_data_in_pillar.py	2.18 KB	-rw-r--r--	2022-05-16 09:16
file_tree.py	18.03 KB	-rw-r--r--	2022-05-16 09:16
foreman.py	3.66 KB	-rw-r--r--	2022-05-16 09:16
git_pillar.py	19.61 KB	-rw-r--r--	2022-05-16 09:16
gpg.py	560 B	-rw-r--r--	2022-05-16 09:16
hg_pillar.py	3.19 KB	-rw-r--r--	2022-05-16 09:16
hiera.py	846 B	-rw-r--r--	2022-05-16 09:16
http_json.py	2.43 KB	-rw-r--r--	2022-05-16 09:16
http_yaml.py	2.43 KB	-rw-r--r--	2022-05-16 09:16
libvirt.py	5.78 KB	-rw-r--r--	2022-05-16 09:16
makostack.py	21.99 KB	-rw-r--r--	2022-05-16 09:16
mongo.py	5.6 KB	-rw-r--r--	2022-05-16 09:16
mysql.py	3.76 KB	-rw-r--r--	2022-05-16 09:16
nacl.py	744 B	-rw-r--r--	2022-05-16 09:16
netbox.py	29.5 KB	-rw-r--r--	2022-05-16 09:16
neutron.py	2.41 KB	-rw-r--r--	2022-05-16 09:16
nodegroups.py	1.7 KB	-rw-r--r--	2022-05-16 09:16
pepa.py	20.98 KB	-rw-r--r--	2022-05-16 09:16
pillar_ldap.py	10.95 KB	-rw-r--r--	2022-05-16 09:16
postgres.py	2.82 KB	-rw-r--r--	2022-05-16 09:16
puppet.py	846 B	-rw-r--r--	2022-05-16 09:16
reclass_adapter.py	4 KB	-rw-r--r--	2022-05-16 09:16
redismod.py	3.28 KB	-rw-r--r--	2022-05-16 09:16
rethinkdb_pillar.py	4.71 KB	-rw-r--r--	2022-05-16 09:16
s3.py	14.4 KB	-rw-r--r--	2022-05-16 09:16
saltclass.py	1.49 KB	-rw-r--r--	2022-05-16 09:16
sql_base.py	15.38 KB	-rw-r--r--	2022-05-16 09:16
sqlcipher.py	3.42 KB	-rw-r--r--	2022-05-16 09:16
sqlite3.py	2.67 KB	-rw-r--r--	2022-05-16 09:16
stack.py	22.07 KB	-rw-r--r--	2022-05-16 09:16
svn_pillar.py	5.74 KB	-rw-r--r--	2022-05-16 09:16
varstack_pillar.py	1.1 KB	-rw-r--r--	2022-05-16 09:16
vault.py	4.03 KB	-rw-r--r--	2022-05-16 09:16
venafi.py	966 B	-rw-r--r--	2022-05-16 09:16
virtkey.py	586 B	-rw-r--r--	2022-05-16 09:16
vmware_pillar.py	16.83 KB	-rw-r--r--	2022-05-16 09:16

Rename

"""
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]
"""

import logging
from contextlib import contextmanager

from salt.pillar.sql_base import SqlBaseExtPillar

# Set up logging
log = logging.getLogger(__name__)

try:
    from pysqlcipher import dbapi2 as sqlcipher

HAS_SQLCIPHER = True
except ImportError:
    HAS_SQLCIPHER = False

def __virtual__():
    if not HAS_SQLCIPHER:
        return False
    return True

class SQLCipherExtPillar(SqlBaseExtPillar):
    """
    This class receives and processes the database rows from SQLCipher.
    """

@classmethod
    def _db_name(cls):
        return "SQLCipher"

def _get_options(self):
        """
        Returns options used for the SQLCipher connection.
        """
        defaults = {
            "database": "/var/lib/salt/pillar-sqlcipher.db",
            "pass": "strong_pass_phrase",
            "timeout": 5.0,
        }
        _options = {}
        _opts = __opts__.get("sqlcipher", {})

for attr in defaults:
            if attr not in _opts:
                log.debug("Using default for SQLCipher pillar %s", attr)
                _options[attr] = defaults[attr]
                continue
            _options[attr] = _opts[attr]
        return _options

@contextmanager
    def _get_cursor(self):
        """
        Yield a SQLCipher cursor
        """
        _options = self._get_options()
        conn = sqlcipher.connect(
            _options.get("database"), timeout=float(_options.get("timeout"))
        )
        conn.execute('pragma key="{}"'.format(_options.get("pass")))
        cursor = conn.cursor()
        try:
            yield cursor
        except sqlcipher.Error as err:
            log.exception("Error in ext_pillar SQLCipher: %s", err.args)
        finally:
            conn.close()

def ext_pillar(minion_id, pillar, *args, **kwargs):
    """
    Execute queries against SQLCipher, merge and return as a dict
    """
    return SQLCipherExtPillar().fetch(minion_id, pillar, *args, **kwargs)