BasicTokenParser.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.openspcoop2.pdd.core.token.Costanti;
  30. import org.openspcoop2.pdd.core.token.TokenUtilities;
  31. import org.openspcoop2.utils.UtilsException;

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

  42.     protected Integer httpResponseCode;
  43.     protected String raw;
  44.     protected Map<String, Serializable> claims;
  45.     protected TipologiaClaims parser;
  46.     protected Properties parserConfig;
  47.     protected ITokenUserInfoParser userInfoParser;
  48.     
  49.     public BasicTokenParser(TipologiaClaims parser) {
  50.         this(parser, null);
  51.     }
  52.     public BasicTokenParser(TipologiaClaims parser, Properties parserConfig) {
  53.         this.parser = parser;
  54.         this.parserConfig = parserConfig;
  55.         this.userInfoParser = new BasicTokenUserInfoParser(parser, this.parserConfig);
  56.     }
  57.     
  58.     @Override
  59.     public void init(String raw, Map<String, Serializable> claims) {
  60.         this.raw = raw;
  61.         this.claims = claims;
  62.         this.userInfoParser.init(raw, claims);
  63.     }
  64.     
  65.     @Override
  66.     public void checkHttpTransaction(Integer httpResponseCode) throws UtilsException{
  67.         this.httpResponseCode = httpResponseCode;
  68.         switch (this.parser) {
  69.         case INTROSPECTION_RESPONSE_RFC_7662:
  70.         case JSON_WEB_TOKEN_RFC_7519:
  71.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  72.         case OIDC_ID_TOKEN:
  73.         case MAPPING:
  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.         case GOOGLE:
  82.             if(this.httpResponseCode!=null &&
  83.                 (this.httpResponseCode.intValue() == 400 || this.httpResponseCode.intValue()==401) &&
  84.                 (this.claims!=null && this.claims.size()>0) 
  85.                 ){
  86.                 String tmp = TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_ERROR);
  87.                 if(tmp==null) {
  88.                     tmp = TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_ERROR_DESCRIPTION);
  89.                 }
  90.                 if(tmp!=null) {
  91.                     return;
  92.                 }   
  93.             }
  94.             if(this.httpResponseCode!=null && 
  95.                 (this.httpResponseCode.intValue() < 200 || this.httpResponseCode.intValue()>299)) {
  96.                 String msgError = "Connessione terminata con errore (codice trasporto: "+this.httpResponseCode.intValue()+")";
  97.                 throw new UtilsException(msgError+": "+this.raw);
  98.             }
  99.             break;
  100.         }
  101.     }
  102.     
  103.     @Override
  104.     public boolean isValid() {
  105.         
  106.         if(this.claims==null || this.claims.size()<=0) {
  107.             return false;
  108.         }
  109.         
  110.         switch (this.parser) {
  111.         case INTROSPECTION_RESPONSE_RFC_7662:
  112.             String claim = TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_ACTIVE);
  113.             return Boolean.valueOf(claim);
  114.         case JSON_WEB_TOKEN_RFC_7519:
  115.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  116.         case OIDC_ID_TOKEN:
  117.         case MAPPING:
  118.         case CUSTOM:
  119.             return true;
  120.         case GOOGLE:
  121.             if(this.httpResponseCode==null) {
  122.                 return true;
  123.             }
  124.             else {
  125.                 if(this.httpResponseCode.intValue() == 400 || this.httpResponseCode.intValue()==401) {
  126.                     String tmp = TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_ERROR);
  127.                     if(tmp==null) {
  128.                         tmp = TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_ERROR_DESCRIPTION);
  129.                     }
  130.                     if(tmp!=null) {
  131.                         return false;
  132.                     }
  133.                 }
  134.             }
  135.         }
  136.         return true;
  137.     }
  138.     
  139.     @Override
  140.     public String getIssuer() {
  141.         switch (this.parser) {
  142.         case JSON_WEB_TOKEN_RFC_7519:
  143.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  144.             return TokenUtilities.getClaimAsString(this.claims,Claims.JSON_WEB_TOKEN_RFC_7519_ISSUER);
  145.         case INTROSPECTION_RESPONSE_RFC_7662:
  146.             return TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_ISSUER);
  147.         case OIDC_ID_TOKEN:
  148.             return TokenUtilities.getClaimAsString(this.claims,Claims.OIDC_ID_TOKEN_ISSUER);
  149.         case GOOGLE:
  150.             return TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_ISSUER);
  151.         case MAPPING:
  152.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_ISSUER);
  153.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  154.         case CUSTOM:
  155.             return null;
  156.         }
  157.         return null;
  158.     }

  160.     @Override
  161.     public String getSubject() {
  162.         switch (this.parser) {
  163.         case JSON_WEB_TOKEN_RFC_7519:
  164.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  165.             return TokenUtilities.getClaimAsString(this.claims,Claims.JSON_WEB_TOKEN_RFC_7519_SUBJECT);
  166.         case INTROSPECTION_RESPONSE_RFC_7662:
  167.             return TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_SUBJECT);
  168.         case OIDC_ID_TOKEN:
  169.             return TokenUtilities.getClaimAsString(this.claims,Claims.OIDC_ID_TOKEN_SUBJECT);
  170.         case GOOGLE:
  171.             return TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_SUBJECT);
  172.         case MAPPING:
  173.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_SUBJECT);
  174.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  175.         case CUSTOM:
  176.             return null;
  177.         }
  178.         return null;
  179.     }

  181.     @Override
  182.     public String getUsername() {
  183.         
  184.         // NOTA: e' importante per le ricerche, quindi va bene anche nome e cognome se non c'รจ username
  185.         
  186.         switch (this.parser) {
  187.         case JSON_WEB_TOKEN_RFC_7519:
  188.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  189.             return null; // unsupported
  190.         case INTROSPECTION_RESPONSE_RFC_7662:
  191.             return TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_USERNAME);
  192.         case OIDC_ID_TOKEN:
  193.             String tmp = TokenUtilities.getClaimAsString(this.claims,Claims.OIDC_ID_CLAIMS_PREFERRED_USERNAME);
  194.             if(tmp==null &&
  195.                 this.getUserInfoParser()!=null) {
  196.                 return this.getUserInfoParser().getFullName();
  197.             }
  198.             return tmp;
  199.         case GOOGLE:
  200.             if(this.getUserInfoParser()!=null) {
  201.                 return this.getUserInfoParser().getFullName();
  202.             }
  203.             return null;
  204.         case MAPPING:
  205.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_USERNAME);
  206.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  207.         case CUSTOM:
  208.             return null;
  209.         }
  210.         return null;
  211.     }

  213.     @Override
  214.     public List<String> getAudience() {
  215.         List<String> lNull = null;
  216.         switch (this.parser) {
  217.         case JSON_WEB_TOKEN_RFC_7519:
  218.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  219.             return TokenUtilities.getClaimAsList(this.claims,Claims.JSON_WEB_TOKEN_RFC_7519_AUDIENCE);
  220.         case INTROSPECTION_RESPONSE_RFC_7662:
  221.             return TokenUtilities.getClaimAsList(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_AUDIENCE);
  222.         case OIDC_ID_TOKEN:
  223.             return TokenUtilities.getClaimAsList(this.claims,Claims.OIDC_ID_TOKEN_AUDIENCE);
  224.         case GOOGLE:
  225.             return TokenUtilities.getClaimAsList(this.claims,Claims.GOOGLE_CLAIMS_AUDIENCE);
  226.         case MAPPING:
  227.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_AUDIENCE);
  228.             return TokenUtilities.getFirstClaimAsList(this.claims, claimNames);
  229.         case CUSTOM:
  230.             return lNull;
  231.         }
  232.         return lNull;
  233.     }

  235.     @Override
  236.     public Date getExpired() {
  237.         String tmp = null;
  238.         switch (this.parser) {
  239.         case JSON_WEB_TOKEN_RFC_7519:
  240.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  241.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.JSON_WEB_TOKEN_RFC_7519_EXPIRED);
  242.             break;
  243.         case INTROSPECTION_RESPONSE_RFC_7662:
  244.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_EXPIRED);
  245.             break;
  246.         case OIDC_ID_TOKEN:
  247.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.OIDC_ID_TOKEN_EXPIRED);
  248.             break;
  249.         case GOOGLE:
  250.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_EXPIRED);
  251.             break;
  252.         case MAPPING:
  253.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_EXPIRE);
  254.             tmp = TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  255.             break;
  256.         case CUSTOM:
  257.             return null;
  258.         }
  259.         if(tmp!=null) {
  260.             return TokenUtils.parseTimeInSecond(tmp);
  261.         }
  262.         return null;
  263.     }

  265.     @Override
  266.     public Date getIssuedAt() {
  267.         String tmp = null;
  268.         switch (this.parser) {
  269.         case JSON_WEB_TOKEN_RFC_7519:
  270.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  271.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.JSON_WEB_TOKEN_RFC_7519_ISSUED_AT);
  272.             break;
  273.         case INTROSPECTION_RESPONSE_RFC_7662:
  274.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_ISSUED_AT);
  275.             break;
  276.         case OIDC_ID_TOKEN:
  277.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.OIDC_ID_TOKEN_ISSUED_AT);
  278.             break;
  279.         case GOOGLE:
  280.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_ISSUED_AT);
  281.             break;
  282.         case MAPPING:
  283.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_ISSUED_AT);
  284.             tmp = TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  285.             break;
  286.         case CUSTOM:
  287.             return null;
  288.         }
  289.         if(tmp!=null) {
  290.             return TokenUtils.parseTimeInSecond(tmp);
  291.         }
  292.         return null;
  293.     }

  295.     @Override
  296.     public Date getNotToBeUsedBefore() {
  297.         String tmp = null;
  298.         switch (this.parser) {
  299.         case JSON_WEB_TOKEN_RFC_7519:
  300.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  301.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.JSON_WEB_TOKEN_RFC_7519_NOT_TO_BE_USED_BEFORE);
  302.             break;
  303.         case INTROSPECTION_RESPONSE_RFC_7662:
  304.             tmp =  TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_NOT_TO_BE_USED_BEFORE);
  305.             break;
  306.         case OIDC_ID_TOKEN:
  307.         case GOOGLE:
  308.             return null; // unsupported
  309.         case MAPPING:
  310.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_NOT_TO_BE_USED_BEFORE);
  311.             tmp = TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  312.             break;
  313.         case CUSTOM:
  314.             return null;
  315.         }
  316.         if(tmp!=null) {
  317.             return TokenUtils.parseTimeInSecond(tmp);
  318.         }
  319.         return null;
  320.     }

  322.     @Override
  323.     public String getJWTIdentifier() {
  324.         switch (this.parser) {
  325.         case JSON_WEB_TOKEN_RFC_7519:
  326.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  327.             return TokenUtilities.getClaimAsString(this.claims,Claims.JSON_WEB_TOKEN_RFC_7519_JWT_ID);
  328.         case INTROSPECTION_RESPONSE_RFC_7662:
  329.             return TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_JWT_ID);
  330.         case OIDC_ID_TOKEN:
  331.         case GOOGLE:
  332.             return null; // unsupported
  333.         case MAPPING:
  334.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_JWT_IDENTIFIER);
  335.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  336.         case CUSTOM:
  337.             return null;
  338.         }
  339.         return null;
  340.     }
  341.     
  342.     @Override
  343.     public String getClientId() {
  344.         switch (this.parser) {
  345.         case JSON_WEB_TOKEN_RFC_7519:
  346.             return null; // unsupported
  347.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  348.             return TokenUtilities.getClaimAsString(this.claims,Claims.JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068_CLIENT_ID);
  349.         case INTROSPECTION_RESPONSE_RFC_7662:
  350.             return TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_CLIENT_ID);
  351.         case OIDC_ID_TOKEN:
  352.             return TokenUtilities.getClaimAsString(this.claims,Claims.OIDC_ID_TOKEN_AZP);
  353.         case GOOGLE:
  354.             return TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_AZP);
  355.         case MAPPING:
  356.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_CLIENT_ID);
  357.             return TokenUtilities.getFirstClaimAsString(this.claims, claimNames);
  358.         case CUSTOM:
  359.             return null;
  360.         }
  361.         return null;
  362.     }

  364.     @Override
  365.     public List<String> getRoles() {
  366.         List<String> lNull = null;
  367.         switch (this.parser) {
  368.         case MAPPING:
  369.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_ROLE);
  370.             return TokenUtilities.getFirstClaimAsList(this.claims, claimNames);
  371.         case JSON_WEB_TOKEN_RFC_7519:
  372.         case JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068:
  373.         case INTROSPECTION_RESPONSE_RFC_7662:
  374.         case OIDC_ID_TOKEN:
  375.         case GOOGLE:
  376.         case CUSTOM:
  377.             return lNull;
  378.         }
  379.         return lNull;
  380.     }

  382.     @Override
  383.     public List<String> getScopes() {
  384.         
  385.         String tmpScopes = null;
  386.         if(TipologiaClaims.INTROSPECTION_RESPONSE_RFC_7662.equals(this.parser) ||
  387.                 TipologiaClaims.JSON_WEB_TOKEN_FOR_OAUTH2_ACCESS_TOKENS_RFC_9068.equals(this.parser) ||
  388.                 TipologiaClaims.OIDC_ID_TOKEN.equals(this.parser) ||
  389.                 TipologiaClaims.JSON_WEB_TOKEN_RFC_7519.equals(this.parser)) {
  390.             tmpScopes = TokenUtilities.getClaimAsString(this.claims,Claims.INTROSPECTION_RESPONSE_RFC_7662_SCOPE);
  391.         }
  392.         else if(TipologiaClaims.GOOGLE.equals(this.parser)) {
  393.             tmpScopes = TokenUtilities.getClaimAsString(this.claims,Claims.GOOGLE_CLAIMS_SCOPE);
  394.         }
  395.         else if(TipologiaClaims.MAPPING.equals(this.parser)) {
  396.             List<String> claimNames = TokenUtilities.getClaims(this.parserConfig, Costanti.TOKEN_PARSER_SCOPE);
  397.             List<String> tmpScopesList = TokenUtilities.getFirstClaimAsList(this.claims, claimNames);
  398.             List<String> lNull = null;
  399.             if(tmpScopesList!=null && !tmpScopesList.isEmpty()) {
  400.                 List<String> scopes = new ArrayList<>();
  401.                 for (String s : tmpScopesList) {
  402.                     List<String> tmp = readScope(s);
  403.                     if(tmp!=null && !tmp.isEmpty()) {
  404.                         for (String sTmp : tmp) {
  405.                             if(!scopes.contains(sTmp)) {
  406.                                 scopes.add(sTmp);
  407.                             }
  408.                         }
  409.                     }
  410.                 }
  411.                 return scopes;
  412.             }
  413.             else {
  414.                 return lNull;
  415.             }
  416.         }
  417.         
  418.         return readScope(tmpScopes);
  419.         
  420.     }
  421.     private List<String> readScope(String tmpScopes) {
  422.         List<String> lNull = null;
  423.         if(tmpScopes!=null) {
  424.             String [] tmpArray = tmpScopes.split(" ");
  425.             if(tmpArray!=null && tmpArray.length>0) {
  426.                 List<String> scopes = new ArrayList<>();
  427.                 for (int i = 0; i < tmpArray.length; i++) {
  428.                     scopes.add(tmpArray[i].trim());
  429.                 }
  430.                 return scopes;
  431.             }
  432.         }
  433.         return lNull;
  434.     }

  436.     // ITokenUserInfoParser
  437.     @Override
  438.     public ITokenUserInfoParser getUserInfoParser() {
  439.         return this.userInfoParser;
  440.     }
  441. }
Created with JaCoCo 0.8.8.202204050719