AutenticazioneApiKey.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.  */



  23. package org.openspcoop2.pdd.core.autenticazione.pa;

  25. import org.openspcoop2.core.id.IDServizioApplicativo;
  26. import org.openspcoop2.core.id.IDSoggetto;
  27. import org.openspcoop2.core.registry.driver.DriverRegistroServiziNotFound;
  28. import org.openspcoop2.message.OpenSPCoop2Message;
  29. import org.openspcoop2.pdd.config.ConfigurazionePdDManager;
  30. import org.openspcoop2.pdd.config.OpenSPCoop2Properties;
  31. import org.openspcoop2.pdd.core.autenticazione.ApiKeyUtilities;
  32. import org.openspcoop2.pdd.core.autenticazione.AutenticazioneException;
  33. import org.openspcoop2.pdd.core.autenticazione.AutenticazioneUtils;
  34. import org.openspcoop2.pdd.core.autenticazione.ParametriAutenticazione;
  35. import org.openspcoop2.pdd.core.autenticazione.ParametriAutenticazioneApiKey;
  36. import org.openspcoop2.pdd.core.autenticazione.WWWAuthenticateConfig;
  37. import org.openspcoop2.pdd.logger.OpenSPCoop2Logger;
  38. import org.openspcoop2.protocol.registry.RegistroServiziManager;
  39. import org.openspcoop2.protocol.sdk.constants.ErroriCooperazione;
  40. import org.openspcoop2.protocol.sdk.constants.IntegrationFunctionError;
  41. import org.openspcoop2.utils.BooleanNullable;
  42. import org.openspcoop2.utils.crypt.CryptConfig;

  44. /**
  45.  * Classe che implementa una autenticazione API-Key.
  46.  *
  47.  * @author Andrea Poli (apoli@link.it)
  48.  * @author $Author$
  49.  * @version $Rev$, $Date$
  50.  */

  52. public class AutenticazioneApiKey extends AbstractAutenticazioneBase {

  54.     private boolean header = true;
  55.     private boolean cookie = true;
  56.     private boolean queryParameter = true;
  57.     
  58.     private String nomeHeaderApiKey = null;
  59.     private String nomeCookieApiKey = null;
  60.     private String nomeQueryParameterApiKey = null;
  61.     
  62.     private boolean appId = false;
  63.     
  64.     private String nomeHeaderAppId = null;
  65.     private String nomeCookieAppId = null;
  66.     private String nomeQueryParameterAppId = null;
  67.     
  68.     private boolean cleanApiKey = true;
  69.     private boolean cleanAppId = true;
  70.     
  71.     private boolean logError = true;
  72.     @Override
  73.     public void setLogError(boolean logError) {
  74.         this.logError = logError;
  75.     }
  76.     
  77.     @Override
  78.     public void initParametri(ParametriAutenticazione parametri) throws AutenticazioneException {
  79.         super.initParametri(parametri);
  80.         
  81.         ParametriAutenticazioneApiKey authApiKey = new ParametriAutenticazioneApiKey(this.parametri);
  82.         
  83.         BooleanNullable bNullable = authApiKey.getHeader();
  84.         if(bNullable!=null && bNullable.getValue()!=null) {
  85.             this.header = bNullable.getValue();
  86.         }
  87.         
  88.         bNullable = authApiKey.getCookie();
  89.         if(bNullable!=null && bNullable.getValue()!=null) {
  90.             this.cookie = bNullable.getValue();
  91.         }
  92.         
  93.         bNullable = authApiKey.getQueryParameter();
  94.         if(bNullable!=null && bNullable.getValue()!=null) {
  95.             this.queryParameter = bNullable.getValue();
  96.         }
  97.                 
  98.         this.nomeHeaderApiKey = authApiKey.getNomeHeaderApiKey();
  99.         this.nomeCookieApiKey = authApiKey.getNomeCookieApiKey();
  100.         this.nomeQueryParameterApiKey = authApiKey.getNomeQueryParameterApiKey();
  101.         
  102.         bNullable = authApiKey.getAppId();
  103.         if(bNullable!=null && bNullable.getValue()!=null) {
  104.             this.appId = bNullable.getValue();
  105.         }
  106.                 
  107.         if(this.appId) {
  108.             this.nomeHeaderAppId = authApiKey.getNomeHeaderAppId();
  109.             this.nomeCookieAppId = authApiKey.getNomeCookieAppId();
  110.             this.nomeQueryParameterAppId = authApiKey.getNomeQueryParameterAppId();
  111.         }
  112.         
  113.         bNullable = authApiKey.getCleanApiKey();
  114.         if(bNullable!=null && bNullable.getValue()!=null) {
  115.             this.cleanApiKey = bNullable.getValue();
  116.         }
  117.         
  118.         if(this.appId) {
  119.             bNullable = authApiKey.getCleanAppId();
  120.             if(bNullable!=null && bNullable.getValue()!=null) {
  121.                 this.cleanAppId = bNullable.getValue();
  122.             }
  123.         }
  124.                 
  125.     }
  126.     
  127.     @Override
  128.     public String getSuffixKeyAuthenticationResultInCache(DatiInvocazionePortaApplicativa datiInvocazione) {
  129.         
  130.         if(datiInvocazione==null) {
  131.             return null;
  132.         }
  133.         try {
  134.             String apiKey = ApiKeyUtilities.getKey(true, this.header, this.cookie, this.queryParameter, 
  135.                     this.nomeHeaderApiKey, this.nomeCookieApiKey, this.nomeQueryParameterApiKey, 
  136.                     datiInvocazione.getInfoConnettoreIngresso(), this.getPddContext(), false,
  137.                     new StringBuilder());
  138.             if(apiKey==null) {
  139.                 return null;
  140.             }
  141.             if(this.appId) {
  142.                 String appId = ApiKeyUtilities.getKey(false, this.header, this.cookie, this.queryParameter, 
  143.                         this.nomeHeaderAppId, this.nomeCookieAppId, this.nomeQueryParameterAppId, 
  144.                         datiInvocazione.getInfoConnettoreIngresso(), this.getPddContext(), false,
  145.                         new StringBuilder());
  146.                 if(appId==null) {
  147.                     return null;
  148.                 }
  149.                 return "multipleApiKey-"+appId+"."+apiKey;
  150.             }
  151.             else {
  152.                 return "apiKey-"+apiKey;
  153.             }
  154.         }catch(Exception e) {
  155.             return null;
  156.         }
  157.         
  158.     }
  159.     
  160.     @Override
  161.     public EsitoAutenticazionePortaApplicativa process(DatiInvocazionePortaApplicativa datiInvocazione) throws AutenticazioneException{

  163.         EsitoAutenticazionePortaApplicativa esito = new EsitoAutenticazionePortaApplicativa();
  164.         
  165.         StringBuilder fullCredential= new StringBuilder();
  166.         
  167.         OpenSPCoop2Properties op2Properties = OpenSPCoop2Properties.getInstance();
  168.         WWWAuthenticateConfig wwwAuthenticateConfig = op2Properties.getRealmAutenticazioneApiKeyWWWAuthenticateConfig();    
  169.         
  170.         // Controllo apiKey fornite
  171.         String apiKey = null;
  172.         try {
  173.             apiKey = ApiKeyUtilities.getKey(true, this.header, this.cookie, this.queryParameter, 
  174.                     this.nomeHeaderApiKey, this.nomeCookieApiKey, this.nomeQueryParameterApiKey, 
  175.                     datiInvocazione!=null ? datiInvocazione.getInfoConnettoreIngresso() : null, this.getPddContext(), true,
  176.                     fullCredential); 
  177.         }catch(Exception e) {
  178.             if(this.logError) {
  179.                 OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey non riuscita",e);
  180.             }
  181.             esito.setErroreCooperazione(IntegrationFunctionError.AUTHENTICATION_CREDENTIALS_NOT_FOUND, ErroriCooperazione.AUTENTICAZIONE_FALLITA_CREDENZIALI_NON_FORNITE.getErroreCooperazione());
  182.             esito.setClientAuthenticated(false);
  183.             esito.setClientIdentified(false);
  184.             if(wwwAuthenticateConfig!=null) {
  185.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_notFound());
  186.             }
  187.             return esito;
  188.         }
  189.         if( apiKey==null || "".equals(apiKey) ){
  190.             esito.setErroreCooperazione(IntegrationFunctionError.AUTHENTICATION_CREDENTIALS_NOT_FOUND, ErroriCooperazione.AUTENTICAZIONE_FALLITA_CREDENZIALI_NON_FORNITE.getErroreCooperazione());
  191.             esito.setClientAuthenticated(false);
  192.             esito.setClientIdentified(false);
  193.             if(wwwAuthenticateConfig!=null) {
  194.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_notFound());
  195.             }
  196.             return esito;
  197.         }
  198.         
  199.         String appId = null;
  200.         if(this.appId) {
  201.             try {
  202.                 appId = ApiKeyUtilities.getKey(false, this.header, this.cookie, this.queryParameter, 
  203.                         this.nomeHeaderAppId, this.nomeCookieAppId, this.nomeQueryParameterAppId, 
  204.                         datiInvocazione!=null ? datiInvocazione.getInfoConnettoreIngresso() : null, this.getPddContext(), true,
  205.                         fullCredential);
  206.             }catch(Exception e) {
  207.                 if(this.logError) {
  208.                     OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey (AppId) non riuscita",e);
  209.                 }
  210.                 esito.setErroreCooperazione(IntegrationFunctionError.AUTHENTICATION_CREDENTIALS_NOT_FOUND, ErroriCooperazione.AUTENTICAZIONE_FALLITA_CREDENZIALI_NON_FORNITE.getErroreCooperazione());
  211.                 esito.setClientAuthenticated(false);
  212.                 esito.setClientIdentified(false);
  213.                 esito.setFullCredential(fullCredential.toString());
  214.                 if(wwwAuthenticateConfig!=null) {
  215.                     esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_notFound());
  216.                 }
  217.                 return esito;
  218.             }
  219.             if( appId==null || "".equals(appId) ){
  220.                 esito.setErroreCooperazione(IntegrationFunctionError.AUTHENTICATION_CREDENTIALS_NOT_FOUND, ErroriCooperazione.AUTENTICAZIONE_FALLITA_CREDENZIALI_NON_FORNITE.getErroreCooperazione());
  221.                 esito.setClientAuthenticated(false);
  222.                 esito.setClientIdentified(false);
  223.                 esito.setFullCredential(fullCredential.toString());
  224.                 if(wwwAuthenticateConfig!=null) {
  225.                     esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_notFound());
  226.                 }
  227.                 return esito;
  228.             }
  229.         }
  230.         
  231.         // per conoscere la credenziale passata anche in caso di autenticazione fallita
  232.         esito.setFullCredential(fullCredential.toString());
  233.                 
  234.         String identitaAutenticata = null;
  235.         String password = null;
  236.         try {
  237.             if(this.appId) {
  238.                 identitaAutenticata = appId;
  239.                 password = ApiKeyUtilities.decodeMultipleApiKey(apiKey);
  240.             }
  241.             else {
  242.                 String [] decodedApiKey = ApiKeyUtilities.decodeApiKey(apiKey);
  243.                 identitaAutenticata = decodedApiKey[0];
  244.                 password = decodedApiKey[1];
  245.             }
  246.         }catch(Exception e) {
  247.             if(this.logError) {
  248.                 OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey (appId:"+this.appId+") fallita",e);
  249.             }
  250.             esito.setErroreCooperazione(IntegrationFunctionError.AUTHENTICATION_INVALID_CREDENTIALS, ErroriCooperazione.AUTENTICAZIONE_FALLITA_CREDENZIALI_FORNITE_NON_CORRETTE.getErroreCooperazione());
  251.             esito.setClientAuthenticated(false);
  252.             esito.setClientIdentified(false);
  253.             if(wwwAuthenticateConfig!=null) {
  254.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_invalid());
  255.             }
  256.             return esito;
  257.         }
  258.         
  259.         
  260.         CryptConfig cryptConfigApplicativi = op2Properties.getCryptConfigAutenticazioneApplicativi();
  261.         CryptConfig cryptConfigSoggetti = op2Properties.getCryptConfigAutenticazioneSoggetti();
  262.                     
  263.         // !NO!: Essendoci il principal del chiamante, il client e' stato autenticato dal container
  264.         //esito.setClientAuthenticated(true); come per il basic, per poter essere autenticato bisogna verificare che sia registrato sulla base dati
  265.         esito.setCredential(identitaAutenticata);
  266.         
  267.         IDSoggetto idSoggetto = null;
  268.         try{
  269.             RegistroServiziManager registroServiziManager = datiInvocazione!=null ? RegistroServiziManager.getInstance(datiInvocazione.getState()) : RegistroServiziManager.getInstance();
  270.             idSoggetto = registroServiziManager.getIdSoggettoByCredenzialiApiKey(identitaAutenticata, password, this.appId, cryptConfigSoggetti, null); // all registry
  271.         }
  272.         catch(DriverRegistroServiziNotFound notFound){
  273.             OpenSPCoop2Logger.getLoggerOpenSPCoopCore().debug("AutenticazioneApiKey (appId:"+this.appId+") non ha trovato risultati",notFound);
  274.         }
  275.         catch(Exception e){
  276.             if(this.logError) {
  277.                 OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey (appId:"+this.appId+") non riuscita",e);
  278.             }
  279.             esito.setErroreCooperazione(IntegrationFunctionError.INTERNAL_REQUEST_ERROR, ErroriCooperazione.ERRORE_GENERICO_PROCESSAMENTO_MESSAGGIO.getErroreCooperazione());
  280.             esito.setClientIdentified(false);
  281.             esito.setEccezioneProcessamento(e);
  282.             return esito;
  283.         }
  284.         
  285.         IDServizioApplicativo idServizioApplicativo = null;
  286.         try {
  287.             if(idSoggetto==null && this.getProtocolFactory().createProtocolConfiguration().isSupportoAutenticazioneApplicativiErogazioni()) {
  288.                 ConfigurazionePdDManager configurazionePdDManager = datiInvocazione!=null ? ConfigurazionePdDManager.getInstance(datiInvocazione.getState()) : ConfigurazionePdDManager.getInstance();
  289.                 idServizioApplicativo = configurazionePdDManager.
  290.                         getIdServizioApplicativoByCredenzialiApiKey(identitaAutenticata, password, this.appId, cryptConfigApplicativi);
  291.                 if(idServizioApplicativo!=null) {
  292.                     if(idSoggetto==null) {
  293.                         idSoggetto = idServizioApplicativo.getIdSoggettoProprietario();
  294.                     }
  295.                     // Non ha senso poter identificare entrambi con le stesse credenziali
  296. //                  else if(idServizioApplicativo.getIdSoggettoProprietario().equals(idSoggetto)==false) {
  297. //                      throw new Exception("Identificato sia un soggetto che un applicativo. Il soggetto ["+idSoggetto+
  298. //                              "] identificato รจ differente dal proprietario dell'applicativo identificato ["+idServizioApplicativo.getIdSoggettoProprietario()+"]");
  299. //                  }
  300.                 }
  301.             }
  302.         }
  303.         catch(Exception e){
  304.             if(this.logError) {
  305.                 OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey (appId:"+this.appId+") (Applicativi) non riuscita",e);
  306.             }
  307.             esito.setErroreCooperazione(IntegrationFunctionError.INTERNAL_REQUEST_ERROR, ErroriCooperazione.ERRORE_GENERICO_PROCESSAMENTO_MESSAGGIO.getErroreCooperazione());
  308.             esito.setClientAuthenticated(false);
  309.             esito.setClientIdentified(false);
  310.             esito.setEccezioneProcessamento(e);
  311.             return esito;
  312.         }
  313.         
  314.         if(idSoggetto == null){
  315.             esito.setErroreCooperazione(IntegrationFunctionError.AUTHENTICATION_INVALID_CREDENTIALS, ErroriCooperazione.AUTENTICAZIONE_FALLITA_CREDENZIALI_FORNITE_NON_CORRETTE.getErroreCooperazione());
  316.             esito.setClientAuthenticated(false);
  317.             esito.setClientIdentified(false);
  318.             if(wwwAuthenticateConfig!=null) {
  319.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_invalid());
  320.             }
  321.             return esito;
  322.         }
  323.         else {
  324.             esito.setClientAuthenticated(true);
  325.             esito.setClientIdentified(true);
  326.             esito.setIdSoggetto(idSoggetto);
  327.             esito.setIdServizioApplicativo(idServizioApplicativo);
  328.         }
  329.         
  330.         return esito;
  331.         
  332.     }

  334.     @Override
  335.     public void cleanPostAuth(OpenSPCoop2Message message) throws AutenticazioneException {
  336.         
  337.         AutenticazioneUtils.finalizeProcessApiKey(message, 
  338.                 this.header, this.cookie, this.queryParameter, 
  339.                 this.nomeHeaderApiKey, this.nomeCookieApiKey, this.nomeQueryParameterApiKey, 
  340.                 this.cleanApiKey); 
  341.         
  342.         if(this.appId) {
  343.             AutenticazioneUtils.finalizeProcessApiKey(message, 
  344.                     this.header, this.cookie, this.queryParameter, 
  345.                     this.nomeHeaderAppId, this.nomeCookieAppId, this.nomeQueryParameterAppId, 
  346.                     this.cleanAppId); 
  347.         }
  348.         
  349.     }
  350. }
Created with JaCoCo 0.8.8.202204050719