/
provider.py
177 lines (136 loc) · 6.06 KB
/
provider.py
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# vim: tabstop=4 shiftwidth=4 softtabstop=4
# Copyright 2012 OpenStack LLC
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""Token provider interface."""
from keystone.common import dependency
from keystone.common import logging
from keystone.common import manager
from keystone import config
from keystone import exception
CONF = config.CONF
LOG = logging.getLogger(__name__)
# supported token versions
V2 = 'v2.0'
V3 = 'v3.0'
# default token providers
PKI_PROVIDER = 'keystone.token.providers.pki.Provider'
UUID_PROVIDER = 'keystone.token.providers.uuid.Provider'
class UnsupportedTokenVersionException(Exception):
"""Token version is unrecognizable or unsupported."""
pass
@dependency.provider('token_provider_api')
class Manager(manager.Manager):
"""Default pivot point for the token provider backend.
See :mod:`keystone.common.manager.Manager` for more details on how this
dynamically calls the backend.
"""
@classmethod
def get_token_provider(cls):
"""Return package path to the configured token provider.
The value should come from ``keystone.conf`` ``[token] provider``,
however this method ensures backwards compatibility for
``keystone.conf`` ``[signing] token_format`` until Havana + 2.
Return the provider based on ``token_format`` if ``provider`` is not
set. Otherwise, ignore ``token_format`` and return the configured
``provider`` instead.
"""
if CONF.token.provider is not None:
# NOTE(gyee): we are deprecating CONF.signing.token_format. This
# code is to ensure the token provider configuration agrees with
# CONF.signing.token_format.
if ((CONF.signing.token_format == 'PKI' and
CONF.token.provider != PKI_PROVIDER or
(CONF.signing.token_format == 'UUID' and
CONF.token.provider != UUID_PROVIDER))):
raise exception.UnexpectedError(
_('keystone.conf [signing] token_format (deprecated) '
'conflicts with keystone.conf [token] provider'))
return CONF.token.provider
else:
if not CONF.signing.token_format:
# No token provider and no format, so use default (PKI)
return PKI_PROVIDER
msg = _('keystone.conf [signing] token_format is deprecated in '
'favor of keystone.conf [token] provider')
if CONF.signing.token_format == 'PKI':
LOG.warning(msg)
return PKI_PROVIDER
elif CONF.signing.token_format == 'UUID':
LOG.warning(msg)
return UUID_PROVIDER
else:
raise exception.UnexpectedError(
_('Unrecognized keystone.conf [signing] token_format: '
'expected either \'UUID\' or \'PKI\''))
def __init__(self):
super(Manager, self).__init__(self.get_token_provider())
class Provider(object):
"""Interface description for a Token provider."""
def get_token_version(self, token_data):
"""Return the version of the given token data.
If the given token data is unrecognizable,
UnsupportedTokenVersionException is raised.
"""
raise exception.NotImplemented()
def issue_token(self, version='v3.0', **kwargs):
"""Issue a V3 token.
For V3 tokens, 'user_id', 'method_names', must present in kwargs.
Optionally, kwargs may contain 'expires_at' for rescope tokens;
'project_id' for project-scoped token; 'domain_id' for
domain-scoped token; and 'auth_context' from the authentication
plugins.
For V2 tokens, 'token_ref' must be present in kwargs.
Optionally, kwargs may contain 'roles_ref' and 'catalog_ref'.
:param context: request context
:type context: dictionary
:param version: version of the token to be issued
:type version: string
:param kwargs: information needed for token creation. Parameters
may be different depending on token version.
:type kwargs: dictionary
:returns: (token_id, token_data)
"""
raise exception.NotImplemented()
def revoke_token(self, token_id):
"""Revoke a given token.
:param token_id: identity of the token
:type token_id: string
:returns: None.
"""
raise exception.NotImplemented()
def validate_token(self, token_id, belongs_to=None, version='v3.0'):
"""Validate the given token and return the token data.
Must raise Unauthorized exception if unable to validate token.
:param token_id: identity of the token
:type token_id: string
:param belongs_to: identity of the scoped project to validate
:type belongs_to: string
:param version: version of the token to be validated
:type version: string
:returns: token data
:raises: keystone.exception.Unauthorized
"""
raise exception.NotImplemented()
def check_token(self, token_id, belongs_to=None, version='v3.0'):
"""Check the validity of the given V3 token.
Must raise Unauthorized exception if unable to check token.
:param token_id: identity of the token
:type token_id: string
:param belongs_to: identity of the scoped project to validate
:type belongs_to: string
:param version: version of the token to check
:type version: string
:returns: None
:raises: keystone.exception.Unauthorized
"""