WWWAuthenticateGenerator.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.message.utils;

  23. import java.util.HashMap;

  25. import org.openspcoop2.message.ForcedResponseMessage;
  26. import org.openspcoop2.message.OpenSPCoop2Message;
  27. import org.openspcoop2.message.OpenSPCoop2MessageFactory;
  28. import org.openspcoop2.message.constants.MessageRole;
  29. import org.openspcoop2.message.constants.MessageType;
  30. import org.openspcoop2.utils.transport.TransportUtils;
  31. import org.openspcoop2.utils.transport.http.HttpConstants;

  33. /**     
  34.  * WWWAuthenticateGenerator
  35.  *
  36.  * @author Poli Andrea (poli@link.it)
  37.  * @author $Author$
  38.  * @version $Rev$, $Date$
  39.  */
  40. public class WWWAuthenticateGenerator {
  41.     
  42.     private WWWAuthenticateGenerator() {}
  43.     
  44.     public static OpenSPCoop2Message buildErrorMessage(WWWAuthenticateErrorCode errorCode, String realm, boolean genericError, String error, String ... scope) {
  45.         
  46.         OpenSPCoop2Message errorMessage = OpenSPCoop2MessageFactory.getDefaultMessageFactory().createEmptyMessage(MessageType.BINARY, MessageRole.FAULT);
  47.         ForcedResponseMessage forcedResponseMessage = new ForcedResponseMessage();
  48.         forcedResponseMessage.setContent(null); // vuoto
  49.         forcedResponseMessage.setContentType(null); // vuoto
  50.         forcedResponseMessage.setResponseCode(getReturnCode(errorCode)+""); 
  51.         forcedResponseMessage.setHeadersValues(new HashMap<>());
  52.         String headerValue = buildHeaderValue(errorCode, realm, genericError, error, scope);
  53.         TransportUtils.addHeader(forcedResponseMessage.getHeadersValues(), HttpConstants.AUTHORIZATION_RESPONSE_WWW_AUTHENTICATE, headerValue);
  54.         errorMessage.forceResponse(forcedResponseMessage);
  55.         
  56.         return errorMessage;
  57.     }
  58.     
  59.     public static int getReturnCode(WWWAuthenticateErrorCode errorCode) {
  60.         switch (errorCode) {
  61.         case invalid_request:
  62.             return 400;
  63.         case invalid_token:
  64.             return 401;
  65.         case insufficient_scope:
  66.             return 403;
  67.         }
  68.         return 500;
  69.     }
  70.     
  71.     public static String buildHeaderValue(WWWAuthenticateErrorCode errorCode, String realm, boolean genericError, String error, String ... scope) {
  72.         
  73.         StringBuilder bf = new StringBuilder(HttpConstants.AUTHORIZATION_PREFIX_BEARER);
  74.         bf.append("realm=\"");
  75.         bf.append(realm);
  76.         bf.append("\", error=\"");
  77.         bf.append(errorCode.name());
  78.         bf.append("\", error_description=\"");
  79.         if(!genericError) {
  80.             bf.append(error);
  81.         }
  82.         switch (errorCode) {
  83.         case invalid_request:
  84.             if(genericError) {
  85.                 bf.append("The request is missing a required token parameter");
  86.             }
  87.             break;
  88.         case invalid_token:
  89.             if(genericError) {
  90.                 bf.append("Token invalid");
  91.             }
  92.             break;
  93.         case insufficient_scope:
  94.             if(genericError) {
  95.                 bf.append("The request requires higher privileges than provided by the access token");
  96.             }
  97.             break;
  98.         }
  99.         bf.append("\"");
  100.         if(scope!=null && scope.length>0) {
  101.             bf.append(", scope=\"");
  102.             for (int i = 0; i < scope.length; i++) {
  103.                 if(i>0) {
  104.                     bf.append(",");
  105.                 }
  106.                 bf.append(scope[i]);    
  107.             }
  108.             bf.append("\"");
  109.         }
  110.         
  111.         return bf.toString();
  112.     }
  113.     
  114.     public static String buildBasicHeaderValue(String realm) {
  115.         
  116.         StringBuilder bf = new StringBuilder(HttpConstants.AUTHORIZATION_PREFIX_BASIC);
  117.         bf.append("realm=\"");
  118.         bf.append(realm);
  119.         bf.append("\"");
  120.         return bf.toString();
  121.     }
  122.     
  123.     public static String buildCustomHeaderValue(String auth, String realm, WWWAuthenticateErrorCode errorCode, String errorDescription) {
  124.         return buildCustomHeaderValue(auth, realm, errorCode!=null ? errorCode.name() : null, errorDescription);
  125.     }
  126.     public static String buildCustomHeaderValue(String auth, String realm, String errorCode, String errorDescription) {
  127.         
  128.         StringBuilder bf = new StringBuilder(auth);
  129.         bf.append(" realm=\"");
  130.         bf.append(realm);
  131.         bf.append("\"");
  132.         if(errorCode!=null) {
  133.             bf.append(", error=\"");
  134.             bf.append(errorCode);
  135.             bf.append("\"");
  136.         }
  137.         if(errorDescription!=null) {
  138.             bf.append(", error_description=\"");
  139.             bf.append(errorDescription);
  140.             bf.append("\"");
  141.         }
  142.         return bf.toString();
  143.         
  144.     }
  145.     
  146. }
Created with JaCoCo 0.8.8.202204050719