OCSPRequestParams.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.certificate.ocsp;

  22. import java.security.cert.X509Certificate;
  23. import java.util.ArrayList;
  24. import java.util.HashMap;
  25. import java.util.List;
  26. import java.util.Map;

  28. import org.openspcoop2.utils.LoggerBuffer;
  29. import org.openspcoop2.utils.UtilsException;
  30. import org.openspcoop2.utils.UtilsMultiException;
  31. import org.openspcoop2.utils.certificate.ArchiveLoader;
  32. import org.openspcoop2.utils.certificate.AuthorityInformationAccess;
  33. import org.openspcoop2.utils.certificate.Certificate;
  34. import org.openspcoop2.utils.certificate.CertificateInfo;
  35. import org.openspcoop2.utils.certificate.KeyStore;

  37. /**
  38.  * OCSPRequestParams
  39.  *
  40.  * @author Poli Andrea (apoli@link.it)
  41.  * @author $Author$
  42.  * @version $Rev$, $Date$
  43.  */
  44. public class OCSPRequestParams {

  46.     private X509Certificate certificate;
  47.     private X509Certificate issuerCertificate;
  48.     private KeyStore issuerTrustStore;
  49.     private X509Certificate signerCertificate;
  50.     private KeyStore signerTrustStore;
  51.     private List<String> responderURIs;
  52.     private KeyStore httpsTrustStore;
  53.     private KeyStore httpsKeyStore;
  54.     private OCSPConfig config;
  55.     private boolean isSelfSigned;
  56.     private boolean isCA;
  57.     
  58.     // serve per validare la catena 
  59.     private KeyStore configTrustStore; 
  60.     private IOCSPResourceReader reader;
  61.     
  62.     public boolean isSelfSigned() {
  63.         return this.isSelfSigned;
  64.     }
  65.     public void setSelfSigned(boolean isSelfSigned) {
  66.         this.isSelfSigned = isSelfSigned;
  67.     }
  68.     public boolean isCA() {
  69.         return this.isCA;
  70.     }
  71.     public void setCA(boolean isCA) {
  72.         this.isCA = isCA;
  73.     }
  74.     public OCSPConfig getConfig() {
  75.         return this.config;
  76.     }
  77.     public void setConfig(OCSPConfig config) {
  78.         this.config = config;
  79.     }
  80.     public X509Certificate getCertificate() {
  81.         return this.certificate;
  82.     }
  83.     public void setCertificate(X509Certificate certificate) {
  84.         this.certificate = certificate;
  85.     }
  86.     public X509Certificate getIssuerCertificate() {
  87.         return this.issuerCertificate;
  88.     }
  89.     public void setIssuerCertificate(X509Certificate issuerCertificate) {
  90.         this.issuerCertificate = issuerCertificate;
  91.     }
  92.     public KeyStore getIssuerTrustStore() {
  93.         return this.issuerTrustStore;
  94.     }
  95.     public void setIssuerTrustStore(KeyStore issuerTrustStore) {
  96.         this.issuerTrustStore = issuerTrustStore;
  97.     }
  98.     public X509Certificate getSignerCertificate() {
  99.         return this.signerCertificate;
  100.     }
  101.     public void setSignerCertificate(X509Certificate signerCertificate) {
  102.         this.signerCertificate = signerCertificate;
  103.     }
  104.     public KeyStore getSignerTrustStore() {
  105.         return this.signerTrustStore;
  106.     }
  107.     public void setSignerTrustStore(KeyStore signerTrustStore) {
  108.         this.signerTrustStore = signerTrustStore;
  109.     }
  110.     public List<String> getResponderURIs() {
  111.         return this.responderURIs;
  112.     }
  113.     public void setResponderURIs(List<String> responderURIs) {
  114.         this.responderURIs = responderURIs;
  115.     }
  116.     public KeyStore getHttpsTrustStore() {
  117.         return this.httpsTrustStore;
  118.     }
  119.     public void setHttpsTrustStore(KeyStore httpsTrustStore) {
  120.         this.httpsTrustStore = httpsTrustStore;
  121.     }
  122.     public KeyStore getHttpsKeyStore() {
  123.         return this.httpsKeyStore;
  124.     }
  125.     public void setHttpsKeyStore(KeyStore httpsKeyStore) {
  126.         this.httpsKeyStore = httpsKeyStore;
  127.     }
  128.     
  129.     public KeyStore getConfigTrustStore() {
  130.         return this.configTrustStore;
  131.     }
  132.     public void setConfigTrustStore(KeyStore configTrustStore) {
  133.         this.configTrustStore = configTrustStore;
  134.     }
  135.     public IOCSPResourceReader getReader() {
  136.         return this.reader;
  137.     }
  138.     public void setReader(IOCSPResourceReader reader) {
  139.         this.reader = reader;
  140.     }
  141.     
  142.     public static OCSPRequestParams build(LoggerBuffer log, X509Certificate certificate, KeyStore trustStore, OCSPConfig config, IOCSPResourceReader reader) throws UtilsException {
  143.         CertificateInfo cer = new CertificateInfo(certificate, "ocspVerifica");
  144.         return build(log, cer, trustStore, config, reader);
  145.     }
  146.     public static OCSPRequestParams build(LoggerBuffer log, CertificateInfo certificate, KeyStore trustStore, OCSPConfig config, IOCSPResourceReader reader) throws UtilsException {
  147.     
  148.         if(config==null) {
  149.             throw new UtilsException("Param config is null");
  150.         }
  151.         if(certificate==null) {
  152.             throw new UtilsException("Param certificate is null");
  153.         }
  154.         
  155.         OCSPRequestParams params = new OCSPRequestParams();
  156.         params.config = config;
  157.         params.certificate = certificate.getCertificate();
  158.         try {
  159.             params.isCA = certificate.isCA();
  160.         }catch(Exception t) {
  161.             throw new UtilsException(t.getMessage(),t);
  162.         }
  163.         params.isSelfSigned = certificate.isSelfSigned();
  164.         
  165.         params.configTrustStore = trustStore;
  166.         params.reader = reader;
  167.         
  168.         if(!params.isSelfSigned) {
  169.         
  170.             reader.initConfig(config);
  171.             
  172.             // comprendo issuer del certificato da validare
  173.             if(config.getCaSource()!=null && !config.getCaSource().isEmpty()) {
  174.                 for (CertificateSource s : config.getCaSource()) {
  175.                     if(CertificateSource.CONFIG.equals(s)) {
  176.                         if(trustStore!=null) {
  177.                             params.issuerCertificate = (X509Certificate) trustStore.getCertificateBySubject(params.certificate.getIssuerX500Principal());
  178.                             if(params.issuerCertificate!=null) {
  179.                                 params.issuerTrustStore = trustStore;
  180.                                 log.debug("OCSP IssuerCertificate: use truststore config");
  181.                                 break;
  182.                             }
  183.                         }
  184.                     }
  185.                     else if(CertificateSource.ALTERNATIVE_CONFIG.equals(s)) {
  186.                         KeyStore alternativeTrustStore = null;
  187.                         if(config.getAlternativeTrustStoreCAPath()!=null) {
  188.                             alternativeTrustStore = reader.getIssuerAlternativeTrustStore();
  189.                         }
  190.                         if(alternativeTrustStore!=null) {
  191.                             params.issuerCertificate = (X509Certificate) alternativeTrustStore.getCertificateBySubject(params.certificate.getIssuerX500Principal());
  192.                             if(params.issuerCertificate!=null) {
  193.                                 params.issuerTrustStore = alternativeTrustStore;
  194.                                 log.debug("OCSP IssuerCertificate: use alternative truststore config");
  195.                                 break;
  196.                             }
  197.                         }
  198.                     }
  199.                     else if(CertificateSource.AUTHORITY_INFORMATION_ACCESS.equals(s)) {
  200.                         try {
  201.                             AuthorityInformationAccess aia = certificate.getAuthorityInformationAccess();
  202.                             if(aia!=null) {
  203.                                 List<String> issuer = aia.getCAIssuers();
  204.                                 if(issuer!=null && !issuer.isEmpty()) {
  205.                                     List<Exception> listExceptions = new ArrayList<>();
  206.                                     StringBuilder sbError = new StringBuilder();
  207.                                     boolean find = false;
  208.                                     for (String urlIssuer : issuer) {
  209.                                         Map<String, byte[]> map = new HashMap<>();
  210.                                         try {
  211.                                             reader.readExternalResource(urlIssuer, map);
  212.                                             if(!map.isEmpty()) {
  213.                                                 byte [] issCert = map.get(urlIssuer);
  214.                                                 if(issCert!=null) {
  215.                                                     Certificate cer = ArchiveLoader.load(issCert);
  216.                                                     if(cer!=null && cer.getCertificate()!=null) {
  217.                                                         params.issuerCertificate = cer.getCertificate().getCertificate();
  218.                                                         if(params.issuerCertificate!=null) {
  219.                                                             log.debug("OCSP IssuerCertificate: retrieved from external url '"+urlIssuer+"'");
  220.                                                             find = true;
  221.                                                             break;
  222.                                                         }
  223.                                                     }
  224.                                                 }
  225.                                             }
  226.                                         }catch(Exception t) {
  227.                                             String msgError = "[AuthorityInformationAccess-CAIssuer: "+urlIssuer+"] retrieve failed: "+t.getMessage();
  228.                                             if(sbError.length()>0) {
  229.                                                 sbError.append("\n");
  230.                                             }
  231.                                             sbError.append(msgError);
  232.                                             log.debug("OCSP "+msgError,t);
  233.                                             listExceptions.add(new Exception(msgError,t));
  234.                                         }
  235.                                     }
  236.                                     if(find) {
  237.                                         break;
  238.                                     }
  239.                                     if(!listExceptions.isEmpty()) {
  240.                                         throw new UtilsMultiException("OCSP IssuerCertificate retrieve failed: "+sbError.toString(), listExceptions.toArray(new Throwable[1]));
  241.                                     }
  242.                                 }
  243.                             }
  244.                         }catch(Exception t) {
  245.                             throw new UtilsException(t.getMessage(),t);
  246.                         }
  247.                     }
  248.                 }
  249.             }
  250.             
  251.             // comprendo signer
  252.             KeyStore signerTrustStore = reader.getSignerTrustStore();
  253.             if(config.getAliasCertificateSigner()!=null) {
  254.                 try {
  255.                     params.signerCertificate = (X509Certificate) signerTrustStore.getCertificate(config.getAliasCertificateSigner());
  256.                     if(params.signerCertificate==null) {
  257.                         throw new UtilsException("Not found");
  258.                     }
  259.                     log.debug("OCSP SignerCertificate: retrieved from truststore config (alias:"+config.getAliasCertificateSigner()+")");
  260.                 }catch(Exception t) {
  261.                     throw new UtilsException("Get signer certificate failed: "+t.getMessage(),t);
  262.                 }
  263.             }
  264.             else {
  265.                 params.signerTrustStore = signerTrustStore;
  266.                 if(signerTrustStore!=null) {
  267.                     log.debug("OCSP SignerCertificate: use truststore config");
  268.                 }
  269.             }
  270.             
  271.             // responder url
  272.             params.responderURIs = new ArrayList<>();
  273.             if(config.getResponderUrlSource()!=null && !config.getResponderUrlSource().isEmpty()) {
  274.                 for (CertificateSource s : config.getResponderUrlSource()) {
  275.                     if(CertificateSource.CONFIG.equals(s)) {
  276.                         throw new UtilsException("Unsupported");
  277.                     }
  278.                     else if(CertificateSource.ALTERNATIVE_CONFIG.equals(s)) {
  279.                         List<String> alternativeUrl = params.isCA ? config.getAlternativeResponderUrlCA() : config.getAlternativeResponderUrl();
  280.                         if(alternativeUrl!=null && !alternativeUrl.isEmpty()) {
  281.                             for (String url : alternativeUrl) {
  282.                                 if(!params.responderURIs.contains(url)) {
  283.                                     params.responderURIs.add(url);
  284.                                     log.debug("OCSP ResponderURL: add alternative url '"+url+"'");
  285.                                 }
  286.                             }
  287.                         }
  288.                     }
  289.                     else if(CertificateSource.AUTHORITY_INFORMATION_ACCESS.equals(s)) {
  290.                         try {
  291.                             AuthorityInformationAccess aia = certificate.getAuthorityInformationAccess();
  292.                             if(aia!=null) {
  293.                                 List<String> ocsps = aia.getOCSPs();
  294.                                 if(ocsps!=null && !ocsps.isEmpty()) {
  295.                                     String urlOcsp = ocsps.get(0);
  296.                                     if(!params.responderURIs.contains(urlOcsp)) {
  297.                                         params.responderURIs.add(urlOcsp);
  298.                                         log.debug("OCSP ResponderURL: add external url '"+urlOcsp+"'");
  299.                                     }
  300.                                 }
  301.                             }
  302.                         }catch(Exception t) {
  303.                             throw new UtilsException(t.getMessage(),t);
  304.                         }
  305.                     }
  306.                 }
  307.             }
  308.             
  309.             // https truststore
  310.             params.httpsTrustStore = reader.getHttpsTrustStore();
  311.             
  312.             // https keystore
  313.             params.httpsKeyStore = reader.getHttpsKeyStore();
  314.         }
  315.         
  316.         return params;
  317.     }
  318.     
  319. }
Created with JaCoCo 0.8.8.202204050719