summaryrefslogtreecommitdiff
path: root/src/leap/bitmask/util/keyring_helpers.py
blob: 088e7b3d2f4f82ec90f6604715793185462ca33a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# -*- coding: utf-8 -*-
# keyring_helpers.py
# Copyright (C) 2013 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""
Keyring helpers.
"""
import logging

try:
    import keyring
    from keyring.backends.file import EncryptedKeyring, PlaintextKeyring
    OBSOLETE_KEYRINGS = [
        EncryptedKeyring,
        PlaintextKeyring
    ]
    canuse = lambda kr: (kr is not None
                         and kr.__class__ not in OBSOLETE_KEYRINGS)

except Exception:
    # Problems when importing keyring! It might be a problem binding to the
    # dbus socket, or stuff like that.
    keyring = None


logger = logging.getLogger(__name__)


def _get_keyring_with_fallback():
    """
    Get the default keyring, and if obsolete try to pick SecretService keyring
    if available.

    This is a workaround for the cases in which the keyring module chooses
    an insecure keyring by default (ie, inside a virtualenv).
    """
    if keyring is None:
        return None
    kr = keyring.get_keyring()
    if not canuse(kr):
        try:
            kr_klass = keyring.backends.SecretService
            kr = kr_klass.Keyring()
        except AttributeError:
            logger.warning("Keyring cannot find SecretService Backend")
    logger.debug("Selected keyring: %s" % (kr.__class__,))
    if not canuse(kr):
        logger.debug("Not using default keyring since it is obsolete")
    return kr


def has_keyring():
    """
    Return whether we have an useful keyring to use.

    :rtype: bool
    """
    if keyring is None:
        return False
    kr = _get_keyring_with_fallback()
    return canuse(kr)


def get_keyring():
    """
    Return an usable keyring.

    :rtype: keyringBackend or None
    """
    if keyring is None:
        return False
    kr = _get_keyring_with_fallback()
    return kr if canuse(kr) else None