ExternalResourceUtils.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */
  20. package org.openspcoop2.utils.transport.http;

  22. import java.io.File;
  23. import java.util.ArrayList;
  24. import java.util.HashMap;
  25. import java.util.List;
  26. import java.util.Map;

  28. import javax.naming.directory.Attribute;
  29. import javax.naming.directory.Attributes;

  31. import org.apache.commons.lang.StringUtils;
  32. import org.openspcoop2.utils.Utilities;
  33. import org.openspcoop2.utils.UtilsException;
  34. import org.openspcoop2.utils.io.Base64Utilities;
  35. import org.openspcoop2.utils.resources.FileSystemUtilities;
  36. import org.openspcoop2.utils.transport.TransportUtils;
  37. import org.openspcoop2.utils.transport.ldap.LdapClientFactory;
  38. import org.openspcoop2.utils.transport.ldap.LdapClientInterface;
  39. import org.openspcoop2.utils.transport.ldap.LdapEngineType;
  40. import org.openspcoop2.utils.transport.ldap.LdapQuery;
  41. import org.openspcoop2.utils.transport.ldap.LdapUtility;

  43. /**
  44.  * ExternalResourceUtils
  45.  *
  46.  * @author Andrea Poli (apoli@link.it)
  47.  * @author $Author$
  48.  * @version $Rev$, $Date$
  49.  */
  50. public class ExternalResourceUtils {
  51.     
  52.     private ExternalResourceUtils() {}

  54.     public static byte[] readResource(String resource, ExternalResourceConfig externalConfig) throws UtilsException {
  55.         return readResourceReturnHttpResponse(resource, externalConfig).getContent();
  56.     }
  57.     public static HttpResponse readResourceReturnHttpResponse(String resource, ExternalResourceConfig externalConfig) throws UtilsException {
  58.         
  59.         HttpResponse res = null;
  60.         try {
  61.             if(!TransportUtils.isRemoteResource(resource.trim())) {
  62.                 try {
  63.                     File f = new File(resource);
  64.                     if(f.exists()) {
  65.                         byte[] content = FileSystemUtilities.readBytesFromFile(f);
  66.                         HttpResponse response = new HttpResponse();
  67.                         response.setResultHTTPOperation(200);
  68.                         response.setContent(content);
  69.                         return response;
  70.                     }
  71.                 }catch(Exception t) {
  72.                     // ignore
  73.                 }
  74.                 throw new UtilsException("Unsupported protocol");
  75.             }
  76.             
  77.             if(TransportUtils.isLdapResource(resource)) {
  78.                 return readLdapResource(resource, externalConfig);
  79.             }
  80.             
  81.             HttpRequest req = new HttpRequest();
  82.             req.setMethod(HttpRequestMethod.GET);
  83.             
  84.             if(externalConfig.getHeaders()!=null && !externalConfig.getHeaders().isEmpty()) {
  85.                 for (Map.Entry<String,String> entry : externalConfig.getHeaders().entrySet()) {
  86.                     if(entry.getKey()!=null && entry.getValue()!=null) {
  87.                         req.addHeader(entry.getKey(),entry.getValue());
  88.                     }
  89.                 }
  90.             }
  91.             
  92.             resource = resource.trim();
  93.             
  94.             if(externalConfig.getQueryParameters()!=null && !externalConfig.getQueryParameters().isEmpty()) {
  95.                 resource = TransportUtils.buildUrlWithParameters(TransportUtils.convertToMapListValues(externalConfig.getQueryParameters()), resource);
  96.             }
  97.             
  98.             if(externalConfig.getForwardProxyUrl()!=null && StringUtils.isNotEmpty(externalConfig.getForwardProxyUrl())) {
  99.                 String forwardProxyUrl = externalConfig.getForwardProxyUrl();
  100.                 String remoteLocation = externalConfig.isForwardProxyBase64() ? Base64Utilities.encodeAsString(resource.getBytes()) : resource;
  101.                 if(externalConfig.getForwardProxyHeader()!=null && StringUtils.isNotEmpty(externalConfig.getForwardProxyHeader())) {
  102.                     req.addHeader(externalConfig.getForwardProxyHeader(), remoteLocation);
  103.                 }
  104.                 else if(externalConfig.getForwardProxyQueryParameter()!=null && StringUtils.isNotEmpty(externalConfig.getForwardProxyQueryParameter())) {
  105.                     Map<String, List<String>> queryParameters = new HashMap<>();
  106.                     TransportUtils.addParameter(queryParameters,externalConfig.getForwardProxyQueryParameter(), remoteLocation);
  107.                     forwardProxyUrl = TransportUtils.buildUrlWithParameters(queryParameters, forwardProxyUrl, false, null);
  108.                 }
  109.                 else {
  110.                     throw new UtilsException("Forward Proxy configuration error: header and query parameter not found");
  111.                 }
  112.                 req.setUrl(forwardProxyUrl);
  113.             }
  114.             else {
  115.                 req.setUrl(resource);
  116.             }
  117.             
  118.             if(req.getUrl().startsWith("https")) {
  119.                 req.setHostnameVerifier(externalConfig.isHostnameVerifier());
  120.                 req.setTrustAllCerts(externalConfig.isTrustAllCerts());
  121.                 if(externalConfig.getTrustStore()!=null) {
  122.                     req.setTrustStore(externalConfig.getTrustStore());
  123.                 }
  124.                 if(externalConfig.getKeyStore()!=null) {
  125.                     req.setKeyStore(externalConfig.getKeyStore());
  126.                     req.setKeyAlias(externalConfig.getKeyAlias());
  127.                     req.setKeyPassword(externalConfig.getKeyPassword());
  128.                 }
  129.             }
  130.             req.setConnectTimeout(externalConfig.getConnectTimeout());
  131.             req.setReadTimeout(externalConfig.getReadTimeout());
  132.             
  133.             req.setUsername(externalConfig.getBasicUsername());
  134.             req.setPassword(externalConfig.getBasicPassword());
  135.             
  136.             res = HttpUtilities.httpInvoke(req);

  138.         }catch(Exception t) {
  139.             throw new UtilsException("Retrieve external resource '"+resource+"' failed: "+t.getMessage(),t);
  140.         }

  142.         validateResponse(res, resource, externalConfig);
  143.         
  144.         return res;
  145.     }
  146.     
  147.     private static HttpResponse readLdapResource(String resource, ExternalResourceConfig externalConfig) throws UtilsException {
  148.         
  149.         try {
  150.         
  151.             LdapClientInterface clientLdap = LdapClientFactory.getClient(LdapEngineType.SPRING_FRAMEWORK);
  152.             clientLdap.uri(LdapUtility.getBaseUrlFromURI(resource));
  153.             if(externalConfig.getBasicUsername()!=null && externalConfig.getBasicPassword()!=null) {
  154.                 clientLdap.username(externalConfig.getBasicUsername());
  155.                 clientLdap.password(externalConfig.getBasicPassword());
  156.             }
  157.             LdapQuery parsedQuery = LdapUtility.getQueryFromURI(resource);
  158.             if(parsedQuery==null) {
  159.                 throw new UtilsException("parse failed");
  160.             }
  161.             String parsedAttribute = null;
  162.             if(parsedQuery.getAttributes()!=null && !parsedQuery.getAttributes().isEmpty()) {
  163.                 parsedAttribute = parsedQuery.getAttributes().get(0);
  164.             }
  165.             if(parsedAttribute==null) {
  166.                 throw new UtilsException("parse attribute failed");
  167.             }
  168.             List<Attributes> list = clientLdap.search(parsedQuery);
  169.             if(list == null || list.isEmpty()) {
  170.                 throw new UtilsException("results not found");
  171.             }
  172.             if(list.size()>1) {
  173.                 throw new UtilsException("more than one result found ("+list.size()+")");
  174.             }
  175.             Attributes attrs = list.get(0);
  176.             if(attrs==null || attrs.size()<=0) {
  177.                 throw new UtilsException("attributes empty");
  178.             }
  179.             Attribute a = attrs.get(parsedAttribute);
  180.             if(a==null) {
  181.                 throw new UtilsException("attribute '"+parsedAttribute+"' not found");
  182.             }
  183.             Object o = a.get();
  184.             if(o==null) {
  185.                 throw new UtilsException("attribute '"+parsedAttribute+"' null");
  186.             }
  187.             byte [] content = null;
  188.             if(o instanceof byte[]) {
  189.                 content = (byte[]) o; 
  190.             }
  191.             else if(o instanceof String) {
  192.                 content = ((String) o).getBytes(); 
  193.             }
  194.             else {
  195.                 throw new UtilsException("attribute '"+parsedAttribute+"' with unknown type: "+o.getClass().getName());
  196.             }
  197.             
  198.             HttpResponse response = new HttpResponse();
  199.             response.setResultHTTPOperation(200);
  200.             response.setContent(content);
  201.             return response;
  202.         
  203.         }catch(Exception t) {
  204.             throw new UtilsException("Retrieve external resource '"+resource+"' failed: "+t.getMessage(),t);
  205.         }
  206.             
  207.     }
  208.     
  209.     private static void validateResponse(HttpResponse res, String resource, ExternalResourceConfig externalConfig) throws UtilsException {
  210.         try {
  211.             List<Integer> returnCodeValid = externalConfig.getReturnCode();
  212.             if(returnCodeValid==null) {
  213.                 returnCodeValid = new ArrayList<>();
  214.             }
  215.             if(returnCodeValid.isEmpty()) {
  216.                 returnCodeValid.add(200);
  217.             }
  218.             boolean isValid = false;
  219.             for (Integer rt : returnCodeValid) {
  220.                 if(rt!=null && rt.intValue() == res.getResultHTTPOperation()) {
  221.                     isValid = true;
  222.                     break;
  223.                 }
  224.             }
  225.     
  226.             byte[] response = res.getContent();
  227.     
  228.             if(isValid) {
  229.                 if(response==null || response.length<=0) {
  230.                     throw new UtilsException("Empty response (http code: "+res.getResultHTTPOperation()+")");
  231.                 }
  232.             }
  233.             else {
  234.                 String error = null;
  235.                 if(response.length<=(2048)) {
  236.                     error = Utilities.convertToPrintableText(response, 2048);
  237.                     if(error!=null && error.contains("Visualizzazione non riuscita")) {
  238.                         error = null;
  239.                     }
  240.                 }
  241.                 if(error==null) {
  242.                     error="";
  243.                 }
  244.                 else {
  245.                     error = ": "+error;
  246.                 }
  247.                 
  248.                 throw new UtilsException("(http code: "+res.getResultHTTPOperation()+")"+error);
  249.             }
  250.     
  251.         }catch(Exception t) {
  252.             throw new UtilsException("Retrieve external resource '"+resource+"' failed: "+t.getMessage(),t);
  253.         }
  254.     }

  256. }
Created with JaCoCo 0.8.8.202204050719