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.pd;

  25. import org.openspcoop2.core.id.IDServizioApplicativo;
  26. import org.openspcoop2.core.id.IDSoggetto;
  27. import org.openspcoop2.message.OpenSPCoop2Message;
  28. import org.openspcoop2.pdd.config.ConfigurazionePdDManager;
  29. import org.openspcoop2.pdd.config.OpenSPCoop2Properties;
  30. import org.openspcoop2.pdd.core.autenticazione.ApiKeyUtilities;
  31. import org.openspcoop2.pdd.core.autenticazione.AutenticazioneException;
  32. import org.openspcoop2.pdd.core.autenticazione.AutenticazioneUtils;
  33. import org.openspcoop2.pdd.core.autenticazione.ParametriAutenticazione;
  34. import org.openspcoop2.pdd.core.autenticazione.ParametriAutenticazioneApiKey;
  35. import org.openspcoop2.pdd.core.autenticazione.WWWAuthenticateConfig;
  36. import org.openspcoop2.pdd.logger.OpenSPCoop2Logger;
  37. import org.openspcoop2.protocol.sdk.constants.CodiceErroreIntegrazione;
  38. import org.openspcoop2.protocol.sdk.constants.CostantiProtocollo;
  39. import org.openspcoop2.protocol.sdk.constants.ErroriIntegrazione;
  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);

  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(DatiInvocazionePortaDelegata datiInvocazione) {
  129.         if(datiInvocazione==null) {
  130.             return null;
  131.         }
  132.         try {
  133.             String apiKey = ApiKeyUtilities.getKey(true, this.header, this.cookie, this.queryParameter, 
  134.                     this.nomeHeaderApiKey, this.nomeCookieApiKey, this.nomeQueryParameterApiKey, 
  135.                     datiInvocazione.getInfoConnettoreIngresso(), this.getPddContext(), false,
  136.                     new StringBuilder());
  137.             if(apiKey==null) {
  138.                 return null;
  139.             }
  140.             if(this.appId) {
  141.                 String appId = ApiKeyUtilities.getKey(false, this.header, this.cookie, this.queryParameter, 
  142.                         this.nomeHeaderAppId, this.nomeCookieAppId, this.nomeQueryParameterAppId, 
  143.                         datiInvocazione.getInfoConnettoreIngresso(), this.getPddContext(), false,
  144.                         new StringBuilder());
  145.                 if(appId==null) {
  146.                     return null;
  147.                 }
  148.                 return "multipleApiKey-"+appId+"."+apiKey;
  149.             }
  150.             else {
  151.                 return "apiKey-"+apiKey;
  152.             }
  153.         }catch(Exception e) {
  154.             return null;
  155.         }
  156.     }
  157.     
  158.     @Override
  159.     public EsitoAutenticazionePortaDelegata process(DatiInvocazionePortaDelegata datiInvocazione) throws AutenticazioneException{

  161.         EsitoAutenticazionePortaDelegata esito = new EsitoAutenticazionePortaDelegata();
  162.         
  163.         IDSoggetto soggettoFruitore = null;
  164.         if(datiInvocazione!=null && datiInvocazione.getPd()!=null) {
  165.             soggettoFruitore = new IDSoggetto(datiInvocazione.getPd().getTipoSoggettoProprietario(), datiInvocazione.getPd().getNomeSoggettoProprietario());
  166.         }
  167.         
  168.         StringBuilder fullCredential= new StringBuilder();
  169.         
  170.         OpenSPCoop2Properties op2Properties = OpenSPCoop2Properties.getInstance();
  171.         WWWAuthenticateConfig wwwAuthenticateConfig = op2Properties.getRealmAutenticazioneApiKeyWWWAuthenticateConfig();
  172.         
  173.         // Controllo apiKey fornite
  174.         String apiKey = null;
  175.         try {
  176.             apiKey = ApiKeyUtilities.getKey(true, this.header, this.cookie, this.queryParameter, 
  177.                     this.nomeHeaderApiKey, this.nomeCookieApiKey, this.nomeQueryParameterApiKey, 
  178.                     datiInvocazione!=null ? datiInvocazione.getInfoConnettoreIngresso() : null, this.getPddContext(), true,
  179.                     fullCredential); 
  180.         }catch(Exception e) {
  181.             if(this.logError) {
  182.                 OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey non riuscita",e);
  183.             }
  184.             esito.setErroreIntegrazione(IntegrationFunctionError.AUTHENTICATION_CREDENTIALS_NOT_FOUND, ErroriIntegrazione.ERRORE_402_AUTENTICAZIONE_FALLITA.getErrore402_AutenticazioneFallitaPrincipal(CostantiProtocollo.CREDENZIALI_NON_FORNITE,apiKey));
  185.             esito.setClientAuthenticated(false);
  186.             esito.setClientIdentified(false);
  187.             if(wwwAuthenticateConfig!=null) {
  188.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_notFound());
  189.             }
  190.             return esito;
  191.         }
  192.         if( apiKey==null || "".equals(apiKey) ){
  193.             esito.setErroreIntegrazione(IntegrationFunctionError.AUTHENTICATION_CREDENTIALS_NOT_FOUND, ErroriIntegrazione.ERRORE_402_AUTENTICAZIONE_FALLITA.getErrore402_AutenticazioneFallitaPrincipal(CostantiProtocollo.CREDENZIALI_NON_FORNITE,apiKey));
  194.             esito.setClientAuthenticated(false);
  195.             esito.setClientIdentified(false);
  196.             if(wwwAuthenticateConfig!=null) {
  197.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_notFound());
  198.             }
  199.             return esito;
  200.         }
  201.         
  202.         String appId = null;
  203.         if(this.appId) {
  204.             try {
  205.                 appId = ApiKeyUtilities.getKey(false, this.header, this.cookie, this.queryParameter, 
  206.                         this.nomeHeaderAppId, this.nomeCookieAppId, this.nomeQueryParameterAppId, 
  207.                         datiInvocazione!=null ? datiInvocazione.getInfoConnettoreIngresso() : null, this.getPddContext(), true,
  208.                         fullCredential);
  209.             }catch(Exception e) {
  210.                 if(this.logError) {
  211.                     OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey (AppId) non riuscita",e);
  212.                 }
  213.                 esito.setErroreIntegrazione(IntegrationFunctionError.AUTHENTICATION_CREDENTIALS_NOT_FOUND, ErroriIntegrazione.ERRORE_402_AUTENTICAZIONE_FALLITA.getErrore402_AutenticazioneFallitaPrincipal(CostantiProtocollo.CREDENZIALI_NON_FORNITE,appId));
  214.                 esito.setClientAuthenticated(false);
  215.                 esito.setClientIdentified(false);
  216.                 esito.setFullCredential(fullCredential.toString());
  217.                 if(wwwAuthenticateConfig!=null) {
  218.                     esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_notFound());
  219.                 }
  220.                 return esito;
  221.             }
  222.             if( appId==null || "".equals(appId) ){
  223.                 esito.setErroreIntegrazione(IntegrationFunctionError.AUTHENTICATION_CREDENTIALS_NOT_FOUND, ErroriIntegrazione.ERRORE_402_AUTENTICAZIONE_FALLITA.getErrore402_AutenticazioneFallitaPrincipal(CostantiProtocollo.CREDENZIALI_NON_FORNITE,appId));
  224.                 esito.setClientAuthenticated(false);
  225.                 esito.setClientIdentified(false);
  226.                 esito.setFullCredential(fullCredential.toString());
  227.                 if(wwwAuthenticateConfig!=null) {
  228.                     esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_notFound());
  229.                 }
  230.                 return esito;
  231.             }
  232.         }
  233.         
  234.         // per conoscere la credenziale passata anche in caso di autenticazione fallita
  235.         esito.setFullCredential(fullCredential.toString());
  236.         
  237.         String identitaAutenticata = null;
  238.         String password = null;
  239.         try {
  240.             if(this.appId) {
  241.                 identitaAutenticata = appId;
  242.                 password = ApiKeyUtilities.decodeMultipleApiKey(apiKey);
  243.             }
  244.             else {
  245.                 String [] decodedApiKey = ApiKeyUtilities.decodeApiKey(apiKey);
  246.                 identitaAutenticata = decodedApiKey[0];
  247.                 password = decodedApiKey[1];
  248.             }
  249.         }catch(Exception e) {
  250.             if(this.logError) {
  251.                 OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey (appId:"+this.appId+") fallita",e);
  252.             }
  253.             esito.setErroreIntegrazione(IntegrationFunctionError.AUTHENTICATION_INVALID_CREDENTIALS, ErroriIntegrazione.ERRORE_402_AUTENTICAZIONE_FALLITA.getErrore402_AutenticazioneFallitaBasic(CostantiProtocollo.CREDENZIALI_FORNITE_NON_CORRETTE,identitaAutenticata,apiKey));
  254.             esito.setClientAuthenticated(false);
  255.             esito.setClientIdentified(false);
  256.             if(wwwAuthenticateConfig!=null) {
  257.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_invalid());
  258.             }
  259.             return esito;
  260.         }
  261.                 
  262.         CryptConfig cryptConfigApplicativi = op2Properties.getCryptConfigAutenticazioneApplicativi();
  263.                     
  264.         // !NO!: Essendoci il principal del chiamante, il client e' stato autenticato dal container
  265.         //esito.setClientAuthenticated(true); come per il basic, per poter essere autenticato bisogna verificare che sia registrato sulla base dati
  266.         esito.setCredential(identitaAutenticata);
  267.         
  268.         IDServizioApplicativo idServizioApplicativo = null;
  269.         try{
  270.             ConfigurazionePdDManager configurazionePdDManager = datiInvocazione!=null ? ConfigurazionePdDManager.getInstance(datiInvocazione.getState()) : ConfigurazionePdDManager.getInstance();
  271.             idServizioApplicativo = configurazionePdDManager.
  272.                         getIdServizioApplicativoByCredenzialiApiKey(identitaAutenticata, password, this.appId, cryptConfigApplicativi);
  273.             if(idServizioApplicativo!=null && soggettoFruitore==null) {
  274.                 soggettoFruitore = idServizioApplicativo.getIdSoggettoProprietario();
  275.             }
  276.         }catch(Exception e){
  277.             if(this.logError) {
  278.                 OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("AutenticazioneApiKey (appId:"+this.appId+") non riuscita",e);
  279.             }
  280.             esito.setErroreIntegrazione(IntegrationFunctionError.INTERNAL_REQUEST_ERROR, ErroriIntegrazione.ERRORE_5XX_GENERICO_PROCESSAMENTO_MESSAGGIO.
  281.                     get5XX_ErroreProcessamento(CodiceErroreIntegrazione.CODICE_536_CONFIGURAZIONE_NON_DISPONIBILE));
  282.             esito.setClientIdentified(false);
  283.             esito.setEccezioneProcessamento(e);
  284.             return esito;
  285.         }
  286.         
  287.         if(idServizioApplicativo == null){
  288.             esito.setErroreIntegrazione(IntegrationFunctionError.AUTHENTICATION_INVALID_CREDENTIALS, ErroriIntegrazione.ERRORE_402_AUTENTICAZIONE_FALLITA.getErrore402_AutenticazioneFallitaBasic(CostantiProtocollo.CREDENZIALI_FORNITE_NON_CORRETTE,identitaAutenticata,apiKey));
  289.             esito.setClientAuthenticated(false);
  290.             esito.setClientAuthenticated(false);
  291.             esito.setClientIdentified(false);
  292.             if(wwwAuthenticateConfig!=null) {
  293.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_invalid());
  294.             }
  295.             return esito;
  296.         }
  297.         else if(idServizioApplicativo.getIdSoggettoProprietario().equals(soggettoFruitore)==false) {
  298.             esito.setErroreIntegrazione(IntegrationFunctionError.AUTHENTICATION_INVALID_CREDENTIALS, 
  299.                     ErroriIntegrazione.ERRORE_402_AUTENTICAZIONE_FALLITA.
  300.                         getErrore402_AutenticazioneFallitaBasic("soggetto proprietario ("+idServizioApplicativo.getIdSoggettoProprietario()+") dell'applicativo identificato ("+idServizioApplicativo.getNome()+") differente dal soggetto proprietario della porta invocata ("+soggettoFruitore+")",identitaAutenticata,apiKey));
  301.             esito.setClientAuthenticated(false);
  302.             esito.setClientAuthenticated(false);
  303.             esito.setClientIdentified(false);
  304.             if(wwwAuthenticateConfig!=null) {
  305.                 esito.setWwwAuthenticateErrorHeader(wwwAuthenticateConfig.buildWWWAuthenticateHeaderValue_invalid());
  306.             }
  307.             return esito;
  308.         }
  309.         else {
  310.             esito.setClientAuthenticated(true);
  311.             esito.setClientIdentified(true);
  312.             esito.setIdServizioApplicativo(idServizioApplicativo);
  313.         }
  314.         
  315.         return esito;
  316.         
  317.     }

  319.     @Override
  320.     public void cleanPostAuth(OpenSPCoop2Message message) throws AutenticazioneException {
  321.         
  322.         AutenticazioneUtils.finalizeProcessApiKey(message, 
  323.                 this.header, this.cookie, this.queryParameter, 
  324.                 this.nomeHeaderApiKey, this.nomeCookieApiKey, this.nomeQueryParameterApiKey, 
  325.                 this.cleanApiKey); 
  326.         
  327.         if(this.appId) {
  328.             AutenticazioneUtils.finalizeProcessApiKey(message, 
  329.                     this.header, this.cookie, this.queryParameter, 
  330.                     this.nomeHeaderAppId, this.nomeCookieAppId, this.nomeQueryParameterAppId, 
  331.                     this.cleanAppId); 
  332.         }
  333.         
  334.     }
  335. }
Created with JaCoCo 0.8.8.202204050719