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

  21. package org.openspcoop2.pdd.core.autenticazione;

  23. import java.util.List;

  25. import org.openspcoop2.core.config.ServizioApplicativo;
  26. import org.openspcoop2.core.config.driver.db.DriverConfigurazioneDB;
  27. import org.openspcoop2.core.id.IDServizioApplicativo;
  28. import org.openspcoop2.core.id.IDSoggetto;
  29. import org.openspcoop2.core.registry.Soggetto;
  30. import org.openspcoop2.core.registry.driver.db.DriverRegistroServiziDB;
  31. import org.openspcoop2.pdd.core.PdDContext;
  32. import org.openspcoop2.pdd.core.connettori.InfoConnettoreIngresso;
  33. import org.openspcoop2.utils.crypt.PasswordGenerator;
  34. import org.openspcoop2.utils.io.Base64Utilities;

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

  45.     public static String getKey(boolean apiKey,
  46.             boolean header, boolean cookie, boolean queryParameter, 
  47.             String nomeHeader, String nomeCookie, String nomeQueryParameter,
  48.             InfoConnettoreIngresso infoConnettore, PdDContext pddContext, boolean throwException,
  49.             StringBuilder fullCredential) throws AutenticazioneException {
  50.         
  51.         String tipo = apiKey ? "ApiKey" : "AppId";
  52.         
  53.         String key = null;
  54.         
  55.         // viene usato l'ordine della specifica
  56.         
  57.         if(queryParameter) {
  58.             if(nomeQueryParameter==null && throwException) {
  59.                 throw new AutenticazioneException("Nome del parametro della query, da cui estrarre l'"+tipo+", non indicato");
  60.             }
  61.             if(nomeQueryParameter!=null && infoConnettore!=null && infoConnettore.getUrlProtocolContext()!=null) {
  62.                 key = infoConnettore.getUrlProtocolContext().getParameterFirstValue(nomeQueryParameter);
  63.                 if(key!=null && "".equals(key.trim())) {
  64.                     key = null;
  65.                 }
  66.             }
  67.         }
  68.         if(key!=null) {
  69.             if(fullCredential.length()>0) {
  70.                 fullCredential.append("\n");
  71.             }
  72.             fullCredential.append(tipo).append(" (query) '").append(nomeQueryParameter);
  73.             if(!apiKey) { // l'api key non deve essere tracciata come per la password.
  74.                 fullCredential.append(": ").append(key);
  75.             }
  76.             fullCredential.append("'");
  77.             return key;
  78.         }
  79.         
  80.         if(header) {
  81.             if(nomeHeader==null && throwException) {
  82.                 throw new AutenticazioneException("Nome dell'header, da cui estrarre l'"+tipo+", non indicato");
  83.             }
  84.             if(nomeHeader!=null && infoConnettore!=null && infoConnettore.getUrlProtocolContext()!=null) {
  85.                 key = infoConnettore.getUrlProtocolContext().getHeaderFirstValue(nomeHeader);
  86.                 if(key!=null && "".equals(key.trim())) {
  87.                     key = null;
  88.                 }
  89.             }
  90.         }
  91.         if(key!=null) {
  92.             if(fullCredential.length()>0) {
  93.                 fullCredential.append("\n");
  94.             }
  95.             fullCredential.append(tipo).append(" (http) '").append(nomeHeader);
  96.             if(!apiKey) { // l'api key non deve essere tracciata come per la password.
  97.                 fullCredential.append(": ").append(key);
  98.             }
  99.             fullCredential.append("'");
  100.             return key;
  101.         }
  102.         
  103.         if(cookie) {
  104.             if(nomeCookie==null && throwException) {
  105.                 throw new AutenticazioneException("Nome del cookie, da cui estrarre l'"+tipo+", non indicato");
  106.             }
  107.             if(nomeCookie!=null && infoConnettore!=null && infoConnettore.getUrlProtocolContext()!=null) {
  108.                 key = infoConnettore.getUrlProtocolContext().getCookieValue(nomeCookie);
  109.                 if(key!=null && "".equals(key.trim())) {
  110.                     key = null;
  111.                 }
  112.             }
  113.         }
  114.         if(key!=null) {
  115.             if(fullCredential.length()>0) {
  116.                 fullCredential.append("\n");
  117.             }
  118.             fullCredential.append(tipo).append(" (cookie) '").append(nomeCookie);
  119.             if(!apiKey) { // l'api key non deve essere tracciata come per la password.
  120.                 fullCredential.append(": ").append(key);
  121.             }
  122.             fullCredential.append("'");
  123.             return key;
  124.         }
  125.         
  126.         if(throwException) {
  127.             throw new AutenticazioneException(tipo+" non presente nella richiesta");
  128.         }
  129.             
  130.         return null;
  131.     }
  132.     
  133.     private static final String SOGGETTO_SEPARATOR = ".";   
  134.     public static final String APPLICATIVO_SOGGETTO_SEPARATOR = "@";
  135.     private static final int MAX_ALREADY_EXISTS = 5000;
  136.     private static final String SEPARATOR_ALREADY_EXISTS = ".";
  137.     
  138.     public static String toAppId(String protocollo, IDSoggetto idSoggetto, boolean multipleApiKeys, DriverRegistroServiziDB driver) throws Exception {
  139.         String appId = _toAppId(protocollo, idSoggetto);
  140.         if(!_existsAppId(appId, multipleApiKeys, idSoggetto, driver)) {
  141.             return appId;
  142.         }
  143.         for (int i = 2; i < MAX_ALREADY_EXISTS; i++) {
  144.             IDSoggetto idSoggettoAlreadyExists = new IDSoggetto(idSoggetto.getTipo(), idSoggetto.getNome()+SEPARATOR_ALREADY_EXISTS+i);
  145.             String appIdAlreadyExists = _toAppId(protocollo, idSoggettoAlreadyExists);
  146.             if(!_existsAppId(appIdAlreadyExists, multipleApiKeys, idSoggetto, driver)) {
  147.                 return appIdAlreadyExists;
  148.             }
  149.         }
  150.         throw new Exception("Generazione appId univoco non riuscita dopo "+MAX_ALREADY_EXISTS+" tentativi");
  151.     }
  152.     private static String _toAppId(String protocollo, IDSoggetto idSoggetto) throws Exception {
  153.         // non va bene perchè due nomi uguali di due protocolli differenti, vengono identici.
  154.         //return org.openspcoop2.protocol.engine.utils.NamingUtils.getLabelSoggetto(protocollo, idSoggetto.getTipo(), idSoggetto.getNome());    
  155.         if(idSoggetto==null || idSoggetto.getTipo()==null || idSoggetto.getNome()==null) {
  156.             throw new Exception("Identificativo soggetto non definito");
  157.         }
  158.         return idSoggetto.getNome()+SOGGETTO_SEPARATOR+idSoggetto.getTipo();
  159.     }
  160.     private static boolean _existsAppId(String appId, boolean multipleApiKeys, IDSoggetto idSoggetto, DriverRegistroServiziDB driver) throws Exception {
  161.         Soggetto soggetto = driver.soggettoWithCredenzialiApiKey(appId, multipleApiKeys);
  162.         if(soggetto==null) {
  163.             return false;
  164.         }
  165.         boolean isSame = false;
  166.         if(soggetto.getTipo().equals(idSoggetto.getTipo()) &&
  167.                 soggetto.getNome().equals(idSoggetto.getNome()) ) {
  168.             isSame = true;
  169.         }
  170.         return !isSame;
  171.     }
  172.     
  173.     public static String toAppId(String protocollo, IDServizioApplicativo idSA, boolean multipleApiKeys, DriverConfigurazioneDB driver) throws Exception {
  174.         String appId = _toAppId(protocollo, idSA.getNome(), idSA.getIdSoggettoProprietario());
  175.         if(!_existsAppId(appId, multipleApiKeys, idSA, driver)) {
  176.             return appId;
  177.         }
  178.         for (int i = 2; i < MAX_ALREADY_EXISTS; i++) {
  179.             String appIdAlreadyExists = _toAppId(protocollo, idSA.getNome()+SEPARATOR_ALREADY_EXISTS+i, idSA.getIdSoggettoProprietario());
  180.             if(!_existsAppId(appIdAlreadyExists, multipleApiKeys, idSA, driver)) {
  181.                 return appIdAlreadyExists;
  182.             }
  183.         }
  184.         throw new Exception("Generazione appId univoco non riuscita dopo "+MAX_ALREADY_EXISTS+" tentativi");
  185.     }
  186.     private static String _toAppId(String protocollo, String nomeSA, IDSoggetto idSoggetto) throws Exception {
  187.         return nomeSA+APPLICATIVO_SOGGETTO_SEPARATOR+ _toAppId(protocollo, idSoggetto);
  188.     }
  189.     private static boolean _existsAppId(String appId, boolean multipleApiKeys,  IDServizioApplicativo idSA, DriverConfigurazioneDB driver) throws Exception {
  190.         List<ServizioApplicativo> saList = driver.servizioApplicativoWithCredenzialiApiKeyList(appId, multipleApiKeys);
  191.         if (saList==null || saList.isEmpty()) {
  192.             return false;
  193.         }
  194.         boolean isSame = false;
  195.         for (ServizioApplicativo servizioApplicativo : saList) {
  196.             if(!servizioApplicativo.getNome().equals(idSA.getNome())) {
  197.                 continue;
  198.             }
  199.             if(!servizioApplicativo.getTipoSoggettoProprietario().equals(idSA.getIdSoggettoProprietario().getTipo())) {
  200.                 continue;
  201.             }
  202.             if(!servizioApplicativo.getNomeSoggettoProprietario().equals(idSA.getIdSoggettoProprietario().getNome())) {
  203.                 continue;
  204.             }
  205.             isSame = true;
  206.             break;
  207.         }
  208.         return !isSame;
  209.     }
  210.             
  211.     private static final String PREFIX_SEPARATOR_API_KEY = ".";
  212.     private static final String PREFIX_SEPARATOR_API_KEY_REGEXP = "\\.";
  213.     
  214.     private static String getPrefixForApiKey(String protocollo, IDSoggetto idSoggetto, DriverRegistroServiziDB driver) throws Exception {
  215.         boolean multipleApiKeys = false;
  216.         String appId = toAppId(protocollo, idSoggetto, multipleApiKeys, driver);
  217.         return Base64Utilities.encodeAsString(appId.getBytes())+PREFIX_SEPARATOR_API_KEY;
  218.     }
  219.     public static ApiKey newApiKey(String protocollo, IDSoggetto idSoggetto, int length, DriverRegistroServiziDB driver) throws Exception {
  220.         ApiKey apiKey = new ApiKey();
  221.         String password = getPassword(length);
  222.         String apiKeyToken = getPrefixForApiKey(protocollo, idSoggetto, driver)+Base64Utilities.encodeAsString(password.getBytes());
  223.         apiKey.setApiKey(apiKeyToken);
  224.         apiKey.setPassword(password);
  225.         return apiKey;
  226.     }
  227.     
  228.     private static String getPrefixForApiKey(String protocollo, IDServizioApplicativo idSA, DriverConfigurazioneDB driver) throws Exception {
  229.         boolean multipleApiKeys = false;
  230.         String appId = toAppId(protocollo, idSA, multipleApiKeys, driver);
  231.         return Base64Utilities.encodeAsString(appId.getBytes())+PREFIX_SEPARATOR_API_KEY;
  232.     }
  233.     public static ApiKey newApiKey(String protocollo, IDServizioApplicativo idSA, int length, DriverConfigurazioneDB driver) throws Exception {
  234.         ApiKey apiKey = new ApiKey();
  235.         String password = getPassword(length);
  236.         String apiKeyToken = getPrefixForApiKey(protocollo, idSA, driver)+Base64Utilities.encodeAsString(password.getBytes());
  237.         apiKey.setApiKey(apiKeyToken);
  238.         apiKey.setPassword(password);
  239.         return apiKey;
  240.     }
  241.     
  242.     public static String encodeApiKey(String appId, String password) throws Exception {
  243.         return Base64Utilities.encodeAsString(appId.getBytes())+
  244.             PREFIX_SEPARATOR_API_KEY+
  245.             Base64Utilities.encodeAsString(password.getBytes());
  246.     }
  247.     
  248.     public static String[] decodeApiKey(String apiKeyBase64) throws Exception {
  249.         if(!apiKeyBase64.contains(PREFIX_SEPARATOR_API_KEY)) {
  250.             throw new Exception("Formato non corretto");
  251.         }
  252.         String [] tmp = apiKeyBase64.split(PREFIX_SEPARATOR_API_KEY_REGEXP);
  253.         if(tmp==null || tmp.length!=2){
  254.             throw new Exception("Formato non corretto (.)");
  255.         }
  256.         try {
  257.             tmp[0] = new String(Base64Utilities.decode(tmp[0]));
  258.         }catch(Exception e) {
  259.             throw new Exception("Formato non corretto (appId)",e);
  260.         }
  261.         try {
  262.             tmp[1] = new String(Base64Utilities.decode(tmp[1]));
  263.         }catch(Exception e) {
  264.             throw new Exception("Formato non corretto (appKey)",e);
  265.         }
  266.         return tmp;
  267.     }
  268.     
  269.     
  270.     public static ApiKey newMultipleApiKey(int length) throws Exception {
  271.         ApiKey apiKey = new ApiKey();
  272.         String password = getPassword(length);
  273.         String apiKeyToken = encodeMultipleApiKey(password);
  274.         apiKey.setApiKey(apiKeyToken);
  275.         apiKey.setPassword(password);
  276.         return apiKey;
  277.     }
  278.     
  279.     public static String decodeMultipleApiKey(String apiKeyBase64) throws Exception {
  280.         return new String(Base64Utilities.decode(apiKeyBase64));
  281.     }
  282.     public static String encodeMultipleApiKey(String password) throws Exception {
  283.         return Base64Utilities.encodeAsString(password.getBytes());
  284.     }
  285.     
  286.     private static String getPassword(int length) throws Exception {
  287.         PasswordGenerator pwdGenerator = PasswordGenerator.DEFAULT;
  288.         return pwdGenerator.generate(length);
  289.     }
  290. }
Created with JaCoCo 0.8.8.202204050719