|
238
|
1 .. _security:
|
|
|
2
|
|
|
3 Securing Orthanc
|
|
|
4 ================
|
|
|
5
|
|
|
6 .. contents::
|
|
|
7
|
|
|
8 Orthanc is a microservice for medical imaging. Out-of-the-box, it
|
|
|
9 makes the assumption that it runs on the localhost, within a secured
|
|
|
10 environment. As a consequence, care must be taken if deploying Orthanc
|
|
|
11 in a insecure environment, especially if it is run as a public-facing
|
|
|
12 service on Internet. This page provides instructions to secure Orthanc
|
|
|
13 through its :ref:`configuration options <configuration>`.
|
|
|
14
|
|
|
15
|
|
|
16 General configuration
|
|
|
17 ---------------------
|
|
|
18
|
|
|
19 As for any service running on a computer, you should:
|
|
|
20
|
|
|
21 * Make sure to run the Orthanc service as a separate user. In
|
|
|
22 particular, never run Orthanc as the ``root`` user on GNU/Linux, or
|
|
|
23 as the ``Administrator`` user on Microsoft Windows.
|
|
|
24
|
|
|
25 * Contact your network administrators to setup `Intranet firewalls
|
|
|
26 <https://en.wikipedia.org/wiki/Firewall_(computing)>`__, so that
|
|
|
27 only trusted computers can contact Orthanc through its REST API
|
|
|
28 or through the DICOM protocol.
|
|
|
29
|
|
|
30 Care must also be taken about some configuration options specific to
|
|
|
31 Orthanc:
|
|
|
32
|
|
|
33 * ``LimitFindResults`` and ``LimitFindInstances`` should not be set to
|
|
|
34 zero to avoid making Orthanc unresponsive on large databases by a
|
|
|
35 malicious user that would make many lookups within Orthanc. A value
|
|
|
36 of ``100`` should be a good compromise.
|
|
|
37
|
|
|
38 * ``HttpsVerifyPeers`` should be set to ``true`` to secure outgoing
|
|
|
39 connections to remote HTTPS servers (such as when Orthanc is acting
|
|
|
40 as a :ref:`DICOMweb client <dicomweb-client>`).
|
|
|
41
|
|
|
42 * Make sure to understand the implications of the
|
|
|
43 ``OverwriteInstances`` option.
|
|
|
44
|
|
|
45 * You might also be interested in checking the options related to
|
|
|
46 :ref:`performance optimization <scalability>`.
|
|
|
47
|
|
|
48
|
|
|
49
|
|
|
50 Securing the HTTP server
|
|
|
51 ------------------------
|
|
|
52
|
|
|
53 .. highlight:: lua
|
|
|
54
|
|
|
55 Orthanc publishes a :ref:`REST API <rest>` that provides full
|
|
|
56 programmatic access to its content, in read/write. This means for
|
|
|
57 instance that a malicious user could delete the entire content of the
|
|
|
58 server, or could inspect confidential medical data.
|
|
|
59
|
|
|
60 By default, the HTTP server is restricted to the localhost to prevent
|
|
|
61 such attacks from the outside world. However, as soon as external
|
|
|
62 access is granted by setting the ``RemoteAccessAllowed`` configuration
|
|
|
63 option to ``true``, you should:
|
|
|
64
|
|
|
65 * Set ``AuthenticationEnabled`` to ``true`` to force the users to
|
|
|
66 authenticate. The authorized users are listed in the option
|
|
|
67 ``RegisteredUsers``.
|
|
|
68
|
|
|
69 * Enable :ref:`HTTPS encryption <https>` to prevent the stealing of
|
|
|
70 medical data or passwords, even on the Intranet.
|
|
|
71
|
|
|
72 * If Orthanc is put on a server that can be contacted from Internet,
|
|
|
73 put Orthanc behind a :ref:`reverse proxy <https>`, and let this
|
|
|
74 reverse proxy take care of the HTTPS encryption.
|
|
|
75
|
|
|
76 * Setup rules that define, for each authorized user, which resources
|
|
|
77 it can access, and through which HTTP method (GET, POST, DELETE
|
|
|
78 and/or PUT). This can be done by defining a :ref:`filter written in
|
|
|
79 Lua <lua-filter-rest>`. Here is a sample Lua filter that
|
|
|
80 differentiates between an administrator user (``admin``) who has
|
|
|
81 full access on the localhost only, and a generic user (``user``)
|
|
|
82 that has only read-only access::
|
|
|
83
|
|
|
84 function IncomingHttpRequestFilter(method, uri, ip, username, httpHeaders)
|
|
|
85 if method == 'GET' and (username == 'user' or username == 'admin') then
|
|
|
86 -- Read-only access (only GET method is allowed)
|
|
|
87 return true
|
|
|
88 elseif username == 'admin' and ip == '127.0.0.1' then
|
|
|
89 -- Read-write access for administrator (any HTTP method is allowed on localhost)
|
|
|
90 return true
|
|
|
91 else
|
|
|
92 -- Access is disallowed by default
|
|
|
93 return false
|
|
|
94 end
|
|
|
95 end
|
|
|
96
|
|
|
97 Very importantly, make sure to protect ``POST`` access to the
|
|
|
98 ``/tools/execute-script`` URI. This URI can indeed be used by a
|
|
|
99 malicious user to execute any system command on the computer as the
|
|
|
100 user that runs Orthanc.
|
|
|
101
|
|
|
102 * Consider implementing a :ref:`higher-level application
|
|
289
|
103 <improving-interface>` (e.g. in PHP, Java, Django...) that takes
|
|
|
104 care of user authentication/authorization, and that is the only one
|
|
|
105 to be allowed to contact the Orthanc REST API. In particular, you
|
|
|
106 must create a higher-level application so as to properly deal with
|
|
|
107 `CSRF attacks
|
|
|
108 <https://en.wikipedia.org/wiki/Cross-site_request_forgery>`__:
|
|
|
109 Indeed, as explained in the introduction, Orthanc is a microservice
|
|
|
110 that is designed to be used within a secured environment.
|
|
238
|
111
|
|
|
112 * For advanced scenarios, you might have interest in the
|
|
|
113 :ref:`advanced authorization plugin <authorization>`. Similarly,
|
|
|
114 developers of :ref:`plugins <plugins>` could be interested by the
|
|
|
115 ``OrthancPluginRegisterIncomingHttpRequestFilter2()`` function
|
|
|
116 provided by the Orthanc plugin SDK.
|
|
|
117
|
|
|
118
|
|
|
119 **Remark:** These parameters also apply to the :ref:`DICOMweb server plugin <dicomweb>`.
|
|
|
120
|
|
|
121
|
|
|
122 Securing the DICOM server
|
|
|
123 -------------------------
|
|
|
124
|
|
|
125 .. highlight:: json
|
|
|
126
|
|
|
127 Besides its REST API that is served through its embedded HTTP/HTTPS
|
|
|
128 server, Orthanc also acts as a :ref:`DICOM server <dicom-protocol>`
|
|
|
129 (more precisely, as a DICOM SCP).
|
|
|
130
|
|
248
|
131 In general, the DICOM protocol should be disabled if running Orthanc
|
|
|
132 on a cloud server, except if you use a VPN (cf. `reference
|
|
|
133 <https://groups.google.com/d/msg/orthanc-users/yvHexxG3dTY/7s3A7EHVBAAJ>`__).
|
|
|
134 Favor HTTPS for transfering medical images across sites (see
|
|
|
135 above). You can turn off DICOM protocol by setting the configuration
|
|
|
136 option ``DicomServerEnabled`` to ``false``.
|
|
|
137
|
|
238
|
138 The DICOM modalities that are known to Orthanc are defined by setting
|
|
|
139 the ``DicomModalities`` configuration option. Out-of-the-box, Orthanc
|
|
|
140 accepts C-ECHO and C-STORE commands sent by unknown modalities, but
|
|
|
141 blocks C-FIND and C-MOVE commands issued by unknown modalities.
|
|
|
142
|
|
|
143 To fully secure the DICOM protocol, you should:
|
|
|
144
|
|
|
145 * Set the ``DicomAlwaysAllowEcho`` configuration option to ``false``
|
|
|
146 to disallow C-ECHO commands from unknown modalities.
|
|
|
147
|
|
|
148 * Set the ``DicomAlwaysAllowStore`` configuration option to ``false``
|
|
|
149 to disallow C-STORE commands from unknown modalities.
|
|
|
150
|
|
|
151 * Set the ``DicomCheckModalityHost`` configuration option to ``true``
|
|
|
152 to validate the IP and hostname address of the remote modalities.
|
|
|
153
|
|
|
154 * For each modality that is defined in ``DicomModalities``,
|
|
|
155 selectively specify what DICOM commands are allowed to be issued by
|
|
|
156 the SCU of this modality by setting the suboptions ``AllowEcho``,
|
|
|
157 ``AllowFind``, ``AllowMove`` and ``AllowStore``. For instance, a
|
|
|
158 modality could be allowed to C-STORE images, but be disallowed to
|
|
|
159 C-FIND the content of Orthanc. Here is a sample configuration to
|
|
|
160 define a single modality that is only allowed to send DICOM
|
|
|
161 instances to Orthanc::
|
|
|
162
|
|
|
163 {
|
|
|
164 "DicomModalities" : {
|
|
|
165 "untrusted" : {
|
|
|
166 "AET" : "CT",
|
|
|
167 "Port" : 104,
|
|
|
168 "Host" : "192.168.0.10",
|
|
|
169 "AllowEcho" : false,
|
|
|
170 "AllowFind" : false,
|
|
|
171 "AllowMove" : false,
|
|
|
172 "AllowStore" : true
|
|
|
173 }
|
|
|
174 }
|
|
|
175 }
|
|
|
176
|
|
|
177 **Note:** These configuration suboptions only affect the behavior of
|
|
|
178 the DICOM SCP of Orthanc (i.e. for incoming connections). Orthanc
|
|
|
179 will always be able to make outgoing DICOM SCU connections to these
|
|
|
180 modalities, independently of the value of these suboptions.
|
|
|
181
|
|
|
182 * Consider implementing a :ref:`filter implemented in Lua
|
|
|
183 <lua-filter-rest>` to restrict which modalities can C-STORE images
|
|
|
184 within Orthanc, and which kind of images are accepted by Orthanc.
|
|
|
185
|
|
|
186 * Consider setting ``DicomCheckCalledAet`` to ``true`` to force proper
|
|
|
187 configuration of remote modalities.
|
|
|
188
|
|
|
189
|
|
253
|
190 **Remark:** As of Orthanc 1.5.7, `DICOM TLS encryption
|
|
238
|
191 <https://www.dicomstandard.org/using/security/>`__ is not supported
|
|
|
192 yet. We are looking for :ref:`an industrial sponsor <contributing>` to
|
|
248
|
193 get this feature implemented, as it is useful in enterprise and cloud
|
|
|
194 environments.
|
