xmlsecurity/source/framework/encryptionengine.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _ENCRYPTIONENGINE_HXX
  21 #define _ENCRYPTIONENGINE_HXX
  22
  23 #include <com/sun/star/xml/crypto/sax/XReferenceResolvedListener.hpp>
  24 #include <com/sun/star/xml/crypto/sax/XReferenceResolvedBroadcaster.hpp>
  25 #include <com/sun/star/xml/crypto/sax/XBlockerMonitor.hpp>
  26 #include <com/sun/star/xml/crypto/sax/XKeyCollector.hpp>
  27 #include <com/sun/star/xml/crypto/sax/XMissionTaker.hpp>
  28 #include <com/sun/star/xml/crypto/sax/XSAXEventKeeper.hpp>
  29 #include <com/sun/star/xml/crypto/XXMLSecurityContext.hpp>
  30 #include <com/sun/star/xml/crypto/XXMLEncryption.hpp>
  31 #include <cppuhelper/implbase1.hxx>
  32
  33 #include "securityengine.hxx"
  34
  35 class EncryptionEngine : public cppu::ImplInheritanceHelper1
  36 <
  37     SecurityEngine,
  38     com::sun::star::xml::crypto::sax::XBlockerMonitor
  39 >
  40 /****** encryptionEngine.hxx/CLASS encryptionEngine ***************************
  41  *
  42  *   NAME
  43  *  EncryptionEngine -- Base class of Encryptor and Decryptor
  44  *
  45  *   FUNCTION
  46  *  Maintains common members and methods related with encryption.
  47  *
  48  *   AUTHOR
  49  *  Michael Mi
  50  *  Email: michael.mi@sun.com
  51  ******************************************************************************/
  52 {
  53 protected:
  54     /*
  55      * the Encryption bridge component, which performs encrypt and decrypt
  56      * operation based on xmlsec library.
  57      */
  58     com::sun::star::uno::Reference<
  59         com::sun::star::xml::crypto::XXMLEncryption > m_xXMLEncryption;
  60
  61     /*
  62      * the Id of template blocker.
  63      */
  64     sal_Int32 m_nIdOfBlocker;
  65
  66 protected:
  67     EncryptionEngine( );
  68     virtual ~EncryptionEngine(){};
  69
  70     virtual void tryToPerform( )
  71         throw (com::sun::star::uno::Exception, com::sun::star::uno::RuntimeException);
  72     virtual void clearUp( ) const;
  73     virtual bool checkReady() const;
  74
  75     /*
  76      * starts the main function. This method will be implemented by any sub-class.
  77      * For a Encryptor, it performs encryption operation;
  78      * for a Decryptor, decryption operation is performed.
  79      */
  80     virtual void startEngine( const com::sun::star::uno::Reference<
  81         com::sun::star::xml::crypto::XXMLEncryptionTemplate >&)
  82         throw (com::sun::star::uno::Exception, com::sun::star::uno::RuntimeException)
  83         {};
  84
  85 public:
  86     /* XBlockerMonitor */
  87     virtual void SAL_CALL setBlockerId( sal_Int32 id )
  88             throw (com::sun::star::uno::Exception, com::sun::star::uno::RuntimeException);
  89 };
  90
  91 #endif
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */