Mercurial > hg > orthanc-authorization
annotate Plugin/AuthorizationWebService.cpp @ 69:af44dce56328
new 'auth/user-profile' Rest API route
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Mon, 20 Feb 2023 11:56:14 +0100 |
| parents | 1a13c4fbc9a1 |
| children | 786b202ef24e |
| rev | line source |
|---|---|
| 1 | 1 /** |
| 2 * Advanced authorization plugin for Orthanc | |
| 68 | 3 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
| 1 | 4 * |
| 5 * This program is free software: you can redistribute it and/or | |
| 6 * modify it under the terms of the GNU Affero General Public License | |
| 7 * as published by the Free Software Foundation, either version 3 of | |
| 8 * the License, or (at your option) any later version. | |
| 9 * | |
| 10 * This program is distributed in the hope that it will be useful, but | |
| 11 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 * Affero General Public License for more details. | |
| 14 * | |
| 15 * You should have received a copy of the GNU Affero General Public License | |
| 16 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 17 **/ | |
| 18 | |
| 19 #include "AuthorizationWebService.h" | |
| 20 | |
| 34 | 21 #include "../Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h" |
| 22 | |
| 32 | 23 #include <Logging.h> |
|
59
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
24 #include <Toolbox.h> |
|
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
25 #include <HttpClient.h> |
| 1 | 26 |
| 27 namespace OrthancPlugins | |
| 28 { | |
| 29 bool AuthorizationWebService::IsGrantedInternal(unsigned int& validity, | |
| 30 OrthancPluginHttpMethod method, | |
| 31 const AccessedResource& access, | |
| 32 const Token* token, | |
| 33 const std::string& tokenValue) | |
| 34 { | |
| 35 Json::Value body = Json::objectValue; | |
| 36 | |
| 37 switch (method) | |
| 38 { | |
| 39 case OrthancPluginHttpMethod_Get: | |
| 40 body["method"] ="get"; | |
| 41 break; | |
| 42 | |
| 43 case OrthancPluginHttpMethod_Post: | |
| 44 body["method"] ="post"; | |
| 45 break; | |
| 46 | |
| 47 case OrthancPluginHttpMethod_Put: | |
| 48 body["method"] ="put"; | |
| 49 break; | |
| 50 | |
| 51 case OrthancPluginHttpMethod_Delete: | |
| 52 body["method"] ="delete"; | |
| 53 break; | |
| 54 | |
| 55 default: | |
| 56 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 57 } | |
| 58 | |
| 59 body["level"] = EnumerationToString(access.GetLevel()); | |
| 60 | |
| 61 if (access.GetLevel() == AccessLevel_System) | |
| 62 { | |
| 63 body["uri"] = access.GetOrthancId(); | |
| 64 } | |
| 65 else | |
| 66 { | |
| 67 body["orthanc-id"] = access.GetOrthancId(); | |
| 68 body["dicom-uid"] = access.GetDicomUid(); | |
| 69 } | |
| 70 | |
| 71 if (token != NULL) | |
| 72 { | |
| 73 body["token-key"] = token->GetKey(); | |
| 74 body["token-value"] = tokenValue; | |
| 75 } | |
| 76 | |
|
54
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
77 if (!identifier_.empty()) |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
78 { |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
79 body["identifier"] = identifier_; |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
80 } |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
81 else |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
82 { |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
83 body["identifier"] = Json::nullValue; |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
84 } |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
85 |
|
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
86 MemoryBuffer answerBody; |
|
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
87 MemoryBuffer answerHeaders; |
| 1 | 88 uint16_t httpStatus = 0; |
| 89 | |
| 90 uint32_t headersCount = 0; | |
| 10 | 91 const char* headersKeys[2]; |
| 92 const char* headersValues[2]; | |
| 1 | 93 |
| 94 if (token != NULL && | |
| 95 token->GetType() == TokenType_HttpHeader) | |
| 96 { | |
| 97 // If the token source is a HTTP header, forward it also as a | |
|
59
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
98 // HTTP header except if it is the Authorization header that might conflict with username_ and password_ |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
99 std::string lowerTokenKey; |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
100 Orthanc::Toolbox::ToLowerCase(lowerTokenKey, token->GetKey()); |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
101 |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
102 if (!(lowerTokenKey == "authorization" && !username_.empty())) |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
103 { |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
104 headersKeys[headersCount] = token->GetKey().c_str(); |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
105 headersValues[headersCount] = tokenValue.c_str(); |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
106 headersCount++; |
|
a5f2976fe8a0
fix Authorization header conflicting with WebServiceUsername
Alain Mazy <am@osimis.io>
parents:
54
diff
changeset
|
107 } |
| 1 | 108 } |
| 109 | |
| 10 | 110 // set the correct content type for the outgoing |
| 111 headersKeys[headersCount] = "Content-Type"; | |
| 112 headersValues[headersCount] = "application/json"; | |
| 113 headersCount++; | |
| 114 | |
| 67 | 115 // set the correct content type for the outgoing |
| 116 headersKeys[headersCount] = "Expect"; | |
| 117 headersValues[headersCount] = ""; | |
| 118 headersCount++; | |
| 119 | |
| 1 | 120 std::string flatBody = body.toStyledString(); |
| 121 | |
|
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
122 if (OrthancPluginHttpClient(GetGlobalContext(), *answerBody, *answerHeaders, |
| 1 | 123 &httpStatus, OrthancPluginHttpMethod_Post, |
| 124 url_.c_str(), headersCount, headersKeys, headersValues, | |
| 125 flatBody.c_str(), flatBody.size(), | |
| 126 username_.empty() ? NULL : username_.c_str(), | |
| 127 password_.empty() ? NULL : password_.c_str(), | |
| 128 10 /* timeout */, NULL, NULL, NULL, 0) | |
| 129 != OrthancPluginErrorCode_Success) | |
| 130 { | |
| 131 throw Orthanc::OrthancException(Orthanc::ErrorCode_NetworkProtocol); | |
| 132 } | |
| 133 | |
| 134 Json::Value answer; | |
| 135 answerBody.ToJson(answer); | |
| 136 | |
| 137 static const char* GRANTED = "granted"; | |
| 138 static const char* VALIDITY = "validity"; | |
| 139 | |
| 140 if (answer.type() != Json::objectValue || | |
| 141 !answer.isMember(GRANTED) || | |
| 142 answer[GRANTED].type() != Json::booleanValue || | |
| 143 (answer.isMember(VALIDITY) && | |
| 144 answer[VALIDITY].type() != Json::intValue)) | |
| 145 { | |
|
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
146 throw Orthanc::OrthancException(Orthanc::ErrorCode_NetworkProtocol, |
|
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
147 "Syntax error in the result of the Web service"); |
| 1 | 148 } |
| 149 | |
| 150 validity = 0; | |
| 151 if (answer.isMember(VALIDITY)) | |
| 152 { | |
| 153 int tmp = answer[VALIDITY].asInt(); | |
| 154 if (tmp < 0) | |
| 155 { | |
|
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
156 throw Orthanc::OrthancException(Orthanc::ErrorCode_NetworkProtocol, |
|
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
157 "A validity duration cannot be negative"); |
| 1 | 158 } |
| 159 | |
| 160 validity = static_cast<unsigned int>(tmp); | |
| 161 } | |
| 162 | |
| 163 return answer[GRANTED].asBool(); | |
| 164 } | |
| 165 | |
| 166 | |
| 167 void AuthorizationWebService::SetCredentials(const std::string& username, | |
| 168 const std::string& password) | |
| 169 { | |
| 170 username_ = username; | |
| 171 password_ = password; | |
| 172 } | |
|
54
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
173 |
|
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
174 void AuthorizationWebService::SetUserProfileUrl(const std::string& url) |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
175 { |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
176 userProfileUrl_ = url; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
177 } |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
178 |
|
54
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
179 void AuthorizationWebService::SetIdentifier(const std::string& webServiceIdentifier) |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
180 { |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
181 identifier_ = webServiceIdentifier; |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
182 } |
|
317b31e99501
Added 3 new configurations: WebServiceUsername, WebServicePassword, WebServiceIdentifier. WebServiceIdentifier is now included in the payload as the 'identifier' field
Alain Mazy <am@osimis.io>
parents:
46
diff
changeset
|
183 |
|
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
184 bool AuthorizationWebService::GetUserProfile(Json::Value& profile /* out */, |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
185 const Token& token, |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
186 const std::string& tokenValue) |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
187 { |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
188 if (userProfileUrl_.empty()) |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
189 { |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
190 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadRequest, "Can not get user profile if the 'WebServiceUserProfileUrl' is not configured"); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
191 } |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
192 |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
193 Orthanc::WebServiceParameters authWebservice; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
194 authWebservice.SetUrl(userProfileUrl_); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
195 |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
196 if (!username_.empty()) |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
197 { |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
198 authWebservice.SetCredentials(username_, password_); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
199 } |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
200 |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
201 Json::Value body; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
202 |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
203 body["token-key"] = token.GetKey(); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
204 body["token-value"] = tokenValue; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
205 |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
206 if (!identifier_.empty()) |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
207 { |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
208 body["identifier"] = identifier_; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
209 } |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
210 else |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
211 { |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
212 body["identifier"] = Json::nullValue; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
213 } |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
214 |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
215 std::string bodyAsString; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
216 Orthanc::Toolbox::WriteFastJson(bodyAsString, body); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
217 |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
218 try |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
219 { |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
220 Orthanc::HttpClient authClient(authWebservice, ""); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
221 authClient.AssignBody(bodyAsString); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
222 authClient.SetMethod(Orthanc::HttpMethod_Post); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
223 authClient.AddHeader("Content-Type", "application/json"); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
224 authClient.AddHeader("Expect", ""); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
225 |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
226 authClient.ApplyAndThrowException(profile); |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
227 return true; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
228 } |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
229 catch (Orthanc::OrthancException& ex) |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
230 { |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
231 return false; |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
232 } |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
233 } |
|
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
234 |
| 1 | 235 } |