SimpleCrypt.h

Go to the documentation of this file.

/*
 * https://wiki.qt.io/Simple_encryption_with_SimpleCrypt#Versions
 * Copyright (c) 2011, Andre Somers
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the Rathenau Instituut, Andre Somers nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ANDRE SOMERS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR #######; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef SIMPLECRYPT_H
#define SIMPLECRYPT_H
 
#include <QString>
#include <QVector>
#include <QFlags>
#include <QByteArray>
#include <QtDebug>
#include <QtGlobal>
#include <QDateTime>
#include <QCryptographicHash>
#include <QDataStream>
#include <QRandomGenerator>
// STD
#include <iostream>
#include <assert.h>
#include <algorithm>
#include <sstream>
#include <stdio.h>
#include <stdlib.h>
 
class SimpleCrypt
{
    public:
 
        enum CompressionMode
        {
            CompressionAuto,    
            CompressionAlways,  
            CompressionNever    
        };
 
        enum IntegrityProtectionMode
        {
            ProtectionNone,    
            ProtectionChecksum,
            ProtectionHash     
        };
        // Error describes the type of error that occured.
        enum Error
        {
            ErrorNoError,         
            ErrorNoKeySet,        
            ErrorUnknownVersion,  
            ErrorIntegrityFailed  
        };
 
        SimpleCrypt();
 
        explicit SimpleCrypt(quint64 key);
 
        void setKey(quint64 key);
 
        bool hasKey() const {return !myKeyParts.isEmpty();}
 
        void setCompressionMode(CompressionMode mode) {myCompressionMode = mode;}
 
        CompressionMode compressionMode() const {return myCompressionMode;}
 
        void setIntegrityProtectionMode(IntegrityProtectionMode mode) {myProtectionMode = mode;}
        // Returns the IntegrityProtectionMode that is currently in use.
        IntegrityProtectionMode integrityProtectionMode() const {return myProtectionMode;}
 
        // Returns the last error that occurred.
        Error lastError() const {return myLastError;}
 
 
        QString encryptToString(const QString &plaintext);
 
        QString encryptToString(const QByteArray &plaintext);
 
        QByteArray encryptToByteArray(const QString &plaintext);
 
        QByteArray encryptToByteArray(const QByteArray &plaintext);
 
        QString decryptToString(const QString &cyphertext);
 
        QByteArray decryptToByteArray(const QString &cyphertext);
 
        QString decryptToString(const QByteArray &cypher);
 
        QByteArray decryptToByteArray(QByteArray cypher);
 
        enum CryptoFlag
        {
            CryptoFlagNone        = 0,    
            CryptoFlagCompression = 0x01, 
            CryptoFlagChecksum    = 0x02, 
            CryptoFlagHash        = 0x04  
        };
        Q_DECLARE_FLAGS(CryptoFlags, CryptoFlag);
        // Is Debug Message
        void setDebugMessage(bool thisState);        
        bool getDebugMessage();                      
        void setMessage(const QString &thisMessage); 
 
    private:
 
        void splitKey();
 
        quint64                 myKey;                  
        QVector<char>           myKeyParts;             
        CompressionMode         myCompressionMode;      
        IntegrityProtectionMode myProtectionMode;       
        Error                   myLastError;            
        bool                    isDebugMessage = true;  
}; // end class SimpleCrypt
Q_DECLARE_OPERATORS_FOR_FLAGS(SimpleCrypt::CryptoFlags)
#endif // SimpleCrypt_H