-
Notifications
You must be signed in to change notification settings - Fork 63
/
Copy pathauthentication.py
306 lines (240 loc) · 10.6 KB
/
authentication.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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# --------------------------------------------------------------------------
from typing import Optional, Dict
import requests
from requests.auth import HTTPBasicAuth
import requests_oauthlib as oauth
class Authentication(object):
"""Default, simple auth object.
Doesn't actually add any auth headers.
"""
header = "Authorization"
def signed_session(self, session=None):
# type: (Optional[requests.Session]) -> requests.Session
"""Create requests session with any required auth headers applied.
If a session object is provided, configure it directly. Otherwise,
create a new session and return it.
:param session: The session to configure for authentication
:type session: requests.Session
:rtype: requests.Session
"""
return session or requests.Session()
class BasicAuthentication(Authentication):
"""Implementation of Basic Authentication.
:param str username: Authentication username.
:param str password: Authentication password.
"""
def __init__(self, username, password):
# type: (str, str) -> None
self.scheme = 'Basic'
self.username = username
self.password = password
def signed_session(self, session=None):
# type: (Optional[requests.Session]) -> requests.Session
"""Create requests session with any required auth headers
applied.
If a session object is provided, configure it directly. Otherwise,
create a new session and return it.
:param session: The session to configure for authentication
:type session: requests.Session
:rtype: requests.Session
"""
session = super(BasicAuthentication, self).signed_session(session)
session.auth = HTTPBasicAuth(self.username, self.password)
return session
class BasicTokenAuthentication(Authentication):
"""Simple Token Authentication.
Does not adhere to OAuth, simply adds provided token as a header.
:param dict[str,str] token: Authentication token, must have 'access_token' key.
"""
def __init__(self, token):
# type: (Dict[str, str]) -> None
self.scheme = 'Bearer'
self.token = token
def set_token(self):
# type: () -> None
"""Should be used to define the self.token attribute.
In this implementation, does nothing since the token is statically provided
at creation.
"""
pass
def signed_session(self, session=None):
# type: (Optional[requests.Session]) -> requests.Session
"""Create requests session with any required auth headers
applied.
If a session object is provided, configure it directly. Otherwise,
create a new session and return it.
:param session: The session to configure for authentication
:type session: requests.Session
:rtype: requests.Session
"""
session = super(BasicTokenAuthentication, self).signed_session(session)
header = "{} {}".format(self.scheme, self.token['access_token'])
session.headers['Authorization'] = header
return session
class OAuthTokenAuthentication(BasicTokenAuthentication):
"""OAuth Token Authentication.
Requires that supplied token contains an expires_in field.
:param str client_id: Account Client ID.
:param dict[str,str] token: OAuth2 token.
"""
def __init__(self, client_id, token):
# type: (str, Dict[str, str]) -> None
super(OAuthTokenAuthentication, self).__init__(token)
self.id = client_id
self.store_key = self.id
def construct_auth(self):
# type: () -> str
"""Format token header.
:rtype: str
"""
return "{} {}".format(self.scheme, self.token)
def refresh_session(self, session=None):
# type: (Optional[requests.Session]) -> requests.Session
"""Return updated session if token has expired, attempts to
refresh using refresh token.
If a session object is provided, configure it directly. Otherwise,
create a new session and return it.
:param session: The session to configure for authentication
:type session: requests.Session
:rtype: requests.Session
"""
return self.signed_session(session)
def signed_session(self, session=None):
# type: (Optional[requests.Session]) -> requests.Session
"""Create requests session with any required auth headers applied.
If a session object is provided, configure it directly. Otherwise,
create a new session and return it.
:param session: The session to configure for authentication
:type session: requests.Session
:rtype: requests.Session
"""
session = session or requests.Session() # Don't call super on purpose, let's "auth" manage the headers.
session.auth = oauth.OAuth2(self.id, token=self.token)
return session
class KerberosAuthentication(Authentication):
"""Kerberos Authentication
Kerberos Single Sign On (SSO); requires requests_kerberos is installed.
:param mutual_authentication: whether to require mutual authentication. Use values from requests_kerberos import REQUIRED, OPTIONAL, or DISABLED
"""
def __init__(self, mutual_authentication=None):
super(KerberosAuthentication, self).__init__()
self.mutual_authentication = mutual_authentication
def signed_session(self, session=None):
"""Create requests session with Negotiate (SPNEGO) headers applied.
If a session object is provided, configure it directly. Otherwise,
create a new session and return it.
:param session: The session to configure for authentication
:type session: requests.Session
:rtype: requests.Session
"""
session = super(KerberosAuthentication, self).signed_session(session)
try:
from requests_kerberos import HTTPKerberosAuth
except ImportError:
raise ImportError("In order to use KerberosAuthentication please do 'pip install requests_kerberos' first")
if self.mutual_authentication:
session.auth = HTTPKerberosAuth(mutual_authentication=self.mutual_authentication)
else:
session.auth = HTTPKerberosAuth()
return session
class ApiKeyCredentials(Authentication):
"""Represent the ApiKey feature of Swagger.
Dict should be dict[str,str] to be accepted by requests.
:param dict[str,str] in_headers: Headers part of the ApiKey
:param dict[str,str] in_query: ApiKey in the query as parameters
"""
def __init__(self, in_headers=None, in_query=None):
# type: (Optional[Dict[str, str]], Optional[Dict[str, str]]) -> None
super(ApiKeyCredentials, self).__init__()
if in_headers is None:
in_headers = {}
if in_query is None:
in_query = {}
if not in_headers and not in_query:
raise ValueError("You need to define in_headers or in_query")
self.in_headers = in_headers
self.in_query = in_query
def signed_session(self, session=None):
# type: (Optional[requests.Session]) -> requests.Session
"""Create requests session with ApiKey.
If a session object is provided, configure it directly. Otherwise,
create a new session and return it.
:param session: The session to configure for authentication
:type session: requests.Session
:rtype: requests.Session
"""
session = super(ApiKeyCredentials, self).signed_session(session)
session.headers.update(self.in_headers)
try:
# params is actually Union[bytes, MutableMapping[Text, Text]]
session.params.update(self.in_query) # type: ignore
except AttributeError: # requests.params can be bytes
raise ValueError("session.params must be a dict to be used in ApiKeyCredentials")
return session
class CognitiveServicesCredentials(ApiKeyCredentials):
"""Cognitive Services authentication.
:param str subscription_key: The CS subscription key
"""
_subscription_key_header = 'Ocp-Apim-Subscription-Key'
def __init__(self, subscription_key):
# type: (str) -> None
if not subscription_key:
raise ValueError("Subscription key cannot be None")
super(CognitiveServicesCredentials, self).__init__(
in_headers={
self._subscription_key_header: subscription_key,
'X-BingApis-SDK-Client': 'Python-SDK'
}
)
class TopicCredentials(ApiKeyCredentials):
"""Event Grid authentication.
:param str topic_key: The Event Grid topic key
"""
_topic_key_header = 'aeg-sas-key'
def __init__(self, topic_key):
# type: (str) -> None
if not topic_key:
raise ValueError("Topic key cannot be None")
super(TopicCredentials, self).__init__(
in_headers={
self._topic_key_header: topic_key,
}
)
class DomainCredentials(ApiKeyCredentials):
"""Event Grid domain authentication.
:param str domain_key: The Event Grid domain key
"""
_domain_key_header = 'aeg-sas-key'
def __init__(self, domain_key):
# type: (str) -> None
if not domain_key:
raise ValueError("Domain key cannot be None")
super(DomainCredentials, self).__init__(
in_headers={
self._domain_key_header: domain_key,
}
)