4 use Shaarli\Api\Exceptions\ApiException
;
5 use Shaarli\Api\Exceptions\ApiAuthorizationException
;
7 use Shaarli\Config\ConfigManager
;
10 use Slim\Http\Response
;
15 * This will be called before accessing any API Controller.
16 * Its role is to make sure that the API is enabled, configured, and to validate the JWT token.
18 * If the request is validated, the controller is called, otherwise a JSON error response is returned.
25 * @var int JWT token validity in seconds (9 min).
27 public static $TOKEN_DURATION = 540;
30 * @var Container: contains conf, plugins, etc.
35 * @var ConfigManager instance.
40 * ApiMiddleware constructor.
42 * @param Container $container instance.
44 public function __construct($container)
46 $this->container
= $container;
47 $this->conf
= $this->container
->get('conf');
48 $this->setLinkDb($this->conf
);
52 * Middleware execution:
53 * - check the API request
54 * - execute the controller
55 * - return the response
57 * @param Request $request Slim request
58 * @param Response $response Slim response
59 * @param callable $next Next action
61 * @return Response response.
63 public function __invoke($request, $response, $next)
66 $this->checkRequest($request);
67 $response = $next($request, $response);
68 } catch (ApiException
$e) {
69 $e->setResponse($response);
70 $e->setDebug($this->conf
->get('dev.debug', false));
71 $response = $e->getApiResponse();
78 * Check the request validity (HTTP method, request value, etc.),
79 * that the API is enabled, and the JWT token validity.
81 * @param Request $request Slim request
83 * @throws ApiAuthorizationException The API is disabled or the token is invalid.
85 protected function checkRequest($request)
87 if (! $this->conf
->get('api.enabled', true)) {
88 throw new ApiAuthorizationException('API is disabled');
90 $this->checkToken($request);
94 * Check that the JWT token is set and valid.
95 * The API secret setting must be set.
97 * @param Request $request Slim request
99 * @throws ApiAuthorizationException The token couldn't be validated.
101 protected function checkToken($request)
103 if (! $request->hasHeader('Authorization')) {
104 throw new ApiAuthorizationException('JWT token not provided');
107 if (empty($this->conf
->get('api.secret'))) {
108 throw new ApiAuthorizationException('Token secret must be set in Shaarli\'s administration');
111 $authorization = $request->getHeaderLine('Authorization');
113 if (! preg_match('/^Bearer (.*)/i', $authorization, $matches)) {
114 throw new ApiAuthorizationException('Invalid JWT header');
117 ApiUtils
::validateJwtToken($matches[1], $this->conf
->get('api.secret'));
121 * Instantiate a new LinkDB including private links,
122 * and load in the Slim container.
124 * FIXME! LinkDB could use a refactoring to avoid this trick.
126 * @param ConfigManager $conf instance.
128 protected function setLinkDb($conf)
130 $linkDb = new \
LinkDB(
131 $conf->get('resource.datastore'),
133 $conf->get('privacy.hide_public_links'),
134 $conf->get('redirector.url'),
135 $conf->get('redirector.encode_url')
137 $this->container
['db'] = $linkDb;