Function obfuscate

salt/modules/pillar.py:379–430

.. versionadded:: 2015.8.0 Same as :py:func:`items`, but replace pillar values with a simple type indication. This is useful to avoid displaying sensitive information on console or flooding the console with long output, such as certificates. For many debug or control purposes,

(
    *args,
    pillar=None,
    pillar_enc=None,
    pillarenv=None,
    saltenv=None,
    unmask=None,
)

def obfuscate(
    *args,
    pillar=None,
    pillar_enc=None,
    pillarenv=None,
    saltenv=None,
    unmask=None,
):
    """
    .. versionadded:: 2015.8.0

    Same as :py:func:`items`, but replace pillar values with a simple type indication.

    This is useful to avoid displaying sensitive information on console or
    flooding the console with long output, such as certificates.
    For many debug or control purposes, the stakes lie more in dispatching than in
    actual values.

    In case the value is itself a collection type, obfuscation occurs within the value.
    For mapping types, keys are not obfuscated.
    Here are some examples:

    * ``'secret password'`` becomes ``'<str>'``
    * ``['secret', 1]`` becomes ``['<str>', '<int>']``
    * ``{'login': 'somelogin', 'pwd': 'secret'}`` becomes
      ``{'login': '<str>', 'pwd': '<str>'}``

    unmask
        Forwarded to :py:func:`items` when sourcing the pillar data. The
        returned structure is then obfuscated, so the practical effect of
        this flag is limited; it is accepted for API consistency with the
        other ``pillar`` functions.

        .. versionadded:: 3008.2

    CLI Examples:

    .. code-block:: bash

        salt '*' pillar.obfuscate

    """
    return _obfuscate_inner(
        items(
            *args,
            pillar=pillar,
            pillar_enc=pillar_enc,
            pillarenv=pillarenv,
            saltenv=saltenv,
            unmask=unmask,
        )
    )


# naming chosen for consistency with grains.ls, although it breaks the short