BasicNegoziazioneTokenParser.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.pdd.core.token.parser;

  22. import java.io.Serializable;
  23. import java.util.ArrayList;
  24. import java.util.Date;
  25. import java.util.List;
  26. import java.util.Map;
  27. import java.util.Properties;

  29. import org.apache.commons.lang.StringUtils;
  30. import org.openspcoop2.pdd.core.token.Costanti;
  31. import org.openspcoop2.pdd.core.token.TokenUtilities;
  32. import org.openspcoop2.utils.UtilsException;
  33. import org.openspcoop2.utils.date.DateManager;

  35. /**     
  36.  * BasicTokenParser
  37.  *
  38.  * @author Poli Andrea (poli@link.it)
  39.  * @author $Author$
  40.  * @version $Rev$, $Date$
  41.  */
  42. public class BasicNegoziazioneTokenParser implements INegoziazioneTokenParser {

  44.     protected Integer httpResponseCode;
  45.     protected String raw;
  46.     protected Map<String, Serializable> claims;
  47.     protected TipologiaClaimsNegoziazione parser;
  48.     protected Properties parserConfig;
  49.     protected Date now;
  50.     
  51.     public BasicNegoziazioneTokenParser(TipologiaClaimsNegoziazione parser) {
  52.         this(parser, null);
  53.     }
  54.     public BasicNegoziazioneTokenParser(TipologiaClaimsNegoziazione parser, Properties parserConfig) {
  55.         this.parser = parser;
  56.         this.parserConfig = parserConfig;
  57.     }
  58.     
  59.     @Override
  60.     public void init(String raw, Map<String, Serializable> claims) {
  61.         this.raw = raw;
  62.         this.claims = claims;
  63.         this.now = DateManager.getDate();
  64.     }

  66.     
  67.     @Override
  68.     public void checkHttpTransaction(Integer httpResponseCode) throws UtilsException{
  69.         this.httpResponseCode = httpResponseCode;
  70.         switch (this.parser) {
  71.         case OAUTH2_RFC_6749:
  72.         case MAPPING:
  73.         case RAW:
  74.         case CUSTOM:
  75.             if(this.httpResponseCode!=null && 
  76.                 (this.httpResponseCode.intValue() < 200 || this.httpResponseCode.intValue()>299)) {
  77.                 String msgError = "Connessione terminata con errore (codice trasporto: "+this.httpResponseCode.intValue()+")";
  78.                 throw new UtilsException(msgError+": "+this.raw);
  79.             }
  80.             break;
  81.         }
  82.     }
  83.     
  84.     @Override
  85.     public boolean isValid() {
  86.         
  87.         if(TipologiaClaimsNegoziazione.RAW.equals(this.parser)) {
  88.             if(this.raw==null || StringUtils.isEmpty(this.raw)) {
  89.                 return false;
  90.             }
  91.         }
  92.         else {
  93.             if(this.claims==null || this.claims.size()<=0) {
  94.                 return false;
  95.             }
  96.         }
  97.         
  98.         switch (this.parser) {
  99.         case OAUTH2_RFC_6749:
  100.             String claim = TokenUtilities.getClaimAsString(this.claims,ClaimsNegoziazione.OAUTH2_RFC_6749_ACCESS_TOKEN);
  101.             return !StringUtils.isEmpty(claim);
  102.         case MAPPING:
  103.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_ACCESS_TOKEN);
  104.             if(claimNames==null || claimNames.isEmpty()) {
  105.                 return false;
  106.             }
  107.             claim = TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  108.             return !StringUtils.isEmpty(claim);
  109.         case RAW:
  110.         case CUSTOM:
  111.             return true;
  112.         }
  113.         
  114.         return false;
  115.     }
  116.     
  117.     
  118.     @Override
  119.     public String getAccessToken() {
  120.         switch (this.parser) {
  121.         case OAUTH2_RFC_6749:
  122.             String claim = TokenUtilities.getClaimAsString(this.claims,ClaimsNegoziazione.OAUTH2_RFC_6749_ACCESS_TOKEN);
  123.             return claim;
  124.         case MAPPING:
  125.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_ACCESS_TOKEN);
  126.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  127.         case RAW:
  128.             return this.raw;
  129.         case CUSTOM:
  130.             return null;
  131.         }
  132.         return null;
  133.     }

  135.     @Override
  136.     public String getRefreshToken() {
  137.         switch (this.parser) {
  138.         case OAUTH2_RFC_6749:
  139.             String claim = TokenUtilities.getClaimAsString(this.claims,ClaimsNegoziazione.OAUTH2_RFC_6749_REFRESH_TOKEN);
  140.             return claim;
  141.         case MAPPING:
  142.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_REFRESH_TOKEN);
  143.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  144.         case RAW:
  145.         case CUSTOM:
  146.             return null;
  147.         }
  148.         return null;
  149.     }

  151.     @Override
  152.     public String getTokenType() {
  153.         switch (this.parser) {
  154.         case OAUTH2_RFC_6749:
  155.             String claim = TokenUtilities.getClaimAsString(this.claims,ClaimsNegoziazione.OAUTH2_RFC_6749_TOKEN_TYPE);
  156.             return claim;
  157.         case MAPPING:
  158.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_TOKEN_TYPE);
  159.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  160.         case RAW:
  161.         case CUSTOM:
  162.             return null;
  163.         }
  164.         return null;
  165.     }
  166.     
  167.     @Override
  168.     public Date getExpired() {
  169.         String tmpIn = null;
  170.         String tmpOn = null;
  171.         switch (this.parser) {
  172.         case OAUTH2_RFC_6749:{
  173.             tmpIn =  TokenUtilities.getClaimAsString(this.claims,ClaimsNegoziazione.OAUTH2_RFC_6749_EXPIRES_IN);
  174.             if(tmpIn==null || StringUtils.isEmpty(tmpIn)) {
  175.                 tmpOn =  TokenUtilities.getClaimAsString(this.claims,ClaimsNegoziazione.AZURE_EXPIRES_ON);
  176.             }
  177.             break;
  178.         }
  179.         case MAPPING:{
  180.             tmpIn = parseMappingExpiresIn();
  181.             if(tmpIn==null || StringUtils.isEmpty(tmpIn)) {
  182.                 tmpOn = parseMappingExpiresOn();
  183.             }
  184.             break;
  185.         }
  186.         case RAW:{
  187.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_EXPIRES_IN_SECONDS);
  188.             if(claimNames!=null && !claimNames.isEmpty()) {
  189.                 tmpIn = claimNames.get(0);
  190.             }
  191.             break;
  192.         }
  193.         case CUSTOM:
  194.             return null;
  195.         }
  196.         
  197.         return parseDate(tmpIn, tmpOn);
  198.     }
  199.     private String parseMappingExpiresIn() {
  200.         List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_EXPIRES_IN);
  201.         if(claimNames!=null && !claimNames.isEmpty()) {
  202.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  203.         }
  204.         return null;
  205.     }
  206.     private String parseMappingExpiresOn() {
  207.         List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_EXPIRES_ON);
  208.         if(claimNames!=null && !claimNames.isEmpty()) {
  209.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  210.         }
  211.         return null;
  212.     }

  214.     
  215.     @Override
  216.     public Date getRefreshExpired() {
  217.         String tmpIn = null;
  218.         String tmpOn = null;
  219.         switch (this.parser) {
  220.         case OAUTH2_RFC_6749:
  221.             tmpIn = parseOauth2RFC6749RefreshExpiresIn();
  222.             if(tmpIn==null || StringUtils.isEmpty(tmpIn)) {
  223.                 tmpOn = parseOauth2RFC6749RefreshExpiresOn();
  224.             }
  225.             break;
  226.             
  227.         case MAPPING:
  228.             tmpIn = parseMappingRefreshExpiresIn();
  229.             if(tmpIn==null || StringUtils.isEmpty(tmpIn)) {
  230.                 tmpOn = parseMappingRefreshExpiresOn();
  231.             }
  232.             break;
  233.             
  234.         case RAW:
  235.         case CUSTOM:
  236.             return null;
  237.         }
  238.         
  239.         return parseDate(tmpIn, tmpOn);
  240.     }
  241.     private String parseOauth2RFC6749RefreshExpiresIn() {
  242.         for (String claim : ClaimsNegoziazione.REFRESH_EXPIRE_IN_CUSTOM_CLAIMS) {
  243.             String tmpC =  TokenUtilities.getClaimAsString(this.claims, claim);
  244.             if(tmpC!=null && StringUtils.isNotEmpty(tmpC)) {
  245.                 return tmpC;
  246.             }
  247.         }
  248.         return null;
  249.     }
  250.     private String parseOauth2RFC6749RefreshExpiresOn() {
  251.         for (String claim : ClaimsNegoziazione.REFRESH_EXPIRE_ON_CUSTOM_CLAIMS) {
  252.             String tmpC =  TokenUtilities.getClaimAsString(this.claims, claim);
  253.             if(tmpC!=null && StringUtils.isNotEmpty(tmpC)) {
  254.                 return tmpC;
  255.             }
  256.         }
  257.         return null;
  258.     }
  259.     private String parseMappingRefreshExpiresIn() {
  260.         List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_REFRESH_EXPIRES_IN);
  261.         if(claimNames!=null && !claimNames.isEmpty()) {
  262.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  263.         }
  264.         return null;
  265.     }
  266.     private String parseMappingRefreshExpiresOn() {
  267.         List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_REFRESH_EXPIRES_ON);
  268.         if(claimNames!=null && !claimNames.isEmpty()) {
  269.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  270.         }
  271.         return null;
  272.     }
  273.     
  274.     
  275.     private Date parseDate(String tmpIn, String tmpOn) {
  276.         if(tmpIn!=null) {
  277.             // The lifetime in seconds of the access token.  For example, the value "3600" denotes that the access token will
  278.             // expire in one hour from the time the response was generated.
  279.             return TokenUtils.convertLifeTimeInSeconds(this.now, tmpIn);
  280.         }
  281.         
  282.         // provo a vedere se ci fosse un claim che indica la data di scadenza in forma https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4
  283.         if(tmpOn!=null) {
  284.             return TokenUtils.parseTimeInSecond(tmpOn);
  285.         }
  286.         
  287.         return null;
  288.     }



  292.     @Override
  293.     public List<String> getScopes() {
  294.         
  295.         String tmpScopes = null;
  296.         if(TipologiaClaimsNegoziazione.OAUTH2_RFC_6749.equals(this.parser)) {
  297.             tmpScopes = TokenUtilities.getClaimAsString(this.claims,ClaimsNegoziazione.OAUTH2_RFC_6749_SCOPE);
  298.         }
  299.         else if(TipologiaClaimsNegoziazione.MAPPING.equals(this.parser)) {
  300.             return readMappingScopes();
  301.         }
  302.         
  303.         return readScope(tmpScopes);
  304.     }
  305.     public List<String> readMappingScopes() {
  306.         List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.RETRIEVE_TOKEN_PARSER_SCOPE);
  307.         List<String> tmpScopesList = TokenUtilities.getFirstClaimAsList(this.claims, claimNames);
  308.         List<String> lNull = null;
  309.         if(tmpScopesList!=null && !tmpScopesList.isEmpty()) {
  310.             return readMappingScopes(tmpScopesList);
  311.         }
  312.         else {
  313.             return lNull;
  314.         }
  315.     }
  316.     public List<String> readMappingScopes(List<String> tmpScopesList) {
  317.         List<String> scopes = new ArrayList<>();
  318.         for (String s : tmpScopesList) {
  319.             List<String> tmp = readScope(s);
  320.             if(tmp!=null && !tmp.isEmpty()) {
  321.                 for (String sTmp : tmp) {
  322.                     if(!scopes.contains(sTmp)) {
  323.                         scopes.add(sTmp);
  324.                     }
  325.                 }
  326.             }
  327.         }
  328.         return scopes;
  329.     }
  330.     
  331.     private List<String> readScope(String tmpScopes) {
  332.         List<String> lNull = null;
  333.         if(tmpScopes!=null) {
  334.             String [] tmpArray = tmpScopes.split(" ");
  335.             if(tmpArray!=null && tmpArray.length>0) {
  336.                 List<String> scopes = new ArrayList<>();
  337.                 for (int i = 0; i < tmpArray.length; i++) {
  338.                     scopes.add(tmpArray[i].trim());
  339.                 }
  340.                 return scopes;
  341.             }
  342.         }
  343.         return lNull;
  344.     }
  345.     
  346. }
Created with JaCoCo 0.8.8.202204050719