xmlsecurity/source/framework/encryptionengine.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: encryptionengine.cxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_xmlsecurity.hxx"
  33
  34 #include "encryptionengine.hxx"
  35 #include <com/sun/star/xml/crypto/XXMLEncryptionTemplate.hpp>
  36 #include <com/sun/star/xml/wrapper/XXMLElementWrapper.hpp>
  37 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  38
  39 namespace cssu = com::sun::star::uno;
  40 namespace cssl = com::sun::star::lang;
  41 namespace cssxc = com::sun::star::xml::crypto;
  42 namespace cssxw = com::sun::star::xml::wrapper;
  43
  44 #define ENCRYPTION_TEMPLATE "com.sun.star.xml.crypto.XMLEncryptionTemplate"
  45
  46 #define DECLARE_ASCII( SASCIIVALUE )                                                                                                                                                    \
  47     rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( SASCIIVALUE ) )
  48
  49 EncryptionEngine::EncryptionEngine( )
  50         :m_nIdOfBlocker(-1)
  51 {
  52 }
  53
  54 bool EncryptionEngine::checkReady() const
  55 /****** EncryptionEngine/checkReady ******************************************
  56  *
  57  *   NAME
  58  *      checkReady -- checks the conditions for the main operation.
  59  *
  60  *   SYNOPSIS
  61  *      bReady = checkReady( );
  62  *
  63  *   FUNCTION
  64  *      checks whether all following conditions are satisfied:
  65  *      1. the main operation has't begun yet;
  66  *      2. the key material is known;
  67  *      3. the id of the template blocker is known;
  68  *      4. both the key element and the encryption template
  69  *         are bufferred.
  70  *
  71  *   INPUTS
  72  *      empty
  73  *
  74  *   RESULT
  75  *      bReady - true if all conditions are satisfied, false otherwise
  76  *
  77  *   HISTORY
  78  *      05.01.2004 -    implemented
  79  *
  80  *   AUTHOR
  81  *      Michael Mi
  82  *      Email: michael.mi@sun.com
  83  ******************************************************************************/
  84 {
  85     bool rc = true;
  86
  87     sal_Int32 nKeyInc = 0;
  88     if (m_nIdOfKeyEC != 0)
  89     {
  90         nKeyInc = 1;
  91     }
  92
  93     if (m_bMissionDone ||
  94         m_nIdOfKeyEC == -1 ||
  95         m_nIdOfBlocker == -1 ||
  96         1+nKeyInc > m_nNumOfResolvedReferences )
  97     {
  98         rc = false;
  99     }
 100
 101     return rc;
 102 }
 103
 104 void EncryptionEngine::tryToPerform( )
 105         throw (cssu::Exception, cssu::RuntimeException)
 106 /****** EncryptionEngine/tryToPerform ****************************************
 107  *
 108  *   NAME
 109  *      tryToPerform -- tries to perform the encryption/decryption operation.
 110  *
 111  *   SYNOPSIS
 112  *      tryToPerform( );
 113  *
 114  *   FUNCTION
 115  *      if the situation is ready, perform following operations.
 116  *      1. prepares a encryption template;
 117  *      2. calls the encryption bridge component;
 118  *      3. clears up all used resources;
 119  *      4. notifies the result listener;
 120  *      5. sets the "accomplishment" flag.
 121  *
 122  *   INPUTS
 123  *      empty
 124  *
 125  *   RESULT
 126  *      empty
 127  *
 128  *   HISTORY
 129  *      05.01.2004 -    implemented
 130  *
 131  *   AUTHOR
 132  *      Michael Mi
 133  *      Email: michael.mi@sun.com
 134  ******************************************************************************/
 135 {
 136     if (checkReady())
 137     {
 138         const rtl::OUString sEncryptionTemplate (
 139             RTL_CONSTASCII_USTRINGPARAM( ENCRYPTION_TEMPLATE ) );
 140         cssu::Reference < cssxc::XXMLEncryptionTemplate > xEncryptionTemplate(
 141             mxMSF->createInstance( sEncryptionTemplate ), cssu::UNO_QUERY );
 142
 143         OSL_ASSERT( xEncryptionTemplate.is() );
 144
 145         cssu::Reference< cssxw::XXMLElementWrapper > xXMLElement
 146             = m_xSAXEventKeeper->getElement( m_nIdOfTemplateEC );
 147
 148         xEncryptionTemplate->setTemplate(xXMLElement);
 149
 150         startEngine( xEncryptionTemplate );
 151
 152         /*
 153          * done
 154          */
 155         clearUp( );
 156
 157         notifyResultListener();
 158
 159         m_bMissionDone = true;
 160     }
 161 }
 162
 163 void EncryptionEngine::clearUp( ) const
 164 /****** EncryptionEngine/clearup *********************************************
 165  *
 166  *   NAME
 167  *      clearUp -- clear up all resources used by this operation.
 168  *
 169  *   SYNOPSIS
 170  *      clearUp( );
 171  *
 172  *   FUNCTION
 173  *      cleaning resources up includes:
 174  *      1. releases the ElementCollector for the encryption template element;
 175  *      2. releases the Blocker for the encryption template element;
 176  *      3. releases the ElementCollector for the key element, if there is one.
 177  *
 178  *   INPUTS
 179  *      empty
 180  *
 181  *   RESULT
 182  *      empty
 183  *
 184  *   HISTORY
 185  *      05.01.2004 -    implemented
 186  *
 187  *   AUTHOR
 188  *      Michael Mi
 189  *      Email: michael.mi@sun.com
 190  ******************************************************************************/
 191 {
 192     cssu::Reference < cssxc::sax::XReferenceResolvedBroadcaster >
 193         xReferenceResolvedBroadcaster( m_xSAXEventKeeper, cssu::UNO_QUERY );
 194
 195     xReferenceResolvedBroadcaster->removeReferenceResolvedListener(
 196         m_nIdOfTemplateEC,
 197         (const cssu::Reference < cssxc::sax::XReferenceResolvedListener >)((SecurityEngine *)this));
 198
 199     m_xSAXEventKeeper->removeElementCollector(m_nIdOfTemplateEC);
 200
 201     if (m_nIdOfBlocker != -1)
 202     {
 203         m_xSAXEventKeeper->removeBlocker(m_nIdOfBlocker);
 204     }
 205
 206     if (m_nIdOfKeyEC != 0 && m_nIdOfKeyEC != -1)
 207     {
 208         m_xSAXEventKeeper->removeElementCollector(m_nIdOfKeyEC);
 209     }
 210 }
 211
 212 /* XBlockerMonitor */
 213 void SAL_CALL EncryptionEngine::setBlockerId( sal_Int32 id )
 214     throw (com::sun::star::uno::Exception, com::sun::star::uno::RuntimeException)
 215 {
 216     m_nIdOfBlocker = id;
 217     tryToPerform();
 218 }
 219