Subversion Repositories oidplus

Rev

Rev 1305 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1265 daniel-mar 1
<?php
2
 
3
/*
4
 * OIDplus 2.0
5
 * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
6
 *
7
 * Licensed under the Apache License, Version 2.0 (the "License");
8
 * you may not use this file except in compliance with the License.
9
 * You may obtain a copy of the License at
10
 *
11
 *     http://www.apache.org/licenses/LICENSE-2.0
12
 *
13
 * Unless required by applicable law or agreed to in writing, software
14
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 * See the License for the specific language governing permissions and
17
 * limitations under the License.
18
 */
19
 
20
// ATTENTION: If you change something, please make sure that the changes
21
//            are synchronous with OIDplusPageRaRestApi
22
 
23
namespace ViaThinkSoft\OIDplus;
24
 
25
// phpcs:disable PSR1.Files.SideEffects
26
\defined('INSIDE_OIDPLUS') or die;
27
// phpcs:enable PSR1.Files.SideEffects
28
 
29
class OIDplusPageAdminRestApi extends OIDplusPagePluginAdmin {
30
 
31
        /**
32
         * @param array $params
33
         * @return array
34
         * @throws OIDplusException
35
         */
1293 daniel-mar 36
        private function action_Blacklist(array $params): array {
37
                if (!OIDplus::authUtils()->isAdminLoggedIn()) {
38
                        throw new OIDplusHtmlException(_L('You need to <a %1>log in</a> as administrator.',OIDplus::gui()->link('oidplus:login$admin')), null, 401);
39
                }
1265 daniel-mar 40
 
1293 daniel-mar 41
                if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_ADMIN', true)) {
42
                        throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_ADMIN'));
43
                }
1265 daniel-mar 44
 
1293 daniel-mar 45
                $gen = OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST;
46
                $sub = 'admin';
1265 daniel-mar 47
 
1293 daniel-mar 48
                OIDplusAuthContentStoreJWT::jwtBlacklist($gen, $sub);
1265 daniel-mar 49
 
1293 daniel-mar 50
                return array("status" => 0);
51
        }
52
 
53
        /**
54
         * @param string $actionID
55
         * @param array $params
56
         * @return array
57
         * @throws OIDplusException
58
         */
59
        public function action(string $actionID, array $params): array {
60
                if ($actionID == 'blacklistJWT') {
61
                        return $this->action_Blacklist($params);
1265 daniel-mar 62
                } else {
63
                        return parent::action($actionID, $params);
64
                }
65
        }
66
 
67
        /**
68
         * @param string $id
69
         * @param array $out
70
         * @param bool $handled
71
         * @return void
72
         * @throws OIDplusException
73
         */
74
        public function gui(string $id, array &$out, bool &$handled) {
1278 daniel-mar 75
                $parts = explode('$',$id,2);
76
                $subpage = $parts[1] ?? '';
1272 daniel-mar 77
 
1278 daniel-mar 78
                if ($parts[0] == 'oidplus:rest_api_information_admin') {
79
                        $handled = true;
1272 daniel-mar 80
 
1278 daniel-mar 81
                        if (str_starts_with($subpage, 'endpoints:')) {
82
                                // Note: This page can be accessed WITHOUT login!
83
                                $plugin = OIDplus::getPluginByOid(explode(':',$subpage)[1]);
84
                                if (!$plugin || !($plugin instanceof INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_9)) throw new OIDplusException(_L("No endpoints for this plugin found"), null, 404);
85
                                $out['title'] = _L('REST API').' - '.$plugin->getManifest()->getName() . ' ' . _L('Endpoints');
86
                                $out['icon'] = file_exists(__DIR__.'/img/endpoints_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/endpoints_icon.png' : '';
87
                                $out['text'] = '';
88
                                if (OIDplus::authUtils()->isAdminLoggedIn()) {
89
                                        $out['text'] .= '<p><a '.OIDplus::gui()->link('oidplus:rest_api_information_admin').'><img src="img/arrow_back.png" width="16" alt="'._L('Go back').'"> '._L('Go back').'</a></p>';
90
                                }
91
                                $out['text'] .= $plugin->restApiInfo('html');
92
                        } else {
93
                                $out['title'] = _L('REST API');
94
                                $out['icon'] = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : '';
1265 daniel-mar 95
 
1278 daniel-mar 96
                                if (!OIDplus::authUtils()->isAdminLoggedIn()) {
97
                                        throw new OIDplusHtmlException(_L('You need to <a %1>log in</a> as administrator.',OIDplus::gui()->link('oidplus:login$admin')), $out['title'], 401);
98
                                }
1265 daniel-mar 99
 
1278 daniel-mar 100
                                if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_ADMIN', true)) {
101
                                        throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_ADMIN'), $out['title']);
102
                                }
1265 daniel-mar 103
 
1278 daniel-mar 104
                                if (is_null(OIDplus::getPluginByOid("1.3.6.1.4.1.37476.2.5.2.4.1.2"))) { // OIDplusPagePublicRestApi
105
                                        throw new OIDplusException(_L('The administrator has disabled this feature. (Plugin %1).','OIDplusPagePublicRestApi'), $out['title']);
106
                                }
1270 daniel-mar 107
 
1278 daniel-mar 108
                                $gen = OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST;
109
                                $sub = 'admin';
1265 daniel-mar 110
 
1314 daniel-mar 111
                                $token = OIDplusAuthContentStoreJWT::craftJWT([], true, $gen);
1265 daniel-mar 112
 
1278 daniel-mar 113
                                $out['text'] .= '<p>'._L('You can make automated calls to your OIDplus account by calling an REST API.').'</p>';
114
                                $out['text'] .= '<h2>'._L('Endpoints').'</h2>';
115
                                $endpoints = '';
116
                                foreach (OIDplus::getAllPlugins() as $plugin) {
117
                                        if ($plugin instanceof INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_9) {
118
                                                $link = 'oidplus:rest_api_information_admin$endpoints:'.$plugin->getManifest()->getOid();
119
                                                $endpoints .= '<li><a '.OIDplus::gui()->link($link).'>'.htmlentities($plugin->getManifest()->getName()).'</a></li>';
120
                                        }
1265 daniel-mar 121
                                }
1278 daniel-mar 122
                                if ($endpoints) {
123
                                        $out['text'] .= '<p>'._L('The following installed plugins are offering REST endpoints:').'</p>';
124
                                        $out['text'] .= '<p><ul>'.$endpoints.'</ul></p>';
125
                                } else {
126
                                        $out['text'] .= '<p>'._L('No installed plugin offers a REST functionality').'</p>';
127
                                }
128
                                $out['text'] .= '<h2>'._L('Authentication').'</h2>';
129
                                $out['text'] .= '<p>'._L('The authentication is done via the following HTTP header:').'</p>';
130
                                $out['text'] .= '<p><pre id="oidplus_auth_jwt">';
131
                                $out['text'] .= 'Authentication: Bearer '.htmlentities($token)."\n";
132
                                $out['text'] .= '</pre></p>';
133
                                $out['text'] .= '<p><input type="button" value="'._L('Copy to clipboard').'" onClick="copyToClipboard(oidplus_auth_jwt)"></p>';
134
                                $out['text'] .= '<p>'._L('Please keep this information confidential!').'</p>';
1265 daniel-mar 135
 
1278 daniel-mar 136
                                $out['text'] .= '<h2>'._L('Blacklisted tokens').'</h2>';
137
                                $bl_time = OIDplusAuthContentStoreJWT::jwtGetBlacklistTime($gen, $sub);
138
                                if ($bl_time == 0) {
139
                                        $out['text'] .= '<p>'._L('None of the previously generated JWT tokens have been blacklisted.').'</p>';
140
                                } else {
141
                                        $out['text'] .= '<p>'._L('All tokens generated before %1 have been blacklisted.',date('d F Y, H:i:s',$bl_time+1)).'</p>';
142
                                }
143
                                $out['text'] .= '<button type="button" name="btn_blacklist_jwt" id="btn_blacklist_jwt" class="btn btn-danger btn-xs" onclick="OIDplusPageAdminRestApi.blacklistJWT()">'._L('Blacklist all previously generated tokens').'</button>';
1265 daniel-mar 144
                        }
145
                }
146
        }
147
 
148
        /**
149
         * @param array $json
150
         * @param string|null $ra_email
151
         * @param bool $nonjs
152
         * @param string $req_goto
153
         * @return bool
154
         * @throws OIDplusException
155
         */
156
        public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool {
157
                if (!OIDplus::authUtils()->isAdminLoggedIn()) return false;
158
 
159
                if (file_exists(__DIR__.'/img/main_icon16.png')) {
160
                        $tree_icon = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon16.png';
161
                } else {
162
                        $tree_icon = null; // default icon (folder)
163
                }
164
 
1272 daniel-mar 165
                if (file_exists(__DIR__.'/img/endpoints_icon16.png')) {
166
                        $tree_icon_endpoints = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/endpoints_icon16.png';
167
                } else {
168
                        $tree_icon_endpoints = null; // default icon (folder)
169
                }
170
 
171
                $submenu = array();
172
                foreach (OIDplus::getAllPlugins() as $plugin) {
173
                        if ($plugin instanceof INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_9) {
174
                                $submenu[] = [
175
                                        'id' => 'oidplus:rest_api_information_admin$endpoints:'.$plugin->getManifest()->getOid(),
176
                                        'icon' => $tree_icon_endpoints,
177
                                        'text' => $plugin->getManifest()->getName() . ' ' . _L('Endpoints')
178
                                ];
179
                        }
180
                }
181
 
1265 daniel-mar 182
                $json[] = array(
183
                        'id' => 'oidplus:rest_api_information_admin',
184
                        'icon' => $tree_icon,
1272 daniel-mar 185
                        'text' => _L('REST API'),
186
                        'children' => $submenu
1265 daniel-mar 187
                );
188
 
189
                return true;
190
        }
191
 
192
        /**
193
         * @param string $request
194
         * @return array|false
195
         */
196
        public function tree_search(string $request) {
197
                return false;
198
        }
199
}