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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
# -*- coding: utf-8 -*-
#
# Copyright 2011-2012 Canonical Ltd.
# Copyright 2015-2016 Chicharreros (https://launchpad.net/~chicharreros)
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 3, as published
# by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
#
# In addition, as a special exception, the copyright holders give
# permission to link the code of portions of this program with the
# OpenSSL library under certain conditions as described in each
# individual source file, and distribute linked combinations
# including the two.
# You must obey the GNU General Public License in all respects
# for all of the code used other than OpenSSL. If you modify
# file(s) with this exception, you may extend this exception to your
# version of the file(s), but you are not obligated to do so. If you
# do not wish to do so, delete this exception statement from your
# version. If you delete this exception statement from all source
# files in the program, then also delete it here.
"""Handle keys in the local kerying."""
from __future__ import unicode_literals
import logging
import socket
import sys
try:
from urllib.parse import parse_qsl, urlencode
except ImportError:
from urllib import urlencode
from urlparse import parse_qsl
from twisted.internet.defer import inlineCallbacks, returnValue
from magicicadaclient.clientdefs import NAME
from magicicadaclient.utils import compat
from magicicadaclient.utils.txsecrets import SecretService
logger = logging.getLogger(__name__)
TOKEN_SEPARATOR = ' @ '
SEPARATOR_REPLACEMENT = ' AT '
def gethostname():
"""Get the hostname, return the name as unicode."""
sys_encoding = sys.getfilesystemencoding()
hostname = socket.gethostname()
if isinstance(hostname, compat.binary_type):
return hostname.decode(sys_encoding)
return hostname
def get_token_name(app_name):
"""Build the token name.. Return an unicode."""
computer_name = gethostname()
computer_name = computer_name.replace(TOKEN_SEPARATOR,
SEPARATOR_REPLACEMENT)
assert isinstance(computer_name, compat.text_type)
assert isinstance(computer_name, compat.text_type)
return TOKEN_SEPARATOR.join((app_name, computer_name))
class Keyring(object):
"""A Keyring for a given application name."""
def __init__(self):
"""Initialize this instance."""
self.service = SecretService()
def _get_keyring_attr(self, app_name):
"""Build the keyring attributes for this credentials."""
attr = {"key-type": "%s credentials" % NAME,
"token-name": get_token_name(app_name)}
return attr
@inlineCallbacks
def _find_keyring_item(self, app_name, attr=None):
"""Return the keyring item or None if not found."""
if attr is None:
attr = self._get_keyring_attr(app_name)
logger.debug("Finding all items for app_name %r.", app_name)
items = yield self.service.search_items(attr)
if len(items) == 0:
# if no items found, return None
logger.debug("No items found!")
returnValue(None)
logger.debug("Returning first item found.")
returnValue(items[0])
@inlineCallbacks
def set_credentials(self, app_name, cred):
"""Set the credentials."""
# Creates the secret from the credentials
secret = urlencode(cred)
attr = self._get_keyring_attr(app_name)
# Add our credentials to the keyring
yield self.service.open_session()
collection = yield self.service.get_default_collection()
yield collection.create_item(app_name, attr, secret, True)
@inlineCallbacks
def get_credentials(self, app_name):
"""A deferred with the secret in a dictionary."""
# If we have no attributes, return None
logger.debug("Getting credentials for %r.", app_name)
yield self.service.open_session()
item = yield self._find_keyring_item(app_name)
if item is not None:
logger.debug("Parsing secret.")
secret = yield item.get_value()
returnValue(dict(parse_qsl(secret)))
# nothing was found
returnValue(None)
@inlineCallbacks
def delete_credentials(self, app_name):
"""Delete a set of credentials from the keyring."""
attr = self._get_keyring_attr(app_name)
# Add our credentials to the keyring
yield self.service.open_session()
collection = yield self.service.get_default_collection()
yield collection.create_item(app_name, attr, "secret!", True)
item = yield self._find_keyring_item(app_name)
if item is not None:
yield item.delete()
|