annotate Core/Pkcs11.h @ 3844:c9c34bb50f0a

fix paths
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 16 Apr 2020 17:27:18 +0200
parents 94f4a18a79cc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2025
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
2025
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
2145
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
36 #if !defined(ORTHANC_SANDBOXED)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
37 # error The macro ORTHANC_SANDBOXED must be defined
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
38 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
39
2137
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
40 #if !defined(ORTHANC_ENABLE_PKCS11)
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
41 # error The macro ORTHANC_ENABLE_PKCS11 must be defined
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
42 #endif
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
43
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
44 #if !defined(ORTHANC_ENABLE_SSL)
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
45 # error The macro ORTHANC_ENABLE_SSL must be defined
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
46 #endif
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
47
2145
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
48 #if ORTHANC_SANDBOXED == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
49 # error This file cannot be used in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
50 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
51
2136
dd609a99d39a uniformization of the macro naming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2025
diff changeset
52 #if ORTHANC_ENABLE_PKCS11 != 1 || ORTHANC_ENABLE_SSL != 1
2025
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 # error This file cannot be used if OpenSSL or PKCS#11 support is disabled
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 #endif
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 #include <string>
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 namespace Orthanc
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 {
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 namespace Pkcs11
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 const char* GetEngineIdentifier();
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 bool IsInitialized();
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 void Initialize(const std::string& module,
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 const std::string& pin,
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 bool verbose);
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 void Finalize();
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 }
e7e1858d9504 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 }