1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?php
namespace RestApi\Controller;
use Zend\Mvc\Controller\AbstractRestfulController;
use Zend\View\Model\JsonModel;
use Firebase\JWT\JWT;
use Zend\EventManager\EventManagerInterface;
class ApiController extends AbstractRestfulController
{
/**
* @var Integer $httpStatusCode Define Api Response code.
*/
public $httpStatusCode = 200;
/**
* @var array $apiResponse Define response for api
*/
public $apiResponse;
/**
*
* @var type string
*/
public $token;
/**
*
* @var type Object or Array
*/
public $tokenPayload;
/**
* set Event Manager to check Authorization
* @param \Zend\EventManager\EventManagerInterface $events
*/
public function setEventManager(EventManagerInterface $events)
{
parent::setEventManager($events);
$events->attach('dispatch', array($this, 'checkAuthorization'), 10);
}
/**
* This Function call from eventmanager to check authntication and token validation
* @param type $event
*
*/
public function checkAuthorization($event)
{
$request = $event->getRequest();
$response = $event->getResponse();
$isAuthorizationRequired = $event->getRouteMatch()->getParam('isAuthorizationRequired');
$config = $event->getApplication()->getServiceManager()->get('Config');
$event->setParam('config', $config);
if (isset($config['ApiRequest'])) {
$responseStatusKey = $config['ApiRequest']['responseFormat']['statusKey'];
if (!$isAuthorizationRequired) {
return;
}
$jwtToken = $this->findJwtToken($request);
if ($jwtToken) {
$this->token = $jwtToken;
$this->decodeJwtToken();
if (is_object($this->tokenPayload)) {
return;
}
$response->setStatusCode(400);
$jsonModelArr = [$responseStatusKey => $config['ApiRequest']['responseFormat']['statusNokText'], $config['ApiRequest']['responseFormat']['resultKey'] => [$config['ApiRequest']['responseFormat']['errorKey'] => $this->tokenPayload]];
} else {
$response->setStatusCode(401);
$jsonModelArr = [$responseStatusKey => $config['ApiRequest']['responseFormat']['statusNokText'], $config['ApiRequest']['responseFormat']['resultKey'] => [$config['ApiRequest']['responseFormat']['errorKey'] => $config['ApiRequest']['responseFormat']['authenticationRequireText']]];
}
} else {
$response->setStatusCode(400);
$jsonModelArr = ['status' => 'NOK', 'result' => ['error' => 'Require copy this file vender\multidots\zf3-rest-api\config\restapi.global.php and paste to root config\autoload\restapi.global.php']];
}
$response->getHeaders()->addHeaderLine('Content-Type', 'application/json');
$view = new JsonModel($jsonModelArr);
$response->setContent($view->serialize());
return $response;
}
/**
* Check Request object have Authorization token or not
* @param type $request
* @return type String
*/
public function findJwtToken($request)
{
$jwtToken = $request->getHeaders("Authorization") ? $request->getHeaders("Authorization")->getFieldValue() : '';
if ($jwtToken) {
$jwtToken = trim(trim($jwtToken, "Bearer"), " ");
return $jwtToken;
}
if ($request->isGet()) {
$jwtToken = $request->getQuery('token');
}
if ($request->isPost()) {
$jwtToken = $request->getPost('token');
}
return $jwtToken;
}
/**
* contain user information for createing JWT Token
*/
protected function generateJwtToken($payload)
{
if (!is_array($payload) && !is_object($payload)) {
$this->token = false;
return false;
}
$this->tokenPayload = $payload;
$config = $this->getEvent()->getParam('config', false);
$cypherKey = $config['ApiRequest']['jwtAuth']['cypherKey'];
$tokenAlgorithm = $config['ApiRequest']['jwtAuth']['tokenAlgorithm'];
$this->token = JWT::encode($this->tokenPayload, $cypherKey, $tokenAlgorithm);
return $this->token;
}
/**
* contain encoded token for user.
*/
protected function decodeJwtToken()
{
if (!$this->token) {
$this->tokenPayload = false;
}
$config = $this->getEvent()->getParam('config', false);
$cypherKey = $config['ApiRequest']['jwtAuth']['cypherKey'];
$tokenAlgorithm = $config['ApiRequest']['jwtAuth']['tokenAlgorithm'];
try {
$decodeToken = JWT::decode($this->token, $cypherKey, [$tokenAlgorithm]);
$this->tokenPayload = $decodeToken;
} catch (\Exception $e) {
$this->tokenPayload = $e->getMessage();
}
}
/**
* Create Response for api Assign require data for response and check is valid response or give error
* @return \Zend\View\Model\JsonModel
*
*/
public function createResponse()
{
$config = $this->getEvent()->getParam('config', false);
$event = $this->getEvent();
$response = $event->getResponse();
if (is_array($this->apiResponse)) {
$response->setStatusCode($this->httpStatusCode);
} else {
$this->httpStatusCode = 500;
$response->setStatusCode($this->httpStatusCode);
$errorKey = $config['ApiRequest']['responseFormat']['errorKey'];
$defaultErrorText = $config['ApiRequest']['responseFormat']['defaultErrorText'];
$this->apiResponse[$errorKey] = $defaultErrorText;
}
$statusKey = $config['ApiRequest']['responseFormat']['statusKey'];
if ($this->httpStatusCode == 200) {
$sendResponse[$statusKey] = $config['ApiRequest']['responseFormat']['statusOkText'];
} else {
$sendResponse[$statusKey] = $config['ApiRequest']['responseFormat']['statusNokText'];
}
$sendResponse[$config['ApiRequest']['responseFormat']['resultKey']] = $this->apiResponse;
return new JsonModel($sendResponse);
}
}