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


  22. package org.openspcoop2.utils.security;

  24. import java.security.PrivateKey;
  25. import java.security.PublicKey;
  26. import java.security.cert.Certificate;

  28. import javax.crypto.SecretKey;

  30. import org.apache.xml.security.encryption.EncryptedData;
  31. import org.apache.xml.security.encryption.EncryptedKey;
  32. import org.apache.xml.security.encryption.XMLCipher;
  33. import org.openspcoop2.utils.UtilsException;
  34. import org.openspcoop2.utils.certificate.KeyStore;
  35. import org.openspcoop2.utils.xml.DynamicNamespaceContext;
  36. import org.openspcoop2.utils.xml.XPathExpressionEngine;
  37. import org.openspcoop2.utils.xml.XPathReturnType;
  38. import org.w3c.dom.Document;
  39. import org.w3c.dom.Element;

  41. /** 
  42.  * Encrypt
  43.  *
  44.  * @author Poli Andrea (apoli@link.it)
  45.  * @author $Author$
  46.  * @version $Rev$, $Date$
  47.  */
  48. public class XmlDecrypt extends AbstractXmlCipher {
  49.     
  50.     // BOTH 
  51.     
  52.     public XmlDecrypt(java.security.KeyStore keystore, boolean symmetricKey, SymmetricKeyWrappedMode wrappedSymmetricKeyMode, String alias, String passwordPrivateKey) throws UtilsException{
  53.         super(XMLCipher.DECRYPT_MODE, keystore, symmetricKey, wrappedSymmetricKeyMode, alias, passwordPrivateKey, false);
  54.     }
  55.     public XmlDecrypt(java.security.KeyStore keystore, boolean symmetricKey, SymmetricKeyWrappedMode wrappedSymmetricKeyMode, String alias, String passwordPrivateKey,boolean addBouncyCastleProvider) throws UtilsException{
  56.         super(XMLCipher.DECRYPT_MODE, keystore, symmetricKey, wrappedSymmetricKeyMode, alias, passwordPrivateKey, addBouncyCastleProvider);
  57.     }
  58.     public XmlDecrypt(KeyStore keystore, boolean symmetricKey, SymmetricKeyWrappedMode wrappedSymmetricKeyMode, String alias, String passwordPrivateKey) throws UtilsException{
  59.         super(XMLCipher.DECRYPT_MODE, keystore, symmetricKey, wrappedSymmetricKeyMode, alias, passwordPrivateKey, false);
  60.     }
  61.     public XmlDecrypt(KeyStore keystore, boolean symmetricKey, SymmetricKeyWrappedMode wrappedSymmetricKeyMode, String alias, String passwordPrivateKey,boolean addBouncyCastleProvider) throws UtilsException{
  62.         super(XMLCipher.DECRYPT_MODE, keystore, symmetricKey, wrappedSymmetricKeyMode, alias, passwordPrivateKey, addBouncyCastleProvider);
  63.     }
  64.     
  65.     public XmlDecrypt(SymmetricKeyWrappedMode wrappedSymmetricKeyMode, java.security.KeyStore keystore, String alias, String passwordPrivateKey,
  66.             boolean addBouncyCastleProvider) throws UtilsException {
  67.         super(XMLCipher.DECRYPT_MODE, wrappedSymmetricKeyMode, keystore, alias, passwordPrivateKey, addBouncyCastleProvider);
  68.     }
  69.     public XmlDecrypt(SymmetricKeyWrappedMode wrappedSymmetricKeyMode, java.security.KeyStore keystore, String alias, String passwordPrivateKey) throws UtilsException {
  70.         super(XMLCipher.DECRYPT_MODE, wrappedSymmetricKeyMode, keystore, alias, passwordPrivateKey);
  71.     }
  72.     public XmlDecrypt(SymmetricKeyWrappedMode wrappedSymmetricKeyMode, KeyStore keystore, String alias, String passwordPrivateKey,
  73.             boolean addBouncyCastleProvider) throws UtilsException {
  74.         super(XMLCipher.DECRYPT_MODE, wrappedSymmetricKeyMode, keystore, alias, passwordPrivateKey, addBouncyCastleProvider);
  75.     }
  76.     public XmlDecrypt(SymmetricKeyWrappedMode wrappedSymmetricKeyMode, KeyStore keystore, String alias, String passwordPrivateKey) throws UtilsException {
  77.         super(XMLCipher.DECRYPT_MODE, wrappedSymmetricKeyMode, keystore, alias, passwordPrivateKey);
  78.     }

  80.     
  81.     
  82.     // SYMMETRIC
  83.     
  84.     public XmlDecrypt(SymmetricKeyWrappedMode wrappedSymmetricKeyMode, SecretKey secretKey) throws UtilsException{
  85.         super(XMLCipher.DECRYPT_MODE, wrappedSymmetricKeyMode, secretKey);
  86.     }
  87.     public XmlDecrypt(SymmetricKeyWrappedMode wrappedSymmetricKeyMode, SecretKey secretKey,boolean addBouncyCastleProvider) throws UtilsException{
  88.         super(XMLCipher.DECRYPT_MODE, wrappedSymmetricKeyMode, secretKey, addBouncyCastleProvider);
  89.     }
  90.     
  91.     // Questo costruttore non ha senso, una chiave segreta ci vuole!
  92. //  public XmlDecrypt(String keyAlgorithm, boolean addBouncyCastleProvider)
  93. //          throws UtilsException {
  94. //      super(XMLCipher.DECRYPT_MODE, keyAlgorithm, addBouncyCastleProvider);
  95. //  }
  96. //  public XmlDecrypt(String keyAlgorithm) throws UtilsException {
  97. //      super(XMLCipher.DECRYPT_MODE, keyAlgorithm);
  98. //  }

  100.     
  101.     // ASYMMETRIC
  102.     
  103.     public XmlDecrypt(Certificate certificate, boolean addBouncyCastleProvider) throws UtilsException {
  104.         super(XMLCipher.DECRYPT_MODE, certificate, addBouncyCastleProvider);
  105.     }
  106.     public XmlDecrypt(Certificate certificate) throws UtilsException {
  107.         super(XMLCipher.DECRYPT_MODE, certificate);
  108.     }

  110.     public XmlDecrypt(PrivateKey key, boolean addBouncyCastleProvider) throws UtilsException {
  111.         super(XMLCipher.DECRYPT_MODE, SymmetricKeyWrappedMode.SYM_ENC_KEY_WRAPPED_ASYMMETRIC_KEY, key, addBouncyCastleProvider);
  112.     }
  113.     public XmlDecrypt(PrivateKey key) throws UtilsException {
  114.         super(XMLCipher.DECRYPT_MODE, SymmetricKeyWrappedMode.SYM_ENC_KEY_WRAPPED_ASYMMETRIC_KEY, key);
  115.     }

  117.     public XmlDecrypt(PublicKey key, boolean addBouncyCastleProvider) throws UtilsException {
  118.         super(XMLCipher.DECRYPT_MODE, SymmetricKeyWrappedMode.SYM_ENC_KEY_WRAPPED_ASYMMETRIC_KEY, key, addBouncyCastleProvider);
  119.     }
  120.     public XmlDecrypt(PublicKey key) throws UtilsException {
  121.         super(XMLCipher.DECRYPT_MODE, SymmetricKeyWrappedMode.SYM_ENC_KEY_WRAPPED_ASYMMETRIC_KEY, key);
  122.     }

  124.     public XmlDecrypt(java.security.KeyStore keystore, boolean addBouncyCastleProvider) throws UtilsException {
  125.         super(XMLCipher.DECRYPT_MODE, keystore, addBouncyCastleProvider);
  126.     }
  127.     public XmlDecrypt(java.security.KeyStore keystore) throws UtilsException {
  128.         super(XMLCipher.DECRYPT_MODE, keystore);
  129.     }
  130.     public XmlDecrypt(KeyStore keystore, boolean addBouncyCastleProvider) throws UtilsException {
  131.         super(XMLCipher.DECRYPT_MODE, keystore, addBouncyCastleProvider);
  132.     }
  133.     public XmlDecrypt(KeyStore keystore) throws UtilsException {
  134.         super(XMLCipher.DECRYPT_MODE, keystore);
  135.     }

  137.     public XmlDecrypt(java.security.KeyStore keystore, String alias, boolean addBouncyCastleProvider)
  138.             throws UtilsException {
  139.         super(XMLCipher.DECRYPT_MODE, keystore, alias, addBouncyCastleProvider);
  140.     }
  141.     public XmlDecrypt(java.security.KeyStore keystore, String alias) throws UtilsException {
  142.         super(XMLCipher.DECRYPT_MODE, keystore, alias);
  143.     }
  144.     public XmlDecrypt(KeyStore keystore, String alias, boolean addBouncyCastleProvider)
  145.             throws UtilsException {
  146.         super(XMLCipher.DECRYPT_MODE, keystore, alias, addBouncyCastleProvider);
  147.     }
  148.     public XmlDecrypt(KeyStore keystore, String alias) throws UtilsException {
  149.         super(XMLCipher.DECRYPT_MODE, keystore, alias);
  150.     }


  153.     public Document decrypt(Document document) throws UtilsException{
  154.         return this.decrypt(document, document.getDocumentElement());
  155.     }
  156.     public Document decrypt(Element element) throws UtilsException{
  157.         return this.decrypt(element.getOwnerDocument(), element);
  158.     }
  159.     public Document decrypt(Document document, Element element) throws UtilsException{
  160.         try{
  161.             XPathExpressionEngine xpathEngine = new XPathExpressionEngine();
  162.             DynamicNamespaceContext dnc = new DynamicNamespaceContext();
  163.             dnc.findPrefixNamespace(element);
  164.             
  165.             // Estrazione element xenc
  166.             
  167.             Element encryptedDataElement = null;
  168.             Object o = xpathEngine.getMatchPattern(element, dnc, "//{http://www.w3.org/2001/04/xmlenc#}EncryptedData", XPathReturnType.NODE);
  169.             if (o == null) {
  170.                 throw new Exception("EncryptData not found");
  171.             } 
  172.             encryptedDataElement = (Element) o;
  173.             
  174.             Element encryptedKeyElement = null;
  175.             if(super.isEncryptedKey()){
  176.                 o = xpathEngine.getMatchPattern(encryptedDataElement, dnc, "//{http://www.w3.org/2001/04/xmlenc#}EncryptedKey", XPathReturnType.NODE);
  177.                 if (o == null) {
  178.                     throw new Exception("EncryptedKey not found");
  179.                 } 
  180.                 encryptedKeyElement = (Element) o;
  181.             }
  182.             
  183.             // Identificazione algoritmi
  184.             
  185.             org.apache.xml.security.encryption.XMLCipher xmlCipherReaderAlgo = super.getXMLCipher();
  186.             EncryptedData encryptedData = xmlCipherReaderAlgo.loadEncryptedData(document, encryptedDataElement);
  187.             EncryptedKey encryptedKey = null;
  188.             if(super.isEncryptedKey()){
  189.                 encryptedKey = xmlCipherReaderAlgo.loadEncryptedKey(document, encryptedKeyElement);
  190.             }
  191.             String encryptAlgorithm = encryptedData.getEncryptionMethod().getAlgorithm();
  192.             String digestAlgorithm = encryptedData.getEncryptionMethod().getDigestAlgorithm();
  193.             String canonicalizationAlgorithm = null; // TODO
  194.             if(super.isEncryptedKey()){
  195.                 org.apache.xml.security.encryption.XMLCipher xmlCipherUnwrap = super.getXMLCipherUnwrappedKey();
  196.                 super.secretKeyEncrypt = (SecretKey) xmlCipherUnwrap.decryptKey(encryptedKey, encryptAlgorithm);
  197.             }
  198.                     
  199.             org.apache.xml.security.encryption.XMLCipher xmlCipher = super.getXMLCipher(encryptAlgorithm, canonicalizationAlgorithm, digestAlgorithm);
  200.             return xmlCipher.doFinal(document, encryptedDataElement);           
  201.         }catch(Exception e){
  202.             throw new UtilsException(e.getMessage(),e);
  203.         }
  204.     }

  206. }
Created with JaCoCo 0.8.8.202204050719