Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/authorization.rst @ 96:750f7ab733c1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
start documentation of authorization
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 22 Mar 2017 16:45:42 +0100
parents
children 20b9ecb43eed
comparison
equal deleted inserted replaced
95:065350232191 96:750f7ab733c1
1 .. _authorization:
2
3
4 Advanced authorization plugin
5 =============================
6
7 .. contents::
8
9 This **official plugin by Osimis** extends Orthanc with advanced
10 authorization mechanism.
11
12 For each incoming REST request to some URI, the plugin will query a
13 Web service to know whether the access is granted to the
14 user. Authorization credentials can be retrieved either from a GET
15 argument, or from a HTTP header.
16
17 Compilation
18 -----------
19
20 .. highlight:: bash
21
22 The procedure to compile these plugins is similar of that for the
23 :ref:`core of Orthanc <binaries>`. The following commands should work
24 for every UNIX-like distribution (including GNU/Linux)::
25
26 $ mkdir Build
27 $ cd Build
28 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
29 $ make
30
31 The compilation will produce a shared library ``OrthancAuthorization``
32 that contains the authorization plugin.
33
34 Usage
35 -----
36
37 .. highlight:: json
38
39 You of course first have to :ref:`install Orthanc <compiling>`. Once
40 Orthanc is installed, you must change the :ref:`configuration file
41 <configuration>` to tell Orthanc where it can find the plugin: This is
42 done by properly modifying the ``Plugins`` option. You could for
43 instance use the following configuration file::
44
45 {
46 "Name" : "MyOrthanc",
47 [...]
48 "Plugins" : [
49 "/home/user/OrthancAuthorization/Build/libOrthancAuthorization.so"
50 ]
51 }
52
53 .. highlight:: text
54
55 Orthanc must of course be restarted after the modification of its
56 configuration file.
57
58 Configuration
59 -------------
60
61 WIP
62