forked from community/device-mgt-core
Add OTP invoker See merge request entgra/carbon-device-mgt!613revert-70ac1926
Dharmakeerthi Lasantha
4 years ago
commit
e927236f79
@ -0,0 +1,270 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) 2020, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
|
||||||
|
*
|
||||||
|
* Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
|
||||||
|
* Version 2.0 (the "License"); you may not use this file except
|
||||||
|
* in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing,
|
||||||
|
* software distributed under the License is distributed on an
|
||||||
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||||
|
* KIND, either express or implied. See the License for the
|
||||||
|
* specific language governing permissions and limitations
|
||||||
|
* under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package io.entgra.ui.request.interceptor;
|
||||||
|
|
||||||
|
import io.entgra.ui.request.interceptor.util.HandlerConstants;
|
||||||
|
import io.entgra.ui.request.interceptor.util.HandlerUtil;
|
||||||
|
import org.apache.commons.fileupload.FileItem;
|
||||||
|
import org.apache.commons.fileupload.FileUploadException;
|
||||||
|
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
|
||||||
|
import org.apache.commons.fileupload.servlet.ServletFileUpload;
|
||||||
|
import org.apache.commons.lang.StringUtils;
|
||||||
|
import org.apache.commons.logging.Log;
|
||||||
|
import org.apache.commons.logging.LogFactory;
|
||||||
|
import org.apache.http.HttpHeaders;
|
||||||
|
import org.apache.http.HttpStatus;
|
||||||
|
import org.apache.http.client.methods.HttpDelete;
|
||||||
|
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
|
||||||
|
import org.apache.http.client.methods.HttpGet;
|
||||||
|
import org.apache.http.client.methods.HttpHead;
|
||||||
|
import org.apache.http.client.methods.HttpPost;
|
||||||
|
import org.apache.http.client.methods.HttpPut;
|
||||||
|
import org.apache.http.client.methods.HttpRequestBase;
|
||||||
|
import org.apache.http.cookie.SM;
|
||||||
|
import org.apache.http.entity.ContentType;
|
||||||
|
import org.apache.http.entity.InputStreamEntity;
|
||||||
|
import org.apache.http.entity.mime.HttpMultipartMode;
|
||||||
|
import org.apache.http.entity.mime.MultipartEntityBuilder;
|
||||||
|
import org.apache.http.entity.mime.content.InputStreamBody;
|
||||||
|
import org.wso2.carbon.device.application.mgt.common.ProxyResponse;
|
||||||
|
|
||||||
|
import javax.servlet.annotation.WebServlet;
|
||||||
|
import javax.servlet.http.HttpServlet;
|
||||||
|
import javax.servlet.http.HttpServletRequest;
|
||||||
|
import javax.servlet.http.HttpServletResponse;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.util.Enumeration;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@WebServlet(
|
||||||
|
name = "RequestHandlerServlet",
|
||||||
|
description = "This servlet intercepts the otp-api requests initiated from the user interface and validate "
|
||||||
|
+ "before forwarding to the backend",
|
||||||
|
urlPatterns = {
|
||||||
|
"/otp-invoke/*"
|
||||||
|
}
|
||||||
|
)
|
||||||
|
public class OTPInvokerHandler extends HttpServlet {
|
||||||
|
private static final Log log = LogFactory.getLog(OTPInvokerHandler.class);
|
||||||
|
private static final long serialVersionUID = 3109569827313066220L;
|
||||||
|
private static String apiEndpoint;
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void doPost(HttpServletRequest req, HttpServletResponse resp) {
|
||||||
|
try {
|
||||||
|
if (validateRequest(req, resp)) {
|
||||||
|
HttpPost postRequest = new HttpPost(HandlerUtil.generateBackendRequestURL(req, apiEndpoint));
|
||||||
|
generateRequestEntity(req, postRequest);
|
||||||
|
ProxyResponse proxyResponse = HandlerUtil.execute(postRequest);
|
||||||
|
|
||||||
|
if (proxyResponse.getExecutorResponse().contains(HandlerConstants.EXECUTOR_EXCEPTION_PREFIX)) {
|
||||||
|
log.error("Error occurred while invoking the POST API endpoint.");
|
||||||
|
HandlerUtil.handleError(resp, proxyResponse);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
HandlerUtil.handleSuccess(resp, proxyResponse);
|
||||||
|
}
|
||||||
|
} catch (FileUploadException e) {
|
||||||
|
log.error("Error occurred when processing Multipart POST request.", e);
|
||||||
|
} catch (IOException e) {
|
||||||
|
log.error("Error occurred when processing POST request.", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
|
||||||
|
try {
|
||||||
|
if (validateRequest(req, resp)) {
|
||||||
|
HttpGet getRequest = new HttpGet(HandlerUtil.generateBackendRequestURL(req, apiEndpoint));
|
||||||
|
copyRequestHeaders(req, getRequest, false);
|
||||||
|
ProxyResponse proxyResponse = HandlerUtil.execute(getRequest);
|
||||||
|
|
||||||
|
if (proxyResponse.getExecutorResponse().contains(HandlerConstants.EXECUTOR_EXCEPTION_PREFIX)) {
|
||||||
|
log.error("Error occurred while invoking the GET API endpoint.");
|
||||||
|
HandlerUtil.handleError(resp, proxyResponse);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
HandlerUtil.handleSuccess(resp, proxyResponse);
|
||||||
|
}
|
||||||
|
} catch (IOException e) {
|
||||||
|
log.error("Error occurred when processing GET request.", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void doHead(HttpServletRequest req, HttpServletResponse resp) {
|
||||||
|
try {
|
||||||
|
if (validateRequest(req, resp)) {
|
||||||
|
HttpHead headRequest = new HttpHead(HandlerUtil.generateBackendRequestURL(req, apiEndpoint));
|
||||||
|
copyRequestHeaders(req, headRequest, false);
|
||||||
|
ProxyResponse proxyResponse = HandlerUtil.execute(headRequest);
|
||||||
|
|
||||||
|
if (proxyResponse.getExecutorResponse().contains(HandlerConstants.EXECUTOR_EXCEPTION_PREFIX)) {
|
||||||
|
log.error("Error occurred while invoking the HEAD API endpoint.");
|
||||||
|
HandlerUtil.handleError(resp, proxyResponse);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
HandlerUtil.handleSuccess(resp, proxyResponse);
|
||||||
|
}
|
||||||
|
} catch (IOException e) {
|
||||||
|
log.error("Error occurred when processing HEAD request.", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void doPut(HttpServletRequest req, HttpServletResponse resp) {
|
||||||
|
try {
|
||||||
|
if (validateRequest(req, resp)) {
|
||||||
|
HttpPut putRequest = new HttpPut(HandlerUtil.generateBackendRequestURL(req, apiEndpoint));
|
||||||
|
generateRequestEntity(req, putRequest);
|
||||||
|
ProxyResponse proxyResponse = HandlerUtil.execute(putRequest);
|
||||||
|
|
||||||
|
if (proxyResponse.getExecutorResponse().contains(HandlerConstants.EXECUTOR_EXCEPTION_PREFIX)) {
|
||||||
|
log.error("Error occurred while invoking the PUT API endpoint.");
|
||||||
|
HandlerUtil.handleError(resp, proxyResponse);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
HandlerUtil.handleSuccess(resp, proxyResponse);
|
||||||
|
}
|
||||||
|
} catch (FileUploadException e) {
|
||||||
|
log.error("Error occurred when processing Multipart PUT request.", e);
|
||||||
|
} catch (IOException e) {
|
||||||
|
log.error("Error occurred when processing PUT request.", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void doDelete(HttpServletRequest req, HttpServletResponse resp) {
|
||||||
|
try {
|
||||||
|
if (validateRequest(req, resp)) {
|
||||||
|
HttpDelete deleteRequest = new HttpDelete(HandlerUtil.generateBackendRequestURL(req, apiEndpoint));
|
||||||
|
copyRequestHeaders(req, deleteRequest, false);
|
||||||
|
ProxyResponse proxyResponse = HandlerUtil.execute(deleteRequest);
|
||||||
|
|
||||||
|
if (proxyResponse.getExecutorResponse().contains(HandlerConstants.EXECUTOR_EXCEPTION_PREFIX)) {
|
||||||
|
log.error("Error occurred while invoking the DELETE API endpoint.");
|
||||||
|
HandlerUtil.handleError(resp, proxyResponse);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
HandlerUtil.handleSuccess(resp, proxyResponse);
|
||||||
|
}
|
||||||
|
} catch (IOException e) {
|
||||||
|
log.error("Error occurred when processing DELETE request.", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate te request entity for POST and PUT requests from the incoming request.
|
||||||
|
*
|
||||||
|
* @param req incoming {@link HttpServletRequest}.
|
||||||
|
* @param proxyRequest proxy request instance.
|
||||||
|
* @throws FileUploadException If unable to parse the incoming request for multipart content extraction.
|
||||||
|
* @throws IOException If error occurred while generating the request body.
|
||||||
|
*/
|
||||||
|
private void generateRequestEntity(HttpServletRequest req, HttpEntityEnclosingRequestBase proxyRequest)
|
||||||
|
throws FileUploadException, IOException {
|
||||||
|
if (ServletFileUpload.isMultipartContent(req)) {
|
||||||
|
ServletFileUpload servletFileUpload = new ServletFileUpload(new DiskFileItemFactory());
|
||||||
|
List<FileItem> fileItemList = servletFileUpload.parseRequest(req);
|
||||||
|
MultipartEntityBuilder entityBuilder = MultipartEntityBuilder.create();
|
||||||
|
entityBuilder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
|
||||||
|
for (FileItem item: fileItemList) {
|
||||||
|
if (!item.isFormField()) {
|
||||||
|
entityBuilder.addPart(item.getFieldName(), new InputStreamBody(item.getInputStream(),
|
||||||
|
ContentType.create(item.getContentType()), item.getName()));
|
||||||
|
} else {
|
||||||
|
entityBuilder.addTextBody(item.getFieldName(), item.getString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
proxyRequest.setEntity(entityBuilder.build());
|
||||||
|
copyRequestHeaders(req, proxyRequest, false);
|
||||||
|
} else {
|
||||||
|
if (StringUtils.isNotEmpty(req.getHeader(HttpHeaders.CONTENT_LENGTH)) ||
|
||||||
|
StringUtils.isNotEmpty(req.getHeader(HttpHeaders.TRANSFER_ENCODING))) {
|
||||||
|
InputStreamEntity entity = new InputStreamEntity(req.getInputStream(),
|
||||||
|
Long.parseLong(req.getHeader(HttpHeaders.CONTENT_LENGTH)));
|
||||||
|
proxyRequest.setEntity(entity);
|
||||||
|
}
|
||||||
|
copyRequestHeaders(req, proxyRequest, true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Copy incoming request headers to the proxy request.
|
||||||
|
*
|
||||||
|
* @param req incoming {@link HttpServletRequest}
|
||||||
|
* @param httpRequest proxy request instance.
|
||||||
|
* @param preserveContentType <code>true</code> if content type header needs to be preserved.
|
||||||
|
* This should be set to <code>false</code> when handling multipart requests as Http
|
||||||
|
* client will generate the Content-Type header automatically.
|
||||||
|
*/
|
||||||
|
private void copyRequestHeaders(HttpServletRequest req, HttpRequestBase httpRequest, boolean preserveContentType) {
|
||||||
|
Enumeration<String> headerNames = req.getHeaderNames();
|
||||||
|
while (headerNames.hasMoreElements()) {
|
||||||
|
String headerName = headerNames.nextElement();
|
||||||
|
if (headerName.equalsIgnoreCase(HttpHeaders.CONTENT_LENGTH) ||
|
||||||
|
headerName.equalsIgnoreCase(SM.COOKIE) ||
|
||||||
|
(!preserveContentType && headerName.equalsIgnoreCase(HttpHeaders.CONTENT_TYPE))) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
Enumeration<String> headerValues = req.getHeaders(headerName);
|
||||||
|
while (headerValues.hasMoreElements()) {
|
||||||
|
httpRequest.setHeader(headerName, headerValues.nextElement());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/***
|
||||||
|
* Validates the incoming request.
|
||||||
|
*
|
||||||
|
* @param req {@link HttpServletRequest}
|
||||||
|
* @param resp {@link HttpServletResponse}
|
||||||
|
* @return If request is a valid one, returns TRUE, otherwise return FALSE
|
||||||
|
* @throws IOException If and error occurs while witting error response to client side
|
||||||
|
*/
|
||||||
|
private static boolean validateRequest(HttpServletRequest req, HttpServletResponse resp)
|
||||||
|
throws IOException {
|
||||||
|
String schema = req.getScheme();
|
||||||
|
apiEndpoint = schema + HandlerConstants.SCHEME_SEPARATOR + System.getProperty("iot.core.host")
|
||||||
|
+ HandlerConstants.COLON + HandlerUtil.getCorePort(schema);
|
||||||
|
|
||||||
|
if (StringUtils.isBlank(req.getHeader(HandlerConstants.OTP_HEADER))) {
|
||||||
|
log.error("Unauthorized, Please provide OTP token.");
|
||||||
|
handleError(resp, HttpStatus.SC_UNAUTHORIZED);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle error requests
|
||||||
|
*
|
||||||
|
* @param resp {@link HttpServletResponse}
|
||||||
|
* @param errorCode HTTP error status code
|
||||||
|
* @throws IOException If error occurred when trying to send the error response.
|
||||||
|
*/
|
||||||
|
private static void handleError(HttpServletResponse resp, int errorCode)
|
||||||
|
throws IOException {
|
||||||
|
ProxyResponse proxyResponse = new ProxyResponse();
|
||||||
|
proxyResponse.setCode(errorCode);
|
||||||
|
proxyResponse.setExecutorResponse(
|
||||||
|
HandlerConstants.EXECUTOR_EXCEPTION_PREFIX + HandlerUtil.getStatusKey(errorCode));
|
||||||
|
HandlerUtil.handleError(resp, proxyResponse);
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in new issue