ModISOAPSecurity.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.protocol.modipa.validator;

  23. import java.util.List;

  25. import javax.xml.namespace.QName;
  26. import javax.xml.soap.SOAPBody;
  27. import javax.xml.soap.SOAPEnvelope;
  28. import javax.xml.soap.SOAPHeader;
  29. import javax.xml.soap.SOAPHeaderElement;

  31. import org.openspcoop2.message.OpenSPCoop2Message;
  32. import org.openspcoop2.message.OpenSPCoop2MessageFactory;
  33. import org.openspcoop2.message.OpenSPCoop2SoapMessage;
  34. import org.openspcoop2.message.constants.MessageRole;
  35. import org.openspcoop2.message.constants.MessageType;
  36. import org.openspcoop2.message.exception.MessageException;
  37. import org.openspcoop2.message.exception.MessageNotSupportedException;
  38. import org.openspcoop2.message.soap.reference.Reference;
  39. import org.openspcoop2.message.soap.wsaddressing.WSAddressingHeader;
  40. import org.openspcoop2.security.SecurityException;
  41. import org.openspcoop2.security.message.MessageSecurityContext;
  42. import org.openspcoop2.security.message.wss4j.MessageSecurityReceiver_wss4j;

  44. /**
  45.  * ModISOAPSecurity
  46.  *
  47.  * @author Poli Andrea (apoli@link.it)
  48.  * @author $Author$
  49.  * @version $Rev$, $Date$
  50.  */
  51. public class ModISOAPSecurity {

  53.     private SOAPHeaderElement securityHeader;
  54.     private WSAddressingHeader wsAddressingHeader;
  55.     private SOAPHeaderElement requestDigestHeader;
  56.     private String wsuIdBodyRef;
  57.     
  58.     private MessageSecurityReceiver_wss4j wss4jSignature;
  59.     private MessageSecurityContext messageSecurityContext;
  60.     private List<Reference> elementsToClean;
  61.     
  62.     public SOAPHeaderElement getSecurityHeader() {
  63.         return this.securityHeader;
  64.     }
  65.     public void setSecurityHeader(SOAPHeaderElement securityHeader) {
  66.         this.securityHeader = securityHeader;
  67.     }
  68.     public WSAddressingHeader getWsAddressingHeader() {
  69.         return this.wsAddressingHeader;
  70.     }
  71.     public void setWsAddressingHeader(WSAddressingHeader wsAddressingHeader) {
  72.         this.wsAddressingHeader = wsAddressingHeader;
  73.     }
  74.     public SOAPHeaderElement getRequestDigestHeader() {
  75.         return this.requestDigestHeader;
  76.     }
  77.     public void setRequestDigestHeader(SOAPHeaderElement requestDigestHeader) {
  78.         this.requestDigestHeader = requestDigestHeader;
  79.     }
  80.     public String getWsuIdBodyRef() {
  81.         return this.wsuIdBodyRef;
  82.     }
  83.     public void setWsuIdBodyRef(String wsuIdBodyRef) {
  84.         this.wsuIdBodyRef = wsuIdBodyRef;
  85.     }
  86.     public List<Reference> getElementsToClean() {
  87.         return this.elementsToClean;
  88.     }
  89.     public void setElementsToClean(List<Reference> elementsToClean) {
  90.         this.elementsToClean = elementsToClean;
  91.     }
  92.     public MessageSecurityReceiver_wss4j getWss4jSignature() {
  93.         return this.wss4jSignature;
  94.     }
  95.     public void setWss4jSignature(MessageSecurityReceiver_wss4j wss4jSignature) {
  96.         this.wss4jSignature = wss4jSignature;
  97.     }
  98.     public MessageSecurityContext getMessageSecurityContext() {
  99.         return this.messageSecurityContext;
  100.     }
  101.     public void setMessageSecurityContext(MessageSecurityContext messageSecurityContext) {
  102.         this.messageSecurityContext = messageSecurityContext;
  103.     }
  104.     
  105.     public void clean(OpenSPCoop2SoapMessage soapMessage) throws SecurityException, MessageException, MessageNotSupportedException {
  106.         boolean detachValue = true; // per default l'header WSS viene eliminato
  107.         boolean removeAllIdRefValue = true;
  108.         this.wss4jSignature.cleanDirtyElements(this.messageSecurityContext, soapMessage, this.elementsToClean, detachValue, removeAllIdRefValue);
  109.         
  110.         if(this.wsAddressingHeader!=null || this.requestDigestHeader!=null) {
  111.             
  112.             SOAPHeader header = soapMessage.getSOAPHeader();
  113.             
  114.             if(header!=null) {
  115.                 
  116.                 if(this.wsAddressingHeader!=null) {
  117.                     if(this.wsAddressingHeader.getTo()!=null) {
  118.                         removeHeader(header, this.wsAddressingHeader.getTo());
  119.                     }
  120.                     if(this.wsAddressingHeader.getFrom()!=null) {
  121.                         removeHeader(header, this.wsAddressingHeader.getFrom());
  122.                     }
  123.                     if(this.wsAddressingHeader.getAction()!=null) {
  124.                         removeHeader(header, this.wsAddressingHeader.getAction());
  125.                     }
  126.                     if(this.wsAddressingHeader.getId()!=null) {
  127.                         removeHeader(header, this.wsAddressingHeader.getId());
  128.                     }
  129.                     if(this.wsAddressingHeader.getRelatesTo()!=null) {
  130.                         removeHeader(header, this.wsAddressingHeader.getRelatesTo());
  131.                     }
  132.                     if(this.wsAddressingHeader.getReplyTo()!=null) {
  133.                         removeHeader(header, this.wsAddressingHeader.getReplyTo());
  134.                     }
  135.                     if(this.wsAddressingHeader.getFaultTo()!=null) {
  136.                         removeHeader(header, this.wsAddressingHeader.getFaultTo());
  137.                     }
  138.                 }
  139.                 
  140.                 if(this.requestDigestHeader!=null) {
  141.                     removeHeader(header, this.requestDigestHeader);
  142.                 }
  143.             }
  144.         }
  145.     }
  146.     private void removeHeader(SOAPHeader hdr, SOAPHeaderElement soapHeader) {

  148.         //hdr.removeChild(soapHeader);
  149.         // FIX: NOT_FOUND_ERR: An attempt is made to reference a node in a context where it does not exist.
  150.         // Succede in determinate condizione di utilizzo dell'header ottimizzato e della bufferizzazione read only
  151.         
  152.         // cerco la busta per il namespace
  153.         java.util.Iterator<?> it = hdr.examineAllHeaderElements();
  154.         while( it.hasNext()  ){

  156.             // Test Header Element
  157.             SOAPHeaderElement headerElementCheck = (SOAPHeaderElement) it.next();

  159. //          // Controllo Actor
  160. //          if(soapHeader.getActor()!=null) {
  161. //              if(headerElementCheck.getActor()==null) {
  162. //                  continue;
  163. //              }
  164. //              if(!soapHeader.getActor().equals(headerElementCheck.getActor())) {
  165. //                  continue;
  166. //              }
  167. //          }
  168. //          else {
  169. //              if(headerElementCheck.getActor()!=null) {
  170. //                  continue;
  171. //              }
  172. //          }
  173. //          // Controllo role
  174. //          if(soapHeader.getRole()!=null) {
  175. //              if(headerElementCheck.getRole()==null) {
  176. //                  continue;
  177. //              }
  178. //              if(!soapHeader.getRole().equals(headerElementCheck.getRole())) {
  179. //                  continue;
  180. //              }
  181. //          }
  182. //          else {
  183. //              if(headerElementCheck.getRole()!=null) {
  184. //                  continue;
  185. //              }
  186. //          }
  187.             
  188.             //Controllo Namespace
  189.             if(soapHeader.getNamespaceURI()!=null) {
  190.                 if(headerElementCheck.getNamespaceURI()==null) {
  191.                     continue;
  192.                 }
  193.                 if(!soapHeader.getNamespaceURI().equals(headerElementCheck.getNamespaceURI())) {
  194.                     continue;
  195.                 }
  196.             }
  197.             else {
  198.                 if(headerElementCheck.getNamespaceURI()!=null) {
  199.                     continue;
  200.                 }
  201.             }
  202.             
  203.             //Controllo LocalName
  204.             if(soapHeader.getLocalName()!=null) {
  205.                 if(headerElementCheck.getLocalName()==null) {
  206.                     continue;
  207.                 }
  208.                 if(!soapHeader.getLocalName().equals(headerElementCheck.getLocalName())) {
  209.                     continue;
  210.                 }
  211.             }
  212.             else {
  213.                 if(headerElementCheck.getLocalName()!=null) {
  214.                     continue;
  215.                 }
  216.             }
  217.             
  218.             //Controllo Prefix
  219.             if(soapHeader.getPrefix()!=null) {
  220.                 if(headerElementCheck.getPrefix()==null) {
  221.                     continue;
  222.                 }
  223.                 if(!soapHeader.getPrefix().equals(headerElementCheck.getPrefix())) {
  224.                     continue;
  225.                 }
  226.             }
  227.             else {
  228.                 if(headerElementCheck.getPrefix()!=null) {
  229.                     continue;
  230.                 }
  231.             }
  232.             
  233.             
  234.             // found
  235.             hdr.removeChild(headerElementCheck);
  236.             
  237.             break;
  238.         }
  239.     }
  240.     
  241.     public SOAPEnvelope buildTraccia(MessageType type) throws MessageException {
  242.         
  243.         try {
  244.             
  245.             OpenSPCoop2Message msg = OpenSPCoop2MessageFactory.getDefaultMessageFactory().createEmptyMessage(type, MessageRole.NONE);
  246.             OpenSPCoop2SoapMessage soapMessage = msg.castAsSoap();
  247.             
  248.             SOAPHeader header = soapMessage.getSOAPHeader();
  249.             if(header==null) {
  250.                 header = soapMessage.getSOAPPart().getEnvelope().addHeader();
  251.             }
  252.             
  253.             boolean add = false;
  254.             
  255.             if(this.securityHeader!=null) {
  256.                 header.addChildElement(this.securityHeader);
  257.                 add = true;
  258.             }
  259.             
  260.             if(this.wsAddressingHeader!=null) {
  261.                 if(this.wsAddressingHeader.getTo()!=null) {
  262.                     header.addChildElement(this.wsAddressingHeader.getTo());
  263.                     add = true;
  264.                 }
  265.                 if(this.wsAddressingHeader.getFrom()!=null) {
  266.                     header.addChildElement(this.wsAddressingHeader.getFrom());
  267.                     add = true;
  268.                 }
  269.                 if(this.wsAddressingHeader.getAction()!=null) {
  270.                     header.addChildElement(this.wsAddressingHeader.getAction());
  271.                     add = true;
  272.                 }
  273.                 if(this.wsAddressingHeader.getId()!=null) {
  274.                     header.addChildElement(this.wsAddressingHeader.getId());
  275.                     add = true;
  276.                 }
  277.                 if(this.wsAddressingHeader.getRelatesTo()!=null) {
  278.                     header.addChildElement(this.wsAddressingHeader.getRelatesTo());
  279.                     add = true;
  280.                 }
  281.                 if(this.wsAddressingHeader.getReplyTo()!=null) {
  282.                     header.addChildElement(this.wsAddressingHeader.getReplyTo());
  283.                     add = true;
  284.                 }
  285.                 if(this.wsAddressingHeader.getFaultTo()!=null) {
  286.                     header.addChildElement(this.wsAddressingHeader.getFaultTo());
  287.                     add = true;
  288.                 }
  289.             }
  290.             
  291.             if(this.requestDigestHeader!=null) {
  292.                 header.addChildElement(this.requestDigestHeader);
  293.                 add = true;
  294.             }
  295.             
  296.             SOAPBody body = soapMessage.getSOAPBody();
  297.             if(body==null) {
  298.                 body = soapMessage.getSOAPPart().getEnvelope().addBody();
  299.             }
  300.             if(this.wsuIdBodyRef!=null) {
  301.                 QName qname = new QName("http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id", "wsu");
  302.                 body.addAttribute(qname, this.wsuIdBodyRef);
  303.             }
  304.             body.setTextContent("...");
  305.             
  306.             if(add) {
  307.                 return soapMessage.getSOAPPart().getEnvelope();
  308.             }
  309.             else {
  310.                 return null;
  311.             }
  312.             
  313.         }catch(Exception e) {
  314.             throw new MessageException(e.getMessage(), e);
  315.         }
  316.         
  317.     }
  318. }
Created with JaCoCo 0.8.8.202204050719