okular/generators/ooo/manifest.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Brad Hards <bradh@frogmouth.net>                *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  ***************************************************************************/
   9
  10 #ifndef OOO_MANIFEST_H
  11 #define OOO_MANIFEST_H
  12
  13 #include <QtCore/QByteArray>
  14 #include <QtCore/QMap>
  15 #include <QtCore/QString>
  16
  17 #ifdef QCA2
  18 #include <QtCrypto>
  19 #endif
  20
  21 namespace OOO {
  22
  23 /**
  24    OOO document manifest entry
  25
  26    This class holds the manifest information for a single file-entry element.
  27    An example of the XML that could be passed in is shown below, although
  28    not all manifest entries will have encryption-data.
  29 \code
  30 <manifest:file-entry manifest:media-type="image/jpeg" manifest:full-path="Pictures/100000000000032000000258912EB1C3.jpg" manifest:size="66704">
  31   <manifest:encryption-data>
  32     <manifest:algorithm manifest:algorithm-name="Blowfish CFB" manifest:initialisation-vector="T+miu403484="/>
  33     <manifest:key-derivation manifest:key-derivation-name="PBKDF2" manifest:iteration-count="1024" manifest:salt="aNYdmqv4cObAJSJjm4RzqA=="/>
  34   </manifest:encryption-data>
  35 </manifest:file-entry>
  36 \endcode
  37 */
  38 class ManifestEntry
  39 {
  40   public:
  41     /**
  42        Create a new manifest entry
  43     */
  44     ManifestEntry( const QString &fileName );
  45
  46     /**
  47        Set the mimetype of the file.
  48     */
  49     void setMimeType( const QString &mimeType );
  50
  51     /**
  52        Get the file name
  53     */
  54     QString fileName() const;
  55
  56     /**
  57        Set the file size.
  58
  59        This is only required for files with encryption
  60     */
  61     void setSize( const QString &size );
  62
  63     /**
  64        Get the mime type
  65     */
  66     QString mimeType() const;
  67
  68     /**
  69        Get the file size
  70
  71        This is only meaningful for files with encryption
  72     */
  73     QString size() const;
  74
  75     /**
  76        Set the checksum type.
  77
  78        This is only required for files with encryption
  79     */
  80     void setChecksumType( const QString &checksumType );
  81
  82     /**
  83        Set the checksum.
  84
  85        \param checksum the checksum in base64 encoding.
  86
  87        This is only required for files with encryption
  88     */
  89     void setChecksum( const QString &checksum );
  90
  91     /**
  92        Get the checksum type
  93
  94        This is only meaningful for files with encryption
  95     */
  96     QString checksumType() const;
  97
  98     /**
  99        Get the checksum
 100
 101        This is only meaningful for files with encryption
 102     */
 103     QByteArray checksum() const;
 104
 105     /**
 106        Set the algorithm name
 107
 108        This is only required for files with encryption
 109     */
 110     void setAlgorithm( const QString &algorithm );
 111
 112     /**
 113        Get the algorithm name
 114
 115        This is only meaningful for files with encryption
 116     */
 117     QString algorithm() const;
 118
 119     /**
 120        Set the initialisation vector for the cipher algorithm
 121
 122        \param initialisationVector the IV in base64 encoding.
 123
 124        This is only required for files with encryption
 125     */
 126     void setInitialisationVector( const QString &initialisationVector );
 127
 128     /**
 129        Get the initialisation vector for the cipher algorithm
 130
 131        This is only meaningful for files with encryption
 132     */
 133     QByteArray initialisationVector() const;
 134
 135     /**
 136        Set the name of the key derivation function
 137
 138        This is only required for files with encryption
 139     */
 140     void setKeyDerivationName( const QString &keyDerivationName );
 141
 142     /**
 143        Get the name of the key derivation function
 144
 145        This is only meaningful for files with encryption
 146     */
 147     QString keyDerivationName() const;
 148
 149     /**
 150        Set the iteration count for the key derivation function
 151
 152        This is only required for files with encryption
 153     */
 154     void setIterationCount( const QString &iterationCount );
 155
 156     /**
 157        Get the iteration count for the key derivation function
 158
 159        This is only meaningful for files with encryption
 160     */
 161     int iterationCount() const;
 162
 163     /**
 164        Set the salt for the key derivation function
 165
 166        \param salt the salt in base64 encoding.
 167
 168        This is only required for files with encryption
 169     */
 170     void setSalt( const QString &salt );
 171
 172     /**
 173        Get the salt for the key derivation function
 174
 175        This is only meaningful for files with encryption
 176     */
 177     QByteArray salt() const;
 178
 179  private:
 180    const QString m_fileName;
 181    QString m_mimeType;
 182    QString m_size;
 183    QString m_checksumType;
 184    QByteArray m_checksum;
 185    QString m_algorithm;
 186    QByteArray m_initialisationVector;
 187    QString m_keyDerivationName;
 188    int m_iterationCount;
 189    QByteArray m_salt;
 190 };
 191
 192
 193 /**
 194    OOO document manifest
 195
 196    The document manifest is described in the OASIS Open Office Specification
 197    (Version 1.1) section 17.7. This class represents the same data.
 198 */
 199 class Manifest
 200 {
 201   public:
 202     /**
 203        Create a new manifest.
 204
 205        \param odfFileName the name of the parent ODF file
 206        \param manifestData the data from the manifest file, as a byte array
 207        of the XML format data.
 208     */
 209     Manifest( const QString &odfFileName, const QByteArray &manifestData );
 210
 211     ~Manifest();
 212
 213     /**
 214        Check if the manifest indicates that a file is encrypted
 215     */
 216     bool testIfEncrypted( const QString &filename );
 217
 218     /**
 219        Decrypt data associated with a specific file
 220     */
 221     QByteArray decryptFile( const QString &filename, const QByteArray &fileData );
 222
 223   private:
 224     /**
 225        Retrieve the manifest data for a particular file
 226     */
 227     ManifestEntry* entryByName( const QString &filename );
 228
 229     /**
 230        Try to get the password for this file from the wallet
 231     */
 232     void getPasswordFromWallet();
 233
 234     /**
 235        Save the password for this file to the wallet
 236     */
 237     void savePasswordToWallet();
 238
 239     /**
 240        Verify whether the password we have is the right one.
 241
 242        This verifies the provided checksum
 243     */
 244     void checkPassword( ManifestEntry *entry, const QByteArray &fileData, QByteArray *decryptedData );
 245
 246     /**
 247        Ask the user for a password
 248     */
 249     void getPasswordFromUser();
 250
 251 #ifdef QCA2
 252     QCA::Initializer m_init;
 253 #endif
 254     const QString m_odfFileName;
 255     QMap<QString, ManifestEntry*> mEntries;
 256     bool m_haveGoodPassword;
 257     bool m_userCancelled;
 258     QString m_password;
 259 };
 260
 261 }
 262
 263 #endif