Mercurial > hg > orthanc-authorization
annotate Plugin/Plugin.cpp @ 51:6190b564622f
todo
author | Alain Mazy <am@osimis.io> |
---|---|
date | Fri, 08 Apr 2022 16:36:52 +0200 |
parents | 914b8113fd46 |
children | 317b31e99501 |
rev | line source |
---|---|
1 | 1 /** |
2 * Advanced authorization plugin for Orthanc | |
46
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
41
diff
changeset
|
3 * Copyright (C) 2017-2021 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 "AssociativeArray.h" | |
20 #include "DefaultAuthorizationParser.h" | |
21 #include "CachedAuthorizationService.h" | |
22 #include "AuthorizationWebService.h" | |
23 #include "MemoryCache.h" | |
24 | |
34 | 25 #include "../Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h" |
26 | |
36
8ada1b669194
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
35
diff
changeset
|
27 #include <Compatibility.h> // For std::unique_ptr<> |
32 | 28 #include <Logging.h> |
29 #include <Toolbox.h> | |
1 | 30 |
31 | |
32 // Configuration of the authorization plugin | |
36
8ada1b669194
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
35
diff
changeset
|
33 static std::unique_ptr<OrthancPlugins::IAuthorizationParser> authorizationParser_; |
8ada1b669194
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
35
diff
changeset
|
34 static std::unique_ptr<OrthancPlugins::IAuthorizationService> authorizationService_; |
1 | 35 static std::set<std::string> uncheckedResources_; |
36 static std::list<std::string> uncheckedFolders_; | |
37 static std::list<OrthancPlugins::Token> tokens_; | |
38 static std::set<OrthancPlugins::AccessLevel> uncheckedLevels_; | |
39 | |
40 | |
41 static int32_t FilterHttpRequests(OrthancPluginHttpMethod method, | |
42 const char *uri, | |
43 const char *ip, | |
44 uint32_t headersCount, | |
45 const char *const *headersKeys, | |
46 const char *const *headersValues, | |
47 uint32_t getArgumentsCount, | |
48 const char *const *getArgumentsKeys, | |
49 const char *const *getArgumentsValues) | |
50 { | |
51 try | |
52 { | |
53 if (method == OrthancPluginHttpMethod_Get) | |
54 { | |
55 // Allow GET accesses to static resources | |
56 if (uncheckedResources_.find(uri) != uncheckedResources_.end()) | |
57 { | |
58 return 1; | |
59 } | |
60 | |
61 for (std::list<std::string>::const_iterator | |
62 it = uncheckedFolders_.begin(); it != uncheckedFolders_.end(); ++it) | |
63 { | |
64 if (Orthanc::Toolbox::StartsWith(uri, *it)) | |
65 { | |
66 return 1; | |
67 } | |
68 } | |
69 } | |
70 | |
71 if (authorizationParser_.get() != NULL && | |
72 authorizationService_.get() != NULL) | |
73 { | |
74 // Parse the resources that are accessed through this URI | |
75 OrthancPlugins::IAuthorizationParser::AccessedResources accesses; | |
51 | 76 if (!authorizationParser_->Parse(accesses, uri)) // TODO: include getArguments (e.g. for StoneViewer call http://localhost:8044/dicom-web/studies?0020000D=1.2.276.0.7230010.3.1.2.2831156000.1.1499097860.742568&includefield=00081030) |
1 | 77 { |
78 return 0; // Unable to parse this URI | |
79 } | |
80 | |
81 // Loop over all the accessed resources to ensure access is | |
82 // granted to each of them | |
83 for (OrthancPlugins::IAuthorizationParser::AccessedResources::const_iterator | |
84 access = accesses.begin(); access != accesses.end(); ++access) | |
85 { | |
86 // Ignored the access levels that are unchecked | |
87 // (cf. "UncheckedLevels" option) | |
88 if (uncheckedLevels_.find(access->GetLevel()) == uncheckedLevels_.end()) | |
89 { | |
90 LOG(INFO) << "Testing whether access to " | |
91 << OrthancPlugins::EnumerationToString(access->GetLevel()) | |
92 << " \"" << access->GetOrthancId() << "\" is allowed"; | |
93 | |
94 bool granted = false; | |
95 unsigned int validity; // ignored | |
96 | |
97 if (tokens_.empty()) | |
98 { | |
99 granted = authorizationService_->IsGranted(validity, method, *access); | |
100 } | |
101 else | |
102 { | |
103 OrthancPlugins::AssociativeArray headers | |
104 (headersCount, headersKeys, headersValues, false); | |
105 | |
106 OrthancPlugins::AssociativeArray getArguments | |
107 (getArgumentsCount, getArgumentsKeys, getArgumentsValues, true); | |
108 | |
109 // Loop over all the authorization tokens stored in the HTTP | |
110 // headers, until finding one that is granted | |
111 for (std::list<OrthancPlugins::Token>::const_iterator | |
112 token = tokens_.begin(); token != tokens_.end(); ++token) | |
113 { | |
114 std::string value; | |
115 | |
116 bool hasValue = false; | |
117 switch (token->GetType()) | |
118 { | |
119 case OrthancPlugins::TokenType_HttpHeader: | |
120 hasValue = headers.GetValue(value, token->GetKey()); | |
121 break; | |
122 | |
123 case OrthancPlugins::TokenType_GetArgument: | |
124 hasValue = getArguments.GetValue(value, token->GetKey()); | |
125 break; | |
126 | |
127 default: | |
128 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
129 } | |
130 | |
131 if (hasValue && | |
132 authorizationService_->IsGranted(validity, method, *access, *token, value)) | |
133 { | |
134 granted = true; | |
135 break; | |
136 } | |
137 } | |
138 } | |
139 | |
140 if (!granted) | |
141 { | |
142 return 0; | |
143 } | |
144 } | |
145 } | |
146 | |
147 // Access is granted to all the resources | |
148 return 1; | |
149 } | |
150 | |
151 // By default, forbid access to all the resources | |
152 return 0; | |
153 } | |
154 catch (std::runtime_error& e) | |
155 { | |
156 LOG(ERROR) << e.what(); | |
157 return OrthancPluginErrorCode_Success; // Ignore error | |
158 } | |
159 catch (Orthanc::OrthancException& e) | |
160 { | |
161 LOG(ERROR) << e.What(); | |
162 return OrthancPluginErrorCode_Success; // Ignore error | |
163 } | |
164 catch (...) | |
165 { | |
166 LOG(ERROR) << "Unhandled internal exception"; | |
167 return OrthancPluginErrorCode_Success; // Ignore error | |
168 } | |
169 } | |
170 | |
171 | |
172 #if !ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 2, 1) | |
173 static int32_t FilterHttpRequestsFallback(OrthancPluginHttpMethod method, | |
174 const char *uri, | |
175 const char *ip, | |
176 uint32_t headersCount, | |
177 const char *const *headersKeys, | |
178 const char *const *headersValues) | |
179 { | |
180 // Fallback wrapper function for Orthanc <= 1.2.0, where the GET | |
181 // arguments were not available in the HTTP filters | |
182 return FilterHttpRequests(method, uri, ip, | |
183 headersCount, headersKeys, headersValues, | |
184 0, NULL, NULL); | |
185 } | |
186 #endif | |
187 | |
188 | |
189 static OrthancPluginErrorCode OnChangeCallback(OrthancPluginChangeType changeType, | |
190 OrthancPluginResourceType resourceType, | |
191 const char* resourceId) | |
192 { | |
193 try | |
194 { | |
195 if (authorizationParser_.get() == NULL) | |
196 { | |
197 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
198 } | |
199 | |
200 if (changeType == OrthancPluginChangeType_Deleted) | |
201 { | |
202 switch (resourceType) | |
203 { | |
204 case OrthancPluginResourceType_Patient: | |
205 authorizationParser_->Invalidate(Orthanc::ResourceType_Patient, resourceId); | |
206 break; | |
207 | |
208 case OrthancPluginResourceType_Study: | |
209 authorizationParser_->Invalidate(Orthanc::ResourceType_Study, resourceId); | |
210 break; | |
211 | |
212 case OrthancPluginResourceType_Series: | |
213 authorizationParser_->Invalidate(Orthanc::ResourceType_Series, resourceId); | |
214 break; | |
215 | |
216 case OrthancPluginResourceType_Instance: | |
217 authorizationParser_->Invalidate(Orthanc::ResourceType_Instance, resourceId); | |
218 break; | |
219 | |
220 default: | |
221 break; | |
222 } | |
223 } | |
224 | |
225 return OrthancPluginErrorCode_Success; | |
226 } | |
227 catch (std::runtime_error& e) | |
228 { | |
229 LOG(ERROR) << e.what(); | |
230 return OrthancPluginErrorCode_Success; // Ignore error | |
231 } | |
232 catch (Orthanc::OrthancException& e) | |
233 { | |
234 LOG(ERROR) << e.What(); | |
235 return OrthancPluginErrorCode_Success; // Ignore error | |
236 } | |
237 catch (...) | |
238 { | |
239 LOG(ERROR) << "Unhandled internal exception"; | |
240 return OrthancPluginErrorCode_Success; // Ignore error | |
241 } | |
242 } | |
243 | |
244 | |
245 extern "C" | |
246 { | |
247 ORTHANC_PLUGINS_API int32_t OrthancPluginInitialize(OrthancPluginContext* context) | |
248 { | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
249 OrthancPlugins::SetGlobalContext(context); |
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
250 OrthancPluginLogWarning(context, "Initializing the authorization plugin"); |
1 | 251 |
252 /* Check the version of the Orthanc core */ | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
253 if (OrthancPluginCheckVersion(context) == 0) |
1 | 254 { |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
255 OrthancPlugins::ReportMinimalOrthancVersion(ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER, |
1 | 256 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER, |
257 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER); | |
258 return -1; | |
259 } | |
260 | |
41 | 261 #if ORTHANC_FRAMEWORK_VERSION_IS_ABOVE(1, 7, 2) |
32 | 262 Orthanc::Logging::InitializePluginContext(context); |
33
b9c536bf598b
improved Orthanc::Logging::Initialize()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
32
diff
changeset
|
263 #else |
b9c536bf598b
improved Orthanc::Logging::Initialize()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
32
diff
changeset
|
264 Orthanc::Logging::Initialize(context); |
b9c536bf598b
improved Orthanc::Logging::Initialize()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
32
diff
changeset
|
265 #endif |
b9c536bf598b
improved Orthanc::Logging::Initialize()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
32
diff
changeset
|
266 |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
267 OrthancPluginSetDescription(context, "Advanced authorization plugin for Orthanc."); |
1 | 268 |
269 try | |
270 { | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
271 OrthancPlugins::OrthancConfiguration general; |
1 | 272 |
273 static const char* SECTION = "Authorization"; | |
274 if (general.IsSection(SECTION)) | |
275 { | |
276 OrthancPlugins::OrthancConfiguration configuration; | |
277 general.GetSection(configuration, "Authorization"); | |
278 | |
279 // TODO - The size of the caches is set to 10,000 items. Maybe add a configuration option? | |
280 OrthancPlugins::MemoryCache::Factory factory(10000); | |
281 | |
282 { | |
283 std::string root; | |
284 | |
285 if (configuration.IsSection("DicomWeb")) | |
286 { | |
287 OrthancPlugins::OrthancConfiguration dicomWeb; | |
288 dicomWeb.GetSection(configuration, "DicomWeb"); | |
289 root = dicomWeb.GetStringValue("Root", ""); | |
290 } | |
291 | |
292 if (root.empty()) | |
293 { | |
294 root = "/dicom-web/"; | |
295 } | |
296 | |
297 authorizationParser_.reset | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
298 (new OrthancPlugins::DefaultAuthorizationParser(factory, root)); |
1 | 299 } |
300 | |
301 std::list<std::string> tmp; | |
302 | |
303 configuration.LookupListOfStrings(tmp, "TokenHttpHeaders", true); | |
304 for (std::list<std::string>::const_iterator | |
305 it = tmp.begin(); it != tmp.end(); ++it) | |
306 { | |
307 tokens_.push_back(OrthancPlugins::Token(OrthancPlugins::TokenType_HttpHeader, *it)); | |
308 } | |
309 | |
310 configuration.LookupListOfStrings(tmp, "TokenGetArguments", true); | |
311 | |
8
4362026afddf
orthanc 1.2.1 renamed as 1.3.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
312 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 3, 0) |
1 | 313 for (std::list<std::string>::const_iterator |
314 it = tmp.begin(); it != tmp.end(); ++it) | |
315 { | |
316 tokens_.push_back(OrthancPlugins::Token(OrthancPlugins::TokenType_GetArgument, *it)); | |
317 } | |
318 #else | |
319 if (!tmp.empty()) | |
320 { | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
321 throw Orthanc::OrthancException( |
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
322 Orthanc::ErrorCode_Plugin, |
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
323 "The option \"TokenGetArguments\" of the authorization plugin " |
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
324 "is only valid if compiled against Orthanc >= 1.3.0" |
1 | 325 } |
326 #endif | |
327 | |
328 configuration.LookupSetOfStrings(uncheckedResources_, "UncheckedResources", false); | |
329 configuration.LookupListOfStrings(uncheckedFolders_, "UncheckedFolders", false); | |
330 | |
331 std::string url; | |
332 | |
333 static const char* WEB_SERVICE = "WebService"; | |
334 if (!configuration.LookupStringValue(url, WEB_SERVICE)) | |
335 { | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
336 throw Orthanc::OrthancException( |
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
337 Orthanc::ErrorCode_BadFileFormat, |
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
338 "Missing mandatory option \"" + std::string(WEB_SERVICE) + |
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
339 "\" for the authorization plugin"); |
1 | 340 } |
341 | |
342 if (configuration.LookupListOfStrings(tmp, "UncheckedLevels", false)) | |
343 { | |
344 for (std::list<std::string>::const_iterator | |
345 it = tmp.begin(); it != tmp.end(); ++it) | |
346 { | |
347 uncheckedLevels_.insert(OrthancPlugins::StringToAccessLevel(*it)); | |
348 } | |
349 } | |
350 | |
351 authorizationService_.reset | |
352 (new OrthancPlugins::CachedAuthorizationService | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
353 (new OrthancPlugins::AuthorizationWebService(url), factory)); |
1 | 354 |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
355 OrthancPluginRegisterOnChangeCallback(context, OnChangeCallback); |
1 | 356 |
357 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 2, 1) | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
358 OrthancPluginRegisterIncomingHttpRequestFilter2(context, FilterHttpRequests); |
1 | 359 #else |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
360 OrthancPluginRegisterIncomingHttpRequestFilter(context, FilterHttpRequestsFallback); |
1 | 361 #endif |
362 } | |
363 else | |
364 { | |
365 LOG(WARNING) << "No section \"" << SECTION << "\" in the configuration file, " | |
366 << "the authorization plugin is disabled"; | |
367 } | |
368 } | |
369 catch (Orthanc::OrthancException& e) | |
370 { | |
371 LOG(ERROR) << e.What(); | |
372 return -1; | |
373 } | |
374 | |
375 return 0; | |
376 } | |
377 | |
378 | |
379 ORTHANC_PLUGINS_API void OrthancPluginFinalize() | |
380 { | |
381 authorizationParser_.reset(NULL); | |
382 } | |
383 | |
384 | |
385 ORTHANC_PLUGINS_API const char* OrthancPluginGetName() | |
386 { | |
387 return "authorization"; | |
388 } | |
389 | |
390 | |
391 ORTHANC_PLUGINS_API const char* OrthancPluginGetVersion() | |
392 { | |
22
c44013681a51
now using the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
8
diff
changeset
|
393 return ORTHANC_PLUGIN_VERSION; |
1 | 394 } |
395 } |