This repository has been archived by the owner on Sep 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 94
/
authority.py
194 lines (158 loc) · 8.3 KB
/
authority.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
#------------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation.
# All rights reserved.
#
# This code is licensed under the MIT License.
#
# 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.
#
#------------------------------------------------------------------------------
try:
from urllib.parse import quote, urlparse
except ImportError:
from urllib import quote # pylint: disable=no-name-in-module
from urlparse import urlparse # pylint: disable=import-error,ungrouped-imports
import requests
from .constants import AADConstants
from .adal_error import AdalError
from . import log
from . import util
class Authority(object):
def __init__(self, authority_url, validate_authority=True):
self._log = None
self._call_context = None
self._url = urlparse(authority_url)
self._validate_authority_url()
self._validated = not validate_authority
self._host = None
self._tenant = None
self._parse_authority()
self._authorization_endpoint = None
self.token_endpoint = None
self.device_code_endpoint = None
self.is_adfs_authority = self._tenant.lower() == 'adfs'
@property
def url(self):
return self._url.geturl()
def _whitelisted(self): # testing if self._url.hostname is a dsts whitelisted domain
# Add dSTS domains to whitelist based on based on domain
# https://microsoft.sharepoint.com/teams/AzureSecurityCompliance/Security/SitePages/dSTS%20Fundamentals.aspx
return ".dsts." in self._url.hostname
def _validate_authority_url(self):
if self._url.scheme != 'https':
raise ValueError("The authority url must be an https endpoint.")
if self._url.query:
raise ValueError("The authority url must not have a query string.")
path_parts = [part for part in self._url.path.split('/') if part]
if (len(path_parts) > 1) and (not self._whitelisted()): #if dsts host, path_parts will be 2
raise ValueError(
"The path of authority_url (also known as tenant) is invalid, "
"it should either be a domain name (e.g. mycompany.onmicrosoft.com) "
"or a tenant GUID id. "
'Your tenant input was "%s" and your entire authority_url was "%s".'
% ('/'.join(path_parts), self._url.geturl()))
elif len(path_parts) == 1:
self._url = urlparse(self._url.geturl().rstrip('/'))
def _parse_authority(self):
self._host = self._url.hostname
path_parts = self._url.path.split('/')
try:
self._tenant = path_parts[1]
except IndexError:
raise ValueError("Could not determine tenant.")
def _perform_static_instance_discovery(self):
self._log.debug("Performing static instance discovery")
if self._whitelisted(): # testing if self._url.hostname is a dsts whitelisted domain
self._log.debug("Authority validated via static instance discovery")
return True
try:
AADConstants.WELL_KNOWN_AUTHORITY_HOSTS.index(self._url.hostname)
except ValueError:
return False
self._log.debug("Authority validated via static instance discovery")
return True
def _create_authority_url(self):
return "https://{}/{}{}".format(self._url.hostname,
self._tenant,
AADConstants.AUTHORIZE_ENDPOINT_PATH)
def _create_instance_discovery_endpoint_from_template(self, authority_host):
discovery_endpoint = AADConstants.INSTANCE_DISCOVERY_ENDPOINT_TEMPLATE
discovery_endpoint = discovery_endpoint.replace('{authorize_host}', authority_host)
discovery_endpoint = discovery_endpoint.replace('{authorize_endpoint}',
quote(self._create_authority_url(),
safe='~()*!.\''))
return urlparse(discovery_endpoint)
def _perform_dynamic_instance_discovery(self):
discovery_endpoint = self._create_instance_discovery_endpoint_from_template(
AADConstants.WORLD_WIDE_AUTHORITY)
get_options = util.create_request_options(self)
operation = "Instance Discovery"
self._log.debug("Attempting instance discover at: %(discovery_endpoint)s",
{"discovery_endpoint": discovery_endpoint.geturl()})
try:
resp = requests.get(discovery_endpoint.geturl(), headers=get_options['headers'],
verify=self._call_context.get('verify_ssl', None),
proxies=self._call_context.get('proxies', None))
util.log_return_correlation_id(self._log, operation, resp)
except Exception:
self._log.exception("%(operation)s request failed",
{"operation": operation})
raise
if resp.status_code == 429:
resp.raise_for_status() # Will raise requests.exceptions.HTTPError
if not util.is_http_success(resp.status_code):
return_error_string = u"{} request returned http error: {}".format(operation,
resp.status_code)
error_response = ""
if resp.text:
return_error_string = u"{} and server response: {}".format(return_error_string,
resp.text)
try:
error_response = resp.json()
except ValueError:
pass
raise AdalError(return_error_string, error_response)
else:
discovery_resp = resp.json()
if discovery_resp.get('tenant_discovery_endpoint'):
return discovery_resp['tenant_discovery_endpoint']
else:
raise AdalError('Failed to parse instance discovery response')
def _validate_via_instance_discovery(self):
valid = self._perform_static_instance_discovery()
if not valid:
self._perform_dynamic_instance_discovery()
def _get_oauth_endpoints(self):
if (not self.token_endpoint) or (not self.device_code_endpoint):
self.token_endpoint = self._url.geturl() + AADConstants.TOKEN_ENDPOINT_PATH
self.device_code_endpoint = self._url.geturl() + AADConstants.DEVICE_ENDPOINT_PATH
def validate(self, call_context):
self._log = log.Logger('Authority', call_context['log_context'])
self._call_context = call_context
if not self._validated:
self._log.debug("Performing instance discovery: %(authority)s",
{"authority": self._url.geturl()})
self._validate_via_instance_discovery()
self._validated = True
else:
self._log.debug(
"Instance discovery/validation has either already been completed or is turned off: %(authority)s",
{"authority": self._url.geturl()})
self._get_oauth_endpoints()