Module Expr Str ImportFrom alias Import alias TryExcept body Import alias Assign NameStore NameLoad handlers ExceptHandler type NameLoad body Assign NameStore NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Dict Str Str Assign NameStore Str FunctionDef arguments args defaults body Expr Str If NameLoad body Return NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If BoolOpAnd Call NameLoad NameLoad NameLoad CompareIn Str NameLoad body Return SubscriptLoad NameLoad Index Str Return NameLoad decorator_list
N/A N/A 
Keyring Database Module

:maintainer:    SaltStack
:maturity:      New
:depends:       keyring
:platform:      all

This module allows access to the keyring package using an ``sdb://`` URI. This
package is located at ``https://pypi.python.org/pypi/keyring``.

Care must be taken when using keyring. Not all keyend backends are supported on
all operating systems. Also, many backends require an agent to be running in
order to work. For instance, the "Secret Service" backend requires a compatible
agent such as ``gnome-keyring-daemon`` or ``kwallet`` to be running. The
keyczar backend does not seem to enjoy the benefits of an agent, and so using
it will require either that the password is typed in manually (which is
unreasonable for the salt-minion and salt-master daemons, especially in
production) or an agent is written for it.

Like all sdb modules, the keyring module requires a configuration profile to
be configured in either the minion or master configuration file. This profile
requires very little. In the example:

.. code-block:: yaml

    mykeyring:
      driver: keyring
      service: system

The ``driver`` refers to the keyring module, ``service`` refers to the service
that will be used inside of keyring (which may be likened unto a database
table) and ``mykeyring`` refers to the name that will appear in the URI:

.. code-block:: yaml

    password: sdb://mykeyring/mypassword

The underlying backend configuration must be configured via keyring itself. For
examples and documentation, see keyring:

https://pypi.python.org/pypi/keyring

.. versionadded:: 2014.1.4
 __future__ absolute_import N/A logging N/A N/A N/A keyring N/A HAS_LIBS True N/A N/A N/A ImportError N/A N/A HAS_LIBS False N/A log N/A N/A logging getLogger __name__ N/A __func_alias__ N/A set_ set N/A __virtualname__ keyring __virtual__ N/A N/A N/A N/A N/A 
    Only load the module if keyring is installed
     N/A HAS_LIBS N/A N/A __virtualname__ N/A False N/A set_ N/A N/A key value service profile N/A None None N/A N/A 
    Set a key/value pair in a keyring service
     N/A service N/A _get_service service profile N/A N/A N/A keyring set_password service key value N/A get N/A N/A key service profile N/A None None N/A N/A 
    Get a value from a keyring service
     N/A service N/A _get_service service profile N/A N/A N/A keyring get_password service key N/A _get_service N/A N/A service profile N/A N/A N/A 
    Get a service name
     N/A N/A N/A isinstance profile dict N/A service profile N/A N/A N/A profile N/A service N/A service N/A