Rev 1273 | Rev 1293 | Go to most recent revision | 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 OIDplusPageAdminRestApi |
||
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 OIDplusPageRaRestApi extends OIDplusPagePluginRa { |
||
30 | |||
31 | /** |
||
32 | * @param string $actionID |
||
33 | * @param array $params |
||
34 | * @return array |
||
35 | * @throws OIDplusException |
||
36 | */ |
||
37 | public function action(string $actionID, array $params): array { |
||
38 | if ($actionID == 'blacklistJWT') { |
||
39 | if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_USER', true)) { |
||
40 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_USER')); |
||
41 | } |
||
42 | |||
43 | _CheckParamExists($params, 'user'); |
||
44 | $ra_email = $params['user']; |
||
45 | |||
46 | if (!OIDplus::authUtils()->isRaLoggedIn($ra_email) && !OIDplus::authUtils()->isAdminLoggedIn()) { |
||
1266 | daniel-mar | 47 | throw new OIDplusHtmlException(_L('You need to <a %1>log in</a> as the requested RA %2 or as admin.',OIDplus::gui()->link('oidplus:login$ra$'.$ra_email),'<b>'.htmlentities($ra_email).'</b>'), null, 401); |
1265 | daniel-mar | 48 | } |
49 | |||
50 | $gen = OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST; |
||
51 | $sub = $ra_email; |
||
52 | |||
53 | OIDplusAuthContentStoreJWT::jwtBlacklist($gen, $sub); |
||
54 | |||
55 | return array("status" => 0); |
||
56 | } else { |
||
57 | return parent::action($actionID, $params); |
||
58 | } |
||
59 | } |
||
60 | |||
61 | /** |
||
62 | * @param string $id |
||
63 | * @param array $out |
||
64 | * @param bool $handled |
||
65 | * @return void |
||
66 | * @throws OIDplusException |
||
67 | */ |
||
68 | public function gui(string $id, array &$out, bool &$handled) { |
||
1278 | daniel-mar | 69 | $parts = explode('$',$id,3); |
70 | $ra_email = $parts[1] ?? ''; |
||
71 | $subpage = $parts[2] ?? ''; |
||
1265 | daniel-mar | 72 | |
1278 | daniel-mar | 73 | if (empty($ra_email)) return; |
1272 | daniel-mar | 74 | |
1278 | daniel-mar | 75 | if ($parts[0] == 'oidplus:rest_api_information_ra') { |
76 | $handled = true; |
||
1265 | daniel-mar | 77 | |
1278 | daniel-mar | 78 | if (str_starts_with($subpage, 'endpoints:')) { |
79 | // Note: This page can be accessed WITHOUT login! |
||
80 | $plugin = OIDplus::getPluginByOid(explode(':',$subpage)[1]); |
||
81 | 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); |
||
82 | $out['title'] = _L('REST API').' - '.$plugin->getManifest()->getName() . ' ' . _L('Endpoints'); |
||
83 | $out['icon'] = file_exists(__DIR__.'/img/endpoints_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/endpoints_icon.png' : ''; |
||
84 | $out['text'] = ''; |
||
85 | if (!OIDplus::authUtils()->isRaLoggedIn($ra_email) && !OIDplus::authUtils()->isAdminLoggedIn()) { |
||
86 | $out['text'] .= '<p><a '.OIDplus::gui()->link('oidplus:rest_api_information_ra').'><img src="img/arrow_back.png" width="16" alt="'._L('Go back').'"> '._L('Go back').'</a></p>'; |
||
87 | } |
||
88 | $out['text'] .= $plugin->restApiInfo('html'); |
||
89 | } else { |
||
90 | $out['title'] = _L('REST API'); |
||
91 | $out['icon'] = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : ''; |
||
1265 | daniel-mar | 92 | |
1278 | daniel-mar | 93 | if (!OIDplus::authUtils()->isRaLoggedIn($ra_email) && !OIDplus::authUtils()->isAdminLoggedIn()) { |
94 | throw new OIDplusHtmlException(_L('You need to <a %1>log in</a> as the requested RA %2 or as admin.',OIDplus::gui()->link('oidplus:login$ra$'.$ra_email),'<b>'.htmlentities($ra_email).'</b>'), $out['title'], 401); |
||
95 | } |
||
1265 | daniel-mar | 96 | |
1278 | daniel-mar | 97 | if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_USER', true)) { |
98 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_USER'), $out['title']); |
||
99 | } |
||
1265 | daniel-mar | 100 | |
1278 | daniel-mar | 101 | if (is_null(OIDplus::getPluginByOid("1.3.6.1.4.1.37476.2.5.2.4.1.2"))) { // OIDplusPagePublicRestApi |
102 | throw new OIDplusException(_L('The administrator has disabled this feature. (Plugin %1).','OIDplusPagePublicRestApi'), $out['title']); |
||
103 | } |
||
1270 | daniel-mar | 104 | |
1278 | daniel-mar | 105 | $gen = OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST; |
106 | $sub = $ra_email; |
||
1265 | daniel-mar | 107 | |
1278 | daniel-mar | 108 | $authSimulation = new OIDplusAuthContentStoreJWT(); |
109 | $authSimulation->raLogin($ra_email); |
||
110 | $authSimulation->setValue('oidplus_generator', $gen); |
||
111 | $token = $authSimulation->getJWTToken(); |
||
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_ra$'.$ra_email.'$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>'; |
||
135 | $out['text'] .= '<p>'._L('The JWT-token (secret!) will automatically perform a one-time-login to fulfill the request. The other fields are the normal fields which are called during the usual operation of OIDplus.').'</p>'; |
||
1265 | daniel-mar | 136 | |
1278 | daniel-mar | 137 | $out['text'] .= '<h2>'._L('Blacklisted tokens').'</h2>'; |
138 | $bl_time = OIDplusAuthContentStoreJWT::jwtGetBlacklistTime($gen, $sub); |
||
139 | if ($bl_time == 0) { |
||
140 | $out['text'] .= '<p>'._L('None of the previously generated JWT tokens have been blacklisted.').'</p>'; |
||
141 | } else { |
||
142 | $out['text'] .= '<p>'._L('All tokens generated before %1 have been blacklisted.',date('d F Y, H:i:s',$bl_time+1)).'</p>'; |
||
143 | } |
||
144 | $out['text'] .= '<button type="button" name="btn_blacklist_jwt" id="btn_blacklist_jwt" class="btn btn-danger btn-xs" onclick="OIDplusPageRaRestApi.blacklistJWT('.js_escape($ra_email).')">'._L('Blacklist all previously generated tokens').'</button>'; |
||
1265 | daniel-mar | 145 | } |
146 | } |
||
147 | } |
||
148 | |||
149 | /** |
||
150 | * @param array $json |
||
151 | * @param string|null $ra_email |
||
152 | * @param bool $nonjs |
||
153 | * @param string $req_goto |
||
154 | * @return bool |
||
155 | * @throws OIDplusException |
||
156 | */ |
||
157 | public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool { |
||
158 | if (!$ra_email) return false; |
||
159 | if (!OIDplus::authUtils()->isRaLoggedIn($ra_email) && !OIDplus::authUtils()->isAdminLoggedIn()) return false; |
||
160 | |||
161 | if (file_exists(__DIR__.'/img/main_icon16.png')) { |
||
162 | $tree_icon = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon16.png'; |
||
163 | } else { |
||
164 | $tree_icon = null; // default icon (folder) |
||
165 | } |
||
166 | |||
1272 | daniel-mar | 167 | if (file_exists(__DIR__.'/img/endpoints_icon16.png')) { |
168 | $tree_icon_endpoints = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/endpoints_icon16.png'; |
||
169 | } else { |
||
170 | $tree_icon_endpoints = null; // default icon (folder) |
||
171 | } |
||
172 | |||
173 | $submenu = array(); |
||
174 | foreach (OIDplus::getAllPlugins() as $plugin) { |
||
175 | if ($plugin instanceof INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_9) { |
||
176 | $submenu[] = [ |
||
1278 | daniel-mar | 177 | 'id' => 'oidplus:rest_api_information_ra$'.$ra_email.'$endpoints:'.$plugin->getManifest()->getOid(), |
1272 | daniel-mar | 178 | 'icon' => $tree_icon_endpoints, |
179 | 'text' => $plugin->getManifest()->getName() . ' ' . _L('Endpoints') |
||
180 | ]; |
||
181 | } |
||
182 | } |
||
183 | |||
1265 | daniel-mar | 184 | $json[] = array( |
1278 | daniel-mar | 185 | 'id' => 'oidplus:rest_api_information_ra$'.$ra_email, |
1265 | daniel-mar | 186 | 'icon' => $tree_icon, |
1272 | daniel-mar | 187 | 'text' => _L('REST API'), |
188 | 'children' => $submenu |
||
1265 | daniel-mar | 189 | ); |
190 | |||
191 | return true; |
||
192 | } |
||
193 | |||
194 | /** |
||
195 | * @param string $request |
||
196 | * @return array|false |
||
197 | */ |
||
198 | public function tree_search(string $request) { |
||
199 | return false; |
||
200 | } |
||
201 | } |