From c848fbc5ebd39dd498df12f24865a74b7ae3f8f7 Mon Sep 17 00:00:00 2001 From: Martchus Date: Wed, 22 Apr 2015 19:06:29 +0200 Subject: [PATCH] First commit --- aes/aes.cpp | 411 ++++++ aes/aes.h | 54 + general.pri | 71 ++ io/cryptoexception.cpp | 22 + io/cryptoexception.h | 20 + io/entry.cpp | 441 +++++++ io/entry.h | 178 +++ io/field.cpp | 71 ++ io/field.h | 117 ++ io/parsingexception.cpp | 23 + io/parsingexception.h | 20 + io/passwordfile.cpp | 538 ++++++++ io/passwordfile.h | 56 + passwordfile.doxygen | 2310 ++++++++++++++++++++++++++++++++++ passwordfile.pro | 77 ++ pkgbuild/default/PKGBUILD | 23 + pkgbuild/mingw-w64/PKGBUILD | 44 + util/openssl.cpp | 31 + util/openssl.h | 17 + util/opensslrandomdevice.cpp | 60 + util/opensslrandomdevice.h | 19 + util/testroutines.cpp | 37 + util/testroutines.h | 10 + 23 files changed, 4650 insertions(+) create mode 100644 aes/aes.cpp create mode 100644 aes/aes.h create mode 100644 general.pri create mode 100644 io/cryptoexception.cpp create mode 100644 io/cryptoexception.h create mode 100644 io/entry.cpp create mode 100644 io/entry.h create mode 100644 io/field.cpp create mode 100644 io/field.h create mode 100644 io/parsingexception.cpp create mode 100644 io/parsingexception.h create mode 100644 io/passwordfile.cpp create mode 100644 io/passwordfile.h create mode 100644 passwordfile.doxygen create mode 100644 passwordfile.pro create mode 100644 pkgbuild/default/PKGBUILD create mode 100644 pkgbuild/mingw-w64/PKGBUILD create mode 100644 util/openssl.cpp create mode 100644 util/openssl.h create mode 100644 util/opensslrandomdevice.cpp create mode 100644 util/opensslrandomdevice.h create mode 100644 util/testroutines.cpp create mode 100644 util/testroutines.h diff --git a/aes/aes.cpp b/aes/aes.cpp new file mode 100644 index 0000000..184f159 --- /dev/null +++ b/aes/aes.cpp @@ -0,0 +1,411 @@ +#include "aes.h" + +#include + +namespace Crypto { + + Aes::byte Aes::sbox[16][16] = { + { 0x63, 0x7C, 0x77, 0x7B, 0xF2, 0x6B, 0x6F, 0xC5, 0x30, 0x01, 0x67, 0x2B, 0xFE, 0xD7, 0xAB, 0x76 }, + { 0xCA, 0x82, 0xC9, 0x7D, 0xFA, 0x59, 0x47, 0xF0, 0xAD, 0xD4, 0xA2, 0xAF, 0x9C, 0xA4, 0x72, 0xC0 }, + { 0xB7, 0xFD, 0x93, 0x26, 0x36, 0x3F, 0xF7, 0xCC, 0x34, 0xA5, 0xE5, 0xF1, 0x71, 0xD8, 0x31, 0x15 }, + { 0x04, 0xC7, 0x23, 0xC3, 0x18, 0x96, 0x05, 0x9A, 0x07, 0x12, 0x80, 0xE2, 0xEB, 0x27, 0xB2, 0x75 }, + { 0x09, 0x83, 0x2C, 0x1A, 0x1B, 0x6E, 0x5A, 0xA0, 0x52, 0x3B, 0xD6, 0xB3, 0x29, 0xE3, 0x2F, 0x84 }, + { 0x53, 0xD1, 0x00, 0xED, 0x20, 0xFC, 0xB1, 0x5B, 0x6A, 0xCB, 0xBE, 0x39, 0x4A, 0x4C, 0x58, 0xCF }, + { 0xD0, 0xEF, 0xAA, 0xFB, 0x43, 0x4D, 0x33, 0x85, 0x45, 0xF9, 0x02, 0x7F, 0x50, 0x3C, 0x9F, 0xA8 }, + { 0x51, 0xA3, 0x40, 0x8F, 0x92, 0x9D, 0x38, 0xF5, 0xBC, 0xB6, 0xDA, 0x21, 0x10, 0xFF, 0xF3, 0xD2 }, + { 0xCD, 0x0C, 0x13, 0xEC, 0x5F, 0x97, 0x44, 0x17, 0xC4, 0xA7, 0x7E, 0x3D, 0x64, 0x5D, 0x19, 0x73 }, + { 0x60, 0x81, 0x4F, 0xDC, 0x22, 0x2A, 0x90, 0x88, 0x46, 0xEE, 0xB8, 0x14, 0xDE, 0x5E, 0x0B, 0xDB }, + { 0xE0, 0x32, 0x3A, 0x0A, 0x49, 0x06, 0x24, 0x5C, 0xC2, 0xD3, 0xAC, 0x62, 0x91, 0x95, 0xE4, 0x79 }, + { 0xE7, 0xC8, 0x37, 0x6D, 0x8D, 0xD5, 0x4E, 0xA9, 0x6C, 0x56, 0xF4, 0xEA, 0x65, 0x7A, 0xAE, 0x08 }, + { 0xBA, 0x78, 0x25, 0x2E, 0x1C, 0xA6, 0xB4, 0xC6, 0xE8, 0xDD, 0x74, 0x1F, 0x4B, 0xBD, 0x8B, 0x8A }, + { 0x70, 0x3E, 0xB5, 0x66, 0x48, 0x03, 0xF6, 0x0E, 0x61, 0x35, 0x57, 0xB9, 0x86, 0xC1, 0x1D, 0x9E }, + { 0xE1, 0xF8, 0x98, 0x11, 0x69, 0xD9, 0x8E, 0x94, 0x9B, 0x1E, 0x87, 0xE9, 0xCE, 0x55, 0x28, 0xDF }, + { 0x8C, 0xA1, 0x89, 0x0D, 0xBF, 0xE6, 0x42, 0x68, 0x41, 0x99, 0x2D, 0x0F, 0xB0, 0x54, 0xBB, 0x16 } + }; + + Aes::byte Aes::inv_sbox[16][16] = { + { 0x52, 0x09, 0x6a, 0xd5, 0x30, 0x36, 0xa5, 0x38, 0xbf, 0x40, 0xa3, 0x9e, 0x81, 0xf3, 0xd7, 0xfb }, + { 0x7c, 0xe3, 0x39, 0x82, 0x9b, 0x2f, 0xff, 0x87, 0x34, 0x8e, 0x43, 0x44, 0xc4, 0xde, 0xe9, 0xcb }, + { 0x54, 0x7b, 0x94, 0x32, 0xa6, 0xc2, 0x23, 0x3d, 0xee, 0x4c, 0x95, 0x0b, 0x42, 0xfa, 0xc3, 0x4e }, + { 0x08, 0x2e, 0xa1, 0x66, 0x28, 0xd9, 0x24, 0xb2, 0x76, 0x5b, 0xa2, 0x49, 0x6d, 0x8b, 0xd1, 0x25 }, + { 0x72, 0xf8, 0xf6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xd4, 0xa4, 0x5c, 0xcc, 0x5d, 0x65, 0xb6, 0x92 }, + { 0x6c, 0x70, 0x48, 0x50, 0xfd, 0xed, 0xb9, 0xda, 0x5e, 0x15, 0x46, 0x57, 0xa7, 0x8d, 0x9d, 0x84 }, + { 0x90, 0xd8, 0xab, 0x00, 0x8c, 0xbc, 0xd3, 0x0a, 0xf7, 0xe4, 0x58, 0x05, 0xb8, 0xb3, 0x45, 0x06 }, + { 0xd0, 0x2c, 0x1e, 0x8f, 0xca, 0x3f, 0x0f, 0x02, 0xc1, 0xaf, 0xbd, 0x03, 0x01, 0x13, 0x8a, 0x6b }, + { 0x3a, 0x91, 0x11, 0x41, 0x4f, 0x67, 0xdc, 0xea, 0x97, 0xf2, 0xcf, 0xce, 0xf0, 0xb4, 0xe6, 0x73 }, + { 0x96, 0xac, 0x74, 0x22, 0xe7, 0xad, 0x35, 0x85, 0xe2, 0xf9, 0x37, 0xe8, 0x1c, 0x75, 0xdf, 0x6e }, + { 0x47, 0xf1, 0x1a, 0x71, 0x1d, 0x29, 0xc5, 0x89, 0x6f, 0xb7, 0x62, 0x0e, 0xaa, 0x18, 0xbe, 0x1b }, + { 0xfc, 0x56, 0x3e, 0x4b, 0xc6, 0xd2, 0x79, 0x20, 0x9a, 0xdb, 0xc0, 0xfe, 0x78, 0xcd, 0x5a, 0xf4 }, + { 0x1f, 0xdd, 0xa8, 0x33, 0x88, 0x07, 0xc7, 0x31, 0xb1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xec, 0x5f }, + { 0x60, 0x51, 0x7f, 0xa9, 0x19, 0xb5, 0x4a, 0x0d, 0x2d, 0xe5, 0x7a, 0x9f, 0x93, 0xc9, 0x9c, 0xef }, + { 0xa0, 0xe0, 0x3b, 0x4d, 0xae, 0x2a, 0xf5, 0xb0, 0xc8, 0xeb, 0xbb, 0x3c, 0x83, 0x53, 0x99, 0x61 }, + { 0x17, 0x2b, 0x04, 0x7e, 0xba, 0x77, 0xd6, 0x26, 0xe1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0c, 0x7d } + }; + + Aes::word Aes::rcon[52] = { + 0x00000000, 0x01000000, 0x02000000, 0x04000000, 0x08000000, 0x10000000, 0x20000000, 0x40000000, + 0x80000000, 0x1B000000, 0x36000000, 0x6C000000, 0xD8000000, 0xAB000000, 0x4D000000, 0x9A000000, + 0x2F000000, 0x5E000000, 0xBC000000, 0x63000000, 0xC6000000, 0x97000000, 0x35000000, 0x6A000000, + 0xD4000000, 0xB3000000, 0x7D000000, 0xFA000000, 0xEF000000, 0xC5000000, 0x91000000, 0x39000000, + 0x72000000, 0xE4000000, 0xD3000000, 0xBD000000, 0x61000000, 0xC2000000, 0x9F000000, 0x25000000, + 0x4A000000, 0x94000000, 0x33000000, 0x66000000, 0xCC000000, 0x83000000, 0x1D000000, 0x3A000000, + 0x74000000, 0xE8000000, 0xCB000000, 0x8D000000 + }; + + Aes::Aes() : + key_length(0), + num_rounds(0), + w(0) + { + memset(state, 0, 16); + } + + Aes::~Aes() + { + } + + Aes::byte Aes::gmul(byte a, byte b) + { + unsigned char p = 0; + unsigned char hi; + + for(byte i = 0; i < 8; ++i) { + if((b & 1) == 1) + p ^= a; + hi = (a & 0x80); + a <<= 1; + if(hi == 0x80) + a ^= 0x1b; + b >>= 1; + } + return p; + } + +void Aes::rotWord(word *b) + { + byte tmp[4]; + memcpy(tmp, b, 4); + + byte tmpb = tmp[3]; + + for(byte i = 3; i > 0; --i) + tmp[i] = tmp[i - 1]; + + tmp[0] = tmpb; + + memcpy(b, tmp, 4); + } + +void Aes::subWord( word *b ) + { + byte tmp[ 4 ]; + memcpy( tmp, b, 4 ); + + for( byte i = 0; i < 4; ++i ) + tmp[ i ] = sbox[ tmp[ i ] >> 4 ][ tmp[ i ] & 0x0f ]; + + memcpy( b, tmp, 4 ); + } + +void Aes::expandKey( byte *key ) + { + if( w ) + delete [] w; + + w = new word[ 4 * ( num_rounds + 1 ) ]; + + for( byte iw = 0, ib = 0; iw < key_length; ++iw, ib += 4 ) + w[ iw ] = ( key[ ib ] << 24 ) + ( key[ ib + 1 ] << 16 ) + ( key[ ib + 2 ] << 8 ) + key[ ib + 3 ]; + + word tmp; + + for( byte i = key_length; i < ( 4 * ( num_rounds + 1 ) ); ++i ) { + + tmp = w[ i - 1 ]; + + if( ( i % key_length ) == 0 ) { + rotWord( &tmp ); + subWord( &tmp ); + tmp ^= rcon[ i / key_length ]; + } else if( ( key_length > 6 ) && ( ( i % key_length ) == 4 ) ) { + subWord( &tmp ); + } + + w[ i ] = w[ i - key_length ] ^ tmp; + } + } + +void Aes::addRoundKey( byte round ) + { + for( byte col = 0; col < 4; ++col ) + for( byte row = 0; row < 4; ++row ) + state[ row ][ col ] ^= ( w[ round * 4 + col ] >> ( 24 - row * 8 ) ) & 0x000000ff; + } + +void Aes::shiftRows( void ) + { + byte tmp = 0; + tmp = state[ 1 ][ 0 ]; + state[ 1 ][ 0 ] = state[ 1 ][ 1 ]; + state[ 1 ][ 1 ] = state[ 1 ][ 2 ]; + state[ 1 ][ 2 ] = state[ 1 ][ 3 ]; + state[ 1 ][ 3 ] = tmp; + + tmp = state[ 2 ][ 0 ]; + state[ 2 ][ 0 ] = state[ 2 ][ 2 ]; + state[ 2 ][ 2 ] = tmp; + tmp = state[ 2 ][ 1 ]; + state[ 2 ][ 1 ] = state[ 2 ][ 3 ]; + state[ 2 ][ 3 ] = tmp; + + tmp = state[ 3 ][ 3 ]; + state[ 3 ][ 3 ] = state[ 3 ][ 2 ]; + state[ 3 ][ 2 ] = state[ 3 ][ 1 ]; + state[ 3 ][ 1 ] = state[ 3 ][ 0 ]; + state[ 3 ][ 0 ] = tmp; + } + +void Aes::invShiftRows( void ) + { + byte tmp = 0; + tmp = state[ 3 ][ 0 ]; + state[ 3 ][ 0 ] = state[ 3 ][ 1 ]; + state[ 3 ][ 1 ] = state[ 3 ][ 2 ]; + state[ 3 ][ 2 ] = state[ 3 ][ 3 ]; + state[ 3 ][ 3 ] = tmp; + + tmp = state[ 2 ][ 0 ]; + state[ 2 ][ 0 ] = state[ 2 ][ 2 ]; + state[ 2 ][ 2 ] = tmp; + tmp = state[ 2 ][ 1 ]; + state[ 2 ][ 1 ] = state[ 2 ][ 3 ]; + state[ 2 ][ 3 ] = tmp; + + tmp = state[ 1 ][ 3 ]; + state[ 1 ][ 3 ] = state[ 1 ][ 2 ]; + state[ 1 ][ 2 ] = state[ 1 ][ 1 ]; + state[ 1 ][ 1 ] = state[ 1 ][ 0 ]; + state[ 1 ][ 0 ] = tmp; + } + +void Aes::mixColumns( void ) + { + unsigned char a[4]; + unsigned char b[4]; + unsigned char h = 0; + + for( byte col = 0; col < 4; ++col ) { + + for( byte row = 0; row < 4; ++row ) { + + a[ row ] = state[ row ][ col ]; + h = state[ row ][ col ] & 0x80; + b[ row ] = state[ row ][ col ] << 1; + + if( h == 0x80 ) + b[ row ] ^= 0x1b; + } + + state[ 0 ][ col ] = b[ 0 ] ^ a[ 3 ] ^ a[ 2 ] ^ b[ 1 ] ^ a[ 1 ]; + state[ 1 ][ col ] = b[ 1 ] ^ a[ 0 ] ^ a[ 3 ] ^ b[ 2 ] ^ a[ 2 ]; + state[ 2 ][ col ] = b[ 2 ] ^ a[ 1 ] ^ a[ 0 ] ^ b[ 3 ] ^ a[ 3 ]; + state[ 3 ][ col ] = b[ 3 ] ^ a[ 2 ] ^ a[ 1 ] ^ b[ 0 ] ^ a[ 0 ]; + } + } + +void Aes::invMixColumns( void ) + { + unsigned char a[4]; + + for( byte col = 0; col < 4; ++col ) { + + for( byte row = 0; row < 4; ++ row ) + a[ row ] = state[ row ][ col ]; + + state[ 0 ][ col ] = gmul( a[ 0 ], 14 ) ^ gmul( a[ 3 ], 9 ) ^ gmul( a[ 2 ], 13 ) ^ gmul( a[ 1 ], 11 ); + state[ 1 ][ col ] = gmul( a[ 1 ], 14 ) ^ gmul( a[ 0 ], 9 ) ^ gmul( a[ 3 ], 13 ) ^ gmul( a[ 2 ], 11 ); + state[ 2 ][ col ] = gmul( a[ 2 ], 14 ) ^ gmul( a[ 1 ], 9 ) ^ gmul( a[ 0 ], 13 ) ^ gmul( a[ 3 ], 11 ); + state[ 3 ][ col ] = gmul( a[ 3 ], 14 ) ^ gmul( a[ 2 ], 9 ) ^ gmul( a[ 1 ], 13 ) ^ gmul( a[ 0 ], 11 ); + } + + } + +bool Aes::setKey( char *key ) + { + + size_t key_len = strlen( key ); + + byte *w_key = 0; + byte des_key_len = 0; + + if( key_len <= 16 ) { + + key_length = 4; + num_rounds = 10; + des_key_len = 16; + + } else if( key_len <= 24 ) { + + key_length = 6; + num_rounds = 12; + des_key_len = 24; + + } else if( key_len <= 32 ) { + + key_length = 8; + num_rounds = 14; + des_key_len = 32; + + } + + w_key = new byte[ des_key_len ]; + + for( byte i = 0, t = 0; t < des_key_len; ++i, ++t ) { + if( i == key_len ) + i = 0; + *( w_key + t ) = *( key + i ); + } + + expandKey( w_key ); + + delete [] w_key; + + return true; + } + +void Aes::cipher( void ) + { + addRoundKey( 0 ); + + for( byte round = 1; round < num_rounds; ++round ) { + + for( byte row = 0; row < 4; ++row ) + for( byte col = 0; col < 4; ++col ) + state[ row ][ col ] = sbox[ state[ row ][ col ] >> 4 ][ state[ row ][ col ] & 0x0f ]; + + shiftRows( ); + mixColumns( ); + addRoundKey( round ); + } + + for( byte row = 0; row < 4; ++row ) + for( byte col = 0; col < 4; ++col ) + state[ row ][ col ] = sbox[ state[ row ][ col ] >> 4 ][ state[ row ][ col ] & 0x0f ]; + + shiftRows( ); + addRoundKey( num_rounds ); + } + +void Aes::invCipher( void ) + { + addRoundKey( num_rounds ); + + for( byte round = ( num_rounds - 1 ); round > 0; --round ) { + + invShiftRows( ); + + for( byte row = 0; row < 4; ++row ) + for( byte col = 0; col < 4; ++col ) + state[ row ][ col ] = inv_sbox[ state[ row ][ col ] >> 4 ][ state[ row ][ col ] & 0x0f ]; + + addRoundKey( round ); + invMixColumns( ); + } + + invShiftRows( ); + + for( byte row = 0; row < 4; ++row ) + for( byte col = 0; col < 4; ++col ) + state[ row ][ col ] = inv_sbox[ state[ row ][ col ] >> 4 ][ state[ row ][ col ] & 0x0f ]; + + addRoundKey( 0 ); + } + + size_t Aes::encrypt( char **data, size_t length, char *key ) + { + if( length == 0 ) + return 0; + + if( !setKey( key ) ) + return 0; + + size_t old_length = length; + while( length % 16 ) + ++length; + + char *buffer = new char[ length ]; + memset( buffer, 0, length ); + memcpy( buffer, *data, old_length ); + + delete [] *data; + *data = buffer; + + size_t cur_block = 0; + + do { + + for( byte col = 0; col < 4; ++col ) + for( byte row = 0; row < 4; ++row ) + state[ row ][ col ] = static_cast< byte >( ( *data )[ cur_block * 16 + row + 4 * col ] ); + + cipher( ); + + for( byte col = 0; col < 4; ++col ) + for( byte row = 0; row < 4; ++row ) + ( *data )[ cur_block * 16 + row + 4 * col ] = static_cast< char >( state[ row ][ col ] ); + + ++cur_block; + + } while( cur_block * 16 != length ); + + return cur_block; + } + + size_t Aes::decrypt( char **data, size_t length, char *key ) + { + if( length == 0 ) + return 0; + + if( !setKey( key ) ) + return 0; + + size_t old_length = length; + while( length % 16 ) + ++length; + + char *buffer = new char[ length ]; + memset( buffer, 0, length ); + memcpy( buffer, *data, old_length ); + + delete [] *data; + *data = buffer; + + size_t cur_block = 0; + + do { + + for( byte col = 0; col < 4; ++col ) + for( byte row = 0; row < 4; ++row ) + state[ row ][ col ] = static_cast< byte >( ( *data )[ cur_block * 16 + row + 4 * col ] ); + + invCipher( ); + + for( byte col = 0; col < 4; ++col ) + for( byte row = 0; row < 4; ++row ) + ( *data )[ cur_block * 16 + row + 4 * col ] = static_cast< char >( state[ row ][ col ] ); + + ++cur_block; + + } while( cur_block * 16 != length ); + + --length; + + while( ! ( ( *buffer ) + length ) ) + --length; + + ++length; + + return length; + } + +} diff --git a/aes/aes.h b/aes/aes.h new file mode 100644 index 0000000..4ddb259 --- /dev/null +++ b/aes/aes.h @@ -0,0 +1,54 @@ +#ifndef AES_INCLUDED +#define AES_INCLUDED AES_INCLUDED + +#include + +#include + +namespace Crypto { + +class LIB_EXPORT Aes { + +public: + typedef unsigned char byte; + typedef unsigned long word; + + Aes(); + ~Aes(); + + size_t encrypt(char **data, size_t length, char *key); + size_t decrypt(char **data, size_t length, char *key); + +private: + static byte gmul(byte a, byte b); + static void rotWord(word *b ); + static void subWord(word *b ); + + bool setKey(char *key); + void expandKey(byte *key); + + void addRoundKey(byte round); + + void shiftRows(void); + void invShiftRows(void); + + void mixColumns(void); + void invMixColumns(void); + + void cipher(void); + void invCipher(void); + + static byte sbox[16][16]; + static byte inv_sbox[16][16]; + static word rcon[52]; + + byte key_length; + byte num_rounds; + + word *w; + byte state[4][4]; +}; + +} + +#endif /* AES_INCLUDED */ diff --git a/general.pri b/general.pri new file mode 100644 index 0000000..9156999 --- /dev/null +++ b/general.pri @@ -0,0 +1,71 @@ +# template +TEMPLATE = lib +#dirs +UI_DIR = ./gui +MOC_DIR = ./moc +OBJECTS_DIR = ./obj +RCC_DIR = ./res +# compiler flags +QMAKE_CXXFLAGS += -std=c++11 +QMAKE_LFLAGS += -std=c++11 +unix { + QMAKE_LFLAGS += "-Wl,--rpath=./" +} +# prefix +targetprefix = . +# target +CONFIG(debug, debug|release) { + TARGET = $$targetprefix/$${projectname}d +} else { + TARGET = $$targetprefix/$$projectname +} +# variables to check target architecture +win32-g++:QMAKE_TARGET.arch = $$QMAKE_HOST.arch +win32-g++-32:QMAKE_TARGET.arch = x86 +win32-g++-64:QMAKE_TARGET.arch = x86_64 +linux-g++:QMAKE_TARGET.arch = $$QMAKE_HOST.arch +linux-g++-32:QMAKE_TARGET.arch = x86 +linux-g++-64:QMAKE_TARGET.arch = x86_64 +# configuration +mobile { + DEFINES += CONFIG_MOBILE +} else:desktop { + DEFINES += CONFIG_DESKTOP +} else:android { + CONFIG += mobile + DEFINES += CONFIG_MOBILE +} else { + CONFIG += desktop + DEFINES += CONFIG_DESKTOP +} +no-gui { + QT -= gui + DEFINES += GUI_NONE + guiqtquick || guiqtwidgets { + error("Can not use no-gui with guiqtquick or guiqtwidgets.") + } else { + message("Configured for no GUI support.") + } +} else { + QT += gui + mobile { + CONFIG += guiqtquick + } + desktop { + CONFIG += guiqtwidgets + } +} +guiqtquick { + message("Configured for Qt Quick GUI support.") + greaterThan(QT_MAJOR_VERSION, 4): QT += quick + CONFIG(debug, debug|release) { + CONFIG += qml_debug + } + DEFINES += GUI_QTQUICK +} +guiqtwidgets { + message("Configured for Qt widgets GUI support.") + greaterThan(QT_MAJOR_VERSION, 4): QT += widgets + DEFINES += GUI_QTWIDGETS + DEFINES += MODEL_UNDO_SUPPORT +} diff --git a/io/cryptoexception.cpp b/io/cryptoexception.cpp new file mode 100644 index 0000000..083cb3b --- /dev/null +++ b/io/cryptoexception.cpp @@ -0,0 +1,22 @@ +#include "cryptoexception.h" + +namespace Io { +/*! + * \class CryptoException + * \brief The exception that is thrown when an encryption/decryption error occurs. + */ + +/*! + * \brief Constructs a crypto exception. + */ +CryptoException::CryptoException(const std::string &openSslErrorQueue) USE_NOTHROW : + runtime_error(openSslErrorQueue) +{} + +/*! + * \brief Destroys the exception. + */ +CryptoException::~CryptoException() USE_NOTHROW +{} + +} diff --git a/io/cryptoexception.h b/io/cryptoexception.h new file mode 100644 index 0000000..883526d --- /dev/null +++ b/io/cryptoexception.h @@ -0,0 +1,20 @@ +#ifndef CRYPTOFAILUREEXCEPTION_H +#define CRYPTOFAILUREEXCEPTION_H + +#include + +#include +#include + +namespace Io { + +class LIB_EXPORT CryptoException : public std::runtime_error +{ +public: + CryptoException(const std::string &openSslErrorQueue) USE_NOTHROW; + virtual ~CryptoException() USE_NOTHROW; +}; + +} + +#endif // CRYPTOFAILUREEXCEPTION_H diff --git a/io/entry.cpp b/io/entry.cpp new file mode 100644 index 0000000..387bc42 --- /dev/null +++ b/io/entry.cpp @@ -0,0 +1,441 @@ +#include "entry.h" +#include "parsingexception.h" + +#include +#include + +#include +#include + +using namespace std; +using namespace IoUtilities; +using namespace ConversionUtilities; + +namespace Io { + +/*! + * \namespace Io + * \brief Contains all IO related classes. + */ + +/*! + * \class Entry + * \brief Instances of the Entry class form a hierarchic data strucutre used to store + * account information. + * + * Entries can be serialized and deserialized using the parse() and make() methods. + */ + +/*! + * \brief Constructs a new entry with the specified \a label and \a parent. + */ +Entry::Entry(const string &label, NodeEntry *parent) : + m_parent(nullptr), + m_index(-1) +{ + setParent(parent); + setLabel(label); +} + +/*! + * \brief Constructs a copy of the another entry. + * \remarks The copy will be parentless and thus not be embedded in the hierarchy + * of \a other. Child entries will be copied as well. + */ +Entry::Entry(const Entry &other) : + m_label(other.m_label), + m_parent(nullptr), + m_index(-1) +{} + +/*! + * \brief Destroys the entry. + */ +Entry::~Entry() +{ + setParent(nullptr); +} + +/*! + * \brief Internally called to make the label unique. + * \sa setLabel() + */ +void Entry::makeLabelUnique() +{ + if(m_parent) { + int index = 1; + string currentLabel(label()); + checkLabel: + for(Entry *sibling : m_parent->children()) { + if(sibling != this && currentLabel == sibling->label()) { + stringstream newLabel(currentLabel); + newLabel.seekp(0, ios_base::end); + if(newLabel.tellp()) { + newLabel << ' '; + } + newLabel << ++index; + currentLabel = newLabel.str(); + goto checkLabel; + } + } + m_label = currentLabel; + } +} + +/*! + * \brief Sets the \a parent for the entry. + * + * If an \a index is specified the entry will be inserted as child at this position. + * If \a parent is nullptr, the entry will be parentless. + */ +void Entry::setParent(NodeEntry *parent, int index) +{ + if(m_parent != parent || (m_index != index && index >= 0)) { + if(m_parent) { + m_parent->m_children.erase(m_parent->m_children.begin() + m_index); + for(auto i = m_parent->m_children.begin() + m_index; i < m_parent->m_children.end(); ++i) { + (*i)->m_index -= 1; + } + } + if(parent) { + if(index < 0 || static_cast(index) >= parent->m_children.size()) { + m_index = parent->m_children.size(); + parent->m_children.push_back(this); + } else { + for(auto i = parent->m_children.insert(parent->m_children.begin() + index, this) + 1; + i != parent->m_children.end(); ++i) { + (*i)->m_index += 1; + } + m_index = index; + } + } else { + m_index = -1; + } + m_parent = parent; + makeLabelUnique(); + } +} + +/*! + * \brief Returns an indication whether the instance is an indirect child of the specified \a entry. + */ +bool Entry::isIndirectChildOf(NodeEntry *entry) const +{ + if(parent()) { + if(parent() == entry) { + return true; + } else { + return parent()->isIndirectChildOf(entry); + } + } else { + return false; + } +} + +/*! + * \brief Returns the path of the entry. + */ +std::list Entry::path() const +{ + list res; + path(res); + return res; +} + +/*! + * \brief Stores to path of the entry in the specified list of string. + */ +void Entry::path(std::list &res) const +{ + if(m_parent) { + m_parent->path(res); + } + res.push_back(label()); +} + +/*! + * \brief Parses an entry from the specified \a stream. + * \throws Throws ParsingException when a parsing exception occurs. + */ +Entry *Entry::parse(istream &stream) +{ + byte version = stream.peek(); + if(denotesNodeEntry(version)) { + return new NodeEntry(stream); + } else { + return new AccountEntry(stream); + } +} + +/*! + * \fn Entry::type() + * \brief Returns the type of the entry. + */ + +/*! + * \fn Entry::make() + * \brief Serializes the entry to the specified \a stream. + */ + +/*! + * \fn Entry::clone() + * \brief Clones the entry. + * \remarks The copy will be parentless and thus not be embedded in the hierarchy + * of \a other. Child entries will be copied as well. + */ + +/*! + * \class NodeEntry + * \brief The NodeEntry class acts as parent for other entries. + */ + +/*! + * \brief Constructs a new node entry. + */ +NodeEntry::NodeEntry() : + Entry(), + m_expandedByDefault(true) +{} + +/*! + * \brief Constructs a new node entry with the specified \a label and \a parent. + */ +NodeEntry::NodeEntry(const string &label, NodeEntry *parent) : + Entry(label, parent), + m_expandedByDefault(true) +{} + +/*! + * \brief Constructs a new node entry which is deserialized from the specified \a stream. + */ +NodeEntry::NodeEntry(istream &stream) : + m_expandedByDefault(true) +{ + BinaryReader reader(&stream); + byte version = reader.readByte(); + if(denotesNodeEntry(version)) { + if(version == 0x0 || version == 0x1) { + setLabel(reader.readLengthPrefixedString()); + if(version == 0x1) { // version 0x1 has an extended header + uint16 extendedHeaderSize = reader.readUInt16BE(); + if(extendedHeaderSize >= 1) { + byte flags = reader.readByte(); + m_expandedByDefault = flags & 0x80; + extendedHeaderSize -= 1; + } + stream.seekg(extendedHeaderSize, ios_base::cur); + } + uint32 childCount = reader.readUInt32BE(); + for(uint32 i = 0; i < childCount; ++i) { + Entry::parse(stream)->setParent(this); + } + } else { + throw ParsingException("Entry version not supported."); + } + } else { + throw ParsingException("Node entry expected."); + } +} + +/*! + * \brief Constructs a copy of the another entry. + * \remarks The copy will be parentless and thus not be embedded in the hierarchy + * of \a other. Child entries will be copied as well. + */ +NodeEntry::NodeEntry(const NodeEntry &other) : + Entry(other) +{ + for(Entry *otherChild : other.m_children) { + Entry *clonedChild = otherChild->clone(); + clonedChild->m_parent = this; + clonedChild->m_index = m_children.size(); + m_children.push_back(clonedChild); + } +} + +/*! + * \brief Destroys the entry. + */ +NodeEntry::~NodeEntry() +{ + for(Entry *child : m_children) { + child->m_parent = nullptr; + delete child; + } +} + +/*! + * \brief Deletes children from the node entry. + * \param begin Specifies the index of the first children to delete. + * \param end Specifies the index after the last children to delete. + */ +void NodeEntry::deleteChildren(int begin, int end) +{ + auto iterator = m_children.cbegin() + begin; + auto endIterator = m_children.begin() + end; + for(; iterator < endIterator; ++iterator) { + (*iterator)->m_parent = nullptr; + delete *iterator; + } + m_children.erase(m_children.begin() + begin, endIterator); +} + +/*! + * \brief Replaces the child \a at the specified index with the specified \a newChild. + */ +void NodeEntry::replaceChild(size_t at, Entry *newChild) +{ + if(at < m_children.size()) { + m_children.at(at)->m_parent = nullptr; + m_children[at] = newChild; + } +} + +/*! + * \brief Returns an entry specified by the provided \a path. + * \param path Specifies the path of the entry to be returned. + * \param includeThis Specifies whether the current instance should be included. + * \param creationType Specifies a pointer which dereferenced value determines what kind of entry should be created + * if the entry specified by the provided \a path does not exist. The parent of the entry + * to be created must exist. Specify nullptr if no entries should be created (default). + * \returns Returns the entry if found (or created); otherwise nullptr is returned. + */ +Entry *NodeEntry::entryByPath(list &path, bool includeThis, EntryType *creationType) +{ + if(path.size()) { + if(includeThis) { + if(path.front() == label()) { + path.pop_front(); + } else { + return nullptr; + } + } + if(path.size()) { + for(Entry *child : m_children) { + if(path.front() == child->label()) { + path.pop_front(); + if(path.empty()) { + return child; + } else if(child->type() == EntryType::Node) { + return static_cast(child)->entryByPath(path, false, creationType); + } else { + return nullptr; // can not resolve path since an account entry can not have children + } + } + } + if(creationType) { + if(path.size() == 1) { + switch(*creationType) { + case EntryType::Account: + return new AccountEntry(path.front(), this); + case EntryType::Node: + return new NodeEntry(path.front(), this); + } + } else { + return nullptr; + } + } + } else { + return this; + } + } + return nullptr; +} + +void NodeEntry::make(ostream &stream) const +{ + BinaryWriter writer(&stream); + writer.writeByte(isExpandedByDefault() ? 0x0 : 0x1); // version + writer.writeLengthPrefixedString(label()); + if(!isExpandedByDefault()) { + writer.writeUInt16BE(1); // extended header is 1 byte long + writer.writeByte(0x00); // all flags cleared + } + writer.writeUInt32BE(m_children.size()); + for(const Entry *child : m_children) { + child->make(stream); + } +} + +NodeEntry *NodeEntry::clone() const +{ + return new NodeEntry(*this); +} + +/*! + * \class AccountEntry + * \brief The exception that is thrown when a parsing error occurs. + */ + +AccountEntry::AccountEntry() +{} + +/*! + * \brief Constructs a new account entry with the specified \a label and \a parent. + */ +AccountEntry::AccountEntry(const string &label, NodeEntry *parent) : + Entry(label, parent) +{} + +/*! + * \brief Constructs a new account entry which is deserialized from the specified \a stream. + */ +AccountEntry::AccountEntry(istream &stream) +{ + BinaryReader reader(&stream); + byte version = reader.readByte(); + if(!denotesNodeEntry(version)) { + version ^= 0x80; // set bit 0 to false + if(version == 0x0 || version == 0x1) { + setLabel(reader.readLengthPrefixedString()); + if(version == 0x1) { // version 0x1 has an extended header + uint16 extendedHeaderSize = reader.readUInt16BE(); + // currently there's nothing to read here + stream.seekg(extendedHeaderSize, ios_base::cur); + } + uint32 fieldCount = reader.readUInt32BE(); + for(uint32 i = 0; i < fieldCount; ++i) { + m_fields.push_back(Field(this, stream)); + } + } else { + throw ParsingException("Entry version not supported."); + } + } else { + throw ParsingException("Account entry expected."); + } +} + +/*! + * \brief Constructs a copy of the another entry. + * \remarks The copy will be parentless and thus not be embedded in the hierarchy + * of \a other. Child entries will be copied as well. + */ +AccountEntry::AccountEntry(const AccountEntry &other) : + Entry(other) +{ + m_fields = other.m_fields; +} + +/*! + * \brief Destroys the entry. + */ +AccountEntry::~AccountEntry() +{} + +void AccountEntry::make(ostream &stream) const +{ + BinaryWriter writer(&stream); + writer.writeByte(0x80 | 0x0); // version + writer.writeLengthPrefixedString(label()); + writer.writeUInt32BE(m_fields.size()); + for(const Field &field : m_fields) { + field.make(stream); + } +} + +AccountEntry *AccountEntry::clone() const +{ + return new AccountEntry(*this); +} + +} diff --git a/io/entry.h b/io/entry.h new file mode 100644 index 0000000..45531a8 --- /dev/null +++ b/io/entry.h @@ -0,0 +1,178 @@ +#ifndef ENTRY_H +#define ENTRY_H + +#include "field.h" + +#include +#include + +#include +#include +#include +#include + +namespace Io { + +/*! + * \brief Specifies the entry type. + */ +enum class EntryType : int +{ + Node, /**< denotes a NodeEntry */ + Account /**< denotes an AccountEntry */ +}; + +class NodeEntry; + +class LIB_EXPORT Entry +{ + friend class NodeEntry; +public: + virtual ~Entry(); + Entry &operator=(const Entry &other) = delete; + virtual EntryType type() const = 0; + const std::string &label() const; + void setLabel(const std::string &label); + void makeLabelUnique(); + NodeEntry *parent() const; + void setParent(NodeEntry *parent, int index = -1); + int index() const; + bool isIndirectChildOf(NodeEntry *entry) const; + std::list path() const; + void path(std::list &res) const; + virtual void make(std::ostream &stream) const = 0; + virtual Entry *clone() const = 0; + static Entry *parse(std::istream &stream); + static bool denotesNodeEntry(byte version); + +protected: + Entry(const std::string &label = std::string(), NodeEntry *parent = nullptr); + Entry(const Entry &other); + +private: + std::string m_label; + NodeEntry *m_parent; + int m_index; +}; + +/*! + * \brief Returns the label. + */ +inline const std::string &Entry::label() const +{ + return m_label; +} + +/*! + * \brief Sets the label. + * \remarks The label might be modified to ensure that each child entry within a certain parent + * has a unique label. + */ +inline void Entry::setLabel(const std::string &label) +{ + m_label = label; + makeLabelUnique(); +} + +/*! + * \brief Returns the parent entry. + * \remarks Returns nullptr for top-level entries. + */ +inline NodeEntry *Entry::parent() const +{ + return m_parent; +} + +/*! + * \brief Returns the index of the entry within its parent. Returns -1 for parentless entries. + */ +inline int Entry::index() const +{ + return m_index; +} + +class LIB_EXPORT NodeEntry : public Entry +{ + friend class Entry; +public: + NodeEntry(); + NodeEntry(const std::string &label, NodeEntry *parent = nullptr); + NodeEntry(std::istream &stream); + NodeEntry(const NodeEntry &other); + ~NodeEntry(); + + virtual EntryType type() const; + const std::vector &children() const; + void deleteChildren(int begin, int end); + void replaceChild(size_t at, Entry *newChild); + Entry *entryByPath(std::list &path, bool includeThis = true, EntryType *creationType = nullptr); + bool isExpandedByDefault() const; + void setExpandedByDefault(bool expandedByDefault); + virtual void make(std::ostream &stream) const; + virtual NodeEntry *clone() const; +private: + std::vector m_children; + bool m_expandedByDefault; +}; + +inline EntryType NodeEntry::type() const +{ + return EntryType::Node; +} + +inline const std::vector &NodeEntry::children() const +{ + return m_children; +} + +inline bool NodeEntry::isExpandedByDefault() const +{ + return m_expandedByDefault; +} + +inline void NodeEntry::setExpandedByDefault(bool expandedByDefault) +{ + m_expandedByDefault = expandedByDefault; +} + +inline bool Entry::denotesNodeEntry(byte version) +{ + return (version & 0x80) == 0; +} + +class LIB_EXPORT AccountEntry : public Entry +{ +public: + AccountEntry(); + AccountEntry(const std::string &label, NodeEntry *parent = nullptr); + AccountEntry(std::istream &stream); + AccountEntry(const AccountEntry &other); + ~AccountEntry(); + + virtual EntryType type() const; + const std::vector &fields() const; + std::vector &fields(); + virtual void make(std::ostream &stream) const; + virtual AccountEntry *clone() const; +private: + std::vector m_fields; +}; + +inline EntryType AccountEntry::type() const +{ + return EntryType::Account; +} + +inline const std::vector &AccountEntry::fields() const +{ + return m_fields; +} + +inline std::vector &AccountEntry::fields() +{ + return m_fields; +} + +} + +#endif // ENTRY_H diff --git a/io/field.cpp b/io/field.cpp new file mode 100644 index 0000000..e21d249 --- /dev/null +++ b/io/field.cpp @@ -0,0 +1,71 @@ +#include "field.h" +#include "parsingexception.h" + +#include +#include + +using namespace std; +using namespace IoUtilities; +using namespace ConversionUtilities; + +namespace Io { + +/*! + * \class Field + * \brief The Field class holds field information which consists of a name and a value + * and is able to serialize and deserialize this information. + */ + +/*! + * \brief Constructs a new account entry for the specified account with the specified \a name + * and \a value. + */ +Field::Field(AccountEntry *tiedAccount, const string &name, const string &value) : + m_name(name), + m_value(value), + m_type(FieldType::Normal), + m_tiedAccount(tiedAccount) +{} + +/*! + * \brief Constructs a new account entry for the specified account which is deserialize from + * the specified \a stream. + * \throws Throws ParsingException when an parsing error occurs. + */ +Field::Field(AccountEntry *tiedAccount, istream &stream) +{ + BinaryReader reader(&stream); + int version = reader.readByte(); + if(version == 0x0 || version == 0x1) { + m_name = reader.readLengthPrefixedString(); + m_value = reader.readLengthPrefixedString(); + byte type = reader.readByte(); + if(isValidType(type)) { + m_type = static_cast(type); + } else { + throw ParsingException("Field type is not supported."); + } + if(version == 0x1) { // version 0x1 has an extended header + uint16 extendedHeaderSize = reader.readUInt16BE(); + // currently there's nothing to read here + stream.seekg(extendedHeaderSize, ios_base::cur); + } + m_tiedAccount = tiedAccount; + } else { + throw ParsingException("Field version is not supported."); + } +} + +/*! + * \brief Serializes the current instance to the specified \a stream. + */ +void Field::make(ostream &stream) const +{ + BinaryWriter writer(&stream); + writer.writeByte(0x0); // version + writer.writeLengthPrefixedString(m_name); + writer.writeLengthPrefixedString(m_value); + writer.writeByte(static_cast(m_type)); +} + +} diff --git a/io/field.h b/io/field.h new file mode 100644 index 0000000..19b70a6 --- /dev/null +++ b/io/field.h @@ -0,0 +1,117 @@ +#ifndef FIELD_H +#define FIELD_H + +#include + +#include +#include + +namespace Io { + +enum class FieldType : int +{ + Normal, + Password +}; + +class AccountEntry; + +class LIB_EXPORT Field +{ +public: + Field(AccountEntry *tiedAccount, const std::string &name = std::string(), const std::string &value = std::string()); + Field(AccountEntry *tiedAccount, std::istream &stream); + + bool isEmpty() const; + const std::string &name() const; + void setName(const std::string &name); + const std::string &value() const; + void setValue(const std::string &value); + FieldType type() const; + void setType(FieldType type); + AccountEntry *tiedAccount() const; + void make(std::ostream &stream) const; + static bool isValidType(int number); + +private: + std::string m_name; + std::string m_value; + FieldType m_type; + AccountEntry *m_tiedAccount; +}; + +/*! + * \brief Returns an indication whether the entry is empty. + */ +inline bool Field::isEmpty() const +{ + return m_name.empty() && m_value.empty(); +} + +/*! + * \brief Returns the name. + */ +inline const std::string &Field::name() const +{ + return m_name; +} + +/*! + * \brief Sets the name. + */ +inline void Field::setName(const std::string &name) +{ + m_name = name; +} + +/*! + * \brief Returns the value. + */ +inline const std::string &Field::value() const +{ + return m_value; +} + +/*! + * \brief Sets the value. + */ +inline void Field::setValue(const std::string &value) +{ + m_value = value; +} + +/*! + * \brief Returns the type. + */ +inline FieldType Field::type() const +{ + return m_type; +} + +/*! + * \brief Sets the type. + */ +inline void Field::setType(FieldType type) +{ + m_type = type; +} + +/*! + * \brief Returns the tied account. + */ +inline AccountEntry *Field::tiedAccount() const +{ + return m_tiedAccount; +} + +/*! + * \brief Returns whether the specified \a number is a valid field type. + */ +inline bool Field::isValidType(int number) +{ + return number >= 0 && number <= 1; +} + +} + +#endif // FIELD_H diff --git a/io/parsingexception.cpp b/io/parsingexception.cpp new file mode 100644 index 0000000..481ca19 --- /dev/null +++ b/io/parsingexception.cpp @@ -0,0 +1,23 @@ +#include "parsingexception.h" + +namespace Io { + +/*! + * \class ParsingException + * \brief The exception that is thrown when a parsing error occurs. + */ + +/*! + * \brief Constructs a parsing exception. + */ +ParsingException::ParsingException(const std::string &message) USE_NOTHROW : + runtime_error(message) +{} + +/*! + * \brief Destroys the exception. + */ +ParsingException::~ParsingException() USE_NOTHROW +{} + +} diff --git a/io/parsingexception.h b/io/parsingexception.h new file mode 100644 index 0000000..8a08f3b --- /dev/null +++ b/io/parsingexception.h @@ -0,0 +1,20 @@ +#ifndef PARSINGEXCEPTION_H +#define PARSINGEXCEPTION_H + +#include + +#include +#include + +namespace Io { + +class LIB_EXPORT ParsingException : public std::runtime_error +{ +public: + ParsingException(const std::string &message = std::string()) USE_NOTHROW; + virtual ~ParsingException() USE_NOTHROW; +}; + +} + +#endif // PARSINGEXCEPTION_H diff --git a/io/passwordfile.cpp b/io/passwordfile.cpp new file mode 100644 index 0000000..b584561 --- /dev/null +++ b/io/passwordfile.cpp @@ -0,0 +1,538 @@ +#include "passwordfile.h" +#include "cryptoexception.h" +#include "parsingexception.h" +#include "entry.h" + +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include + +using namespace std; +using namespace IoUtilities; + +namespace Io { + +const unsigned int aes256cbcIvSize = 16U; + +/*! + * \class PasswordFile + * \brief The PasswordFile class holds account information in the form of Entry and Field instances + * and provides methods to read and write these information to encrypted files using OpenSSL. + */ + +/*! + * \brief Constructs a new password file. + */ +PasswordFile::PasswordFile() : + m_freader(BinaryReader(&m_file)), + m_fwriter(BinaryWriter(&m_file)) +{ + m_file.exceptions(ios_base::failbit | ios_base::badbit); + clearPassword(); +} + +/*! + * \brief Constructs a new password file with the specified \a path and \a password. + */ +PasswordFile::PasswordFile(const string &path, const string &password) : + m_freader(BinaryReader(&m_file)), + m_fwriter(BinaryWriter(&m_file)) +{ + m_file.exceptions(ios_base::failbit | ios_base::badbit); + setPath(path); + setPassword(password); +} + +/*! + * \brief Constructs a copy of another password file. + */ +PasswordFile::PasswordFile(const PasswordFile &other) : + m_path(other.m_path), + m_freader(BinaryReader(&m_file)), + m_fwriter(BinaryWriter(&m_file)) +{ + m_file.exceptions(ios_base::failbit | ios_base::badbit); + setPath(other.path()); + memcpy(m_password, other.m_password, 32); +} + +/*! + * \brief Closes the file if still opened and destroys the instance. + */ +PasswordFile::~PasswordFile() +{ + close(); +} + +/*! + * \brief Opens the file. Does not load the contents (see load()). + * \throws Throws ios_base::failure when an IO error occurs. + */ +void PasswordFile::open(bool readOnly) +{ + close(); + if(m_path.empty()) { + throw ios_base::failure("Unable to open file because path is emtpy."); + } + m_file.open(m_path, readOnly ? ios_base::in | ios_base::binary : ios_base::in | ios_base::out | ios_base::binary); + m_file.seekg(0, ios_base::end); + if(m_file.tellg() == 0) { + throw ios_base::failure("File is empty."); + } else { + m_file.seekg(0); + } +} + +/*! + * \brief Generates a new root entry for the file. + */ +void PasswordFile::generateRootEntry() +{ + if(!m_rootEntry) { + m_rootEntry.reset(new NodeEntry("accounts")); + } +} + +/*! + * \brief Creates the file. Does not generate a new root element (see generateRootElement()). + * \throws Throws ios_base::failure when an IO error occurs. + */ +void PasswordFile::create() +{ + close(); + if(m_path.empty()) { + throw ios_base::failure("Unable to create file because path is empty."); + } + m_file.open(m_path, fstream::out | fstream::trunc | fstream::binary); +} + +/*! + * \brief Reads the contents of the file. Opens the file if not already opened. Replaces + * the current root entry with the new one constructed from the file contents. + * \throws Throws ios_base::failure when an IO error occurs. + * \throws Throws Io::ParsingException when a parsing error occurs. + * \throws Throws Io::CryptoException when a decryption error occurs. + * \throws Throws ConversionUtilities::ConversionException when a conversion error occurs. + */ +void PasswordFile::load() +{ + if(!m_file.is_open()) { + open(); + } + m_file.seekg(0); + // check magic number + if(m_freader.readUInt32LE() != 0x7770616DU) { + throw ParsingException("Signature not present."); + } + // check version and flags (used in version 0x3 only) + uint32 version = m_freader.readUInt32LE(); + if(version != 0x0U && version != 0x1U && version != 0x2U && version != 0x3U) + throw ParsingException("Version is unknown."); + bool decrypterUsed; + bool ivUsed; + bool compressionUsed; + if(version == 0x3U) { + byte flags = m_freader.readByte(); + decrypterUsed = flags & 0x80; + ivUsed = flags & 0x40; + compressionUsed = flags & 0x20; + } else { + decrypterUsed = version >= 0x1U; + ivUsed = version == 0x2U; + compressionUsed = false; + } + // get length + fstream::pos_type headerSize = m_file.tellg(); + m_file.seekg(0, ios_base::end); + fstream::pos_type size = m_file.tellg(); + m_file.seekg(headerSize, ios_base::beg); + size -= headerSize; + // read file + unsigned char iv[aes256cbcIvSize] = {0}; + if(decrypterUsed && ivUsed) { + if(size < aes256cbcIvSize) { + throw ParsingException("Initiation vector not present."); + } + m_file.read(reinterpret_cast(iv), aes256cbcIvSize); + size -= aes256cbcIvSize; + } + if(size <= 0) { + throw ParsingException("No contents found."); + } + // decrypt contents + vector rawbuff; + m_freader.read(rawbuff, size); + vector decbuff; + if(decrypterUsed) { + // initiate ctx + EVP_CIPHER_CTX *ctx = nullptr; + decbuff.resize(size + static_cast(32)); + int outlen1, outlen2; + if ((ctx = EVP_CIPHER_CTX_new()) == nullptr + || EVP_DecryptInit_ex(ctx, EVP_aes_256_cbc(), nullptr, reinterpret_cast(m_password), iv) != 1 + || EVP_DecryptUpdate(ctx, reinterpret_cast(decbuff.data()), &outlen1, reinterpret_cast(rawbuff.data()), size) != 1 + || EVP_DecryptFinal_ex(ctx, reinterpret_cast(decbuff.data()) + outlen1, &outlen2) != 1) { + if(ctx) { + EVP_CIPHER_CTX_free(ctx); + } + string msg; + unsigned long errorCode = ERR_get_error(); + while(errorCode != 0) { + if(!msg.empty()) { + msg += "\n"; + } + msg += ERR_error_string(errorCode, 0); + errorCode = ERR_get_error(); + } + throw CryptoException(msg); + } else { // decryption suceeded + if(ctx) { + EVP_CIPHER_CTX_free(ctx); + } + size = outlen1 + outlen2; + } + } else { // file is not crypted + decbuff.swap(rawbuff); + } + // decompress + if(compressionUsed) { + if(size < 8) { + throw ParsingException("File is truncated (decompressed size expected)."); + } + uLongf decompressedSize = ConversionUtilities::LE::toUInt64(decbuff.data()); + rawbuff.resize(decompressedSize); + switch(uncompress(reinterpret_cast(rawbuff.data()), &decompressedSize, reinterpret_cast(decbuff.data() + 8), size - static_cast(8))) { + case Z_MEM_ERROR: + throw ParsingException("Decompressing failed. The source buffer was too small."); + case Z_BUF_ERROR: + throw ParsingException("Decompressing failed. The destination buffer was too small."); + case Z_DATA_ERROR: + throw ParsingException("Decompressing failed. The input data was corrupted or incomplete."); + case Z_OK: + decbuff.swap(rawbuff); // decompression successful + size = decompressedSize; + } + } + // parse contents + stringstream buffstr(stringstream::in | stringstream::out | stringstream::binary); + buffstr.write(decbuff.data(), static_cast(size)); + decbuff.resize(0); + buffstr.seekg(0, ios_base::beg); + m_rootEntry.reset(new NodeEntry(buffstr)); +} + +/*! + * \brief Writes the current root entry to the file. + * \param useEncryption Specifies whether encryption should be used. + * \throws Throws ios_base::failure when an IO error occurs. + * \throws Throws runtime_error when no root entry is present. + * \throws Throws Io::CryptoException when a decryption error occurs. + */ +void PasswordFile::save(bool useEncryption, bool useCompression) +{ + if(!m_rootEntry) { + throw runtime_error("Root entry has not been created."); + } + // open file + if(m_file.is_open()) { + m_file.close(); + m_file.clear(); + } + m_file.open(m_path, ios_base::in | ios_base::out | ios_base::trunc | ios_base::binary); + // write header + m_fwriter.writeUInt32LE(0x7770616DU); // write magic number + //m_fwriter.writeUInt32(useEncryption ? 2U : 0U); // write version (old versions) + m_fwriter.writeUInt32LE(0x3U); // write version + byte flags = 0x00; + if(useEncryption) { + flags |= 0x80 | 0x40; + } + if(useCompression) { + flags |= 0x20; + } + m_fwriter.writeByte(flags); + // serialize root entry and descendants + stringstream buffstr(stringstream::in | stringstream::out | stringstream::binary); + buffstr.exceptions(ios_base::failbit | ios_base::badbit); + m_rootEntry->make(buffstr); + buffstr.seekp(0, ios_base::end); + stringstream::pos_type size = buffstr.tellp(); + // write the data to a buffer + buffstr.seekg(0); + vector decbuff(size, 0); + buffstr.read(decbuff.data(), size); + vector encbuff; + // compress data + if(useCompression) { + uLongf compressedSize = compressBound(size); + encbuff.resize(8 + compressedSize); + ConversionUtilities::LE::getBytes(static_cast(size), encbuff.data()); + switch(compress(reinterpret_cast(encbuff.data() + 8), &compressedSize, reinterpret_cast(decbuff.data()), size)) { + case Z_MEM_ERROR: + throw runtime_error("Decompressing failed. The source buffer was too small."); + case Z_BUF_ERROR: + throw runtime_error("Decompressing failed. The destination buffer was too small."); + case Z_OK: + encbuff.swap(decbuff); // decompression successful + size = 8 + compressedSize; + } + } + // encrypt data + if(useEncryption) { + // initiate ctx + EVP_CIPHER_CTX *ctx = nullptr; + unsigned char iv[aes256cbcIvSize]; + int outlen1, outlen2; + encbuff.resize(size + static_cast(32)); + if (RAND_bytes(iv, aes256cbcIvSize) != 1 + || (ctx = EVP_CIPHER_CTX_new()) == nullptr + || EVP_EncryptInit_ex(ctx, EVP_aes_256_cbc(), nullptr, reinterpret_cast(m_password), iv) != 1 + || EVP_EncryptUpdate(ctx, reinterpret_cast(encbuff.data()), &outlen1, reinterpret_cast(decbuff.data()), size) != 1 + || EVP_EncryptFinal_ex(ctx, reinterpret_cast(encbuff.data()) + outlen1, &outlen2) != 1) { + if(ctx) { + EVP_CIPHER_CTX_free(ctx); + } + string msg; + unsigned long errorCode = ERR_get_error(); + while(errorCode != 0) { + if(!msg.empty()) { + msg += "\n"; + } + msg += ERR_error_string(errorCode, 0); + errorCode = ERR_get_error(); + } + throw CryptoException(msg); + } else { // decryption succeeded + if(ctx) { + EVP_CIPHER_CTX_free(ctx); + } + // write encrypted data to file + m_file.write(reinterpret_cast(iv), aes256cbcIvSize); + m_file.write(encbuff.data(), static_cast(outlen1 + outlen2)); + } + } else { + // write data to file + m_file.write(decbuff.data(), static_cast(size)); + } + m_file.flush(); +} + +/*! + * \brief Removes the root element if one is present. + */ +void PasswordFile::clearEntries() +{ + m_rootEntry.reset(); +} + +/*! + * \brief Closes the file if opened. Removes path, password and entries. + */ +void PasswordFile::clear() +{ + close(); + clearPath(); + clearPassword(); + clearEntries(); +} + +/*! + * \brief Writes the current root entry to a plain text file. No encryption is used. + * \param targetPath Specifies the path of the text file. + * \throws Throws ios_base::failure when an IO error occurs. + * \throws Throws runtime_error when no root entry is present. + */ +void PasswordFile::exportToTextfile(const string &targetPath) const +{ + if(!m_rootEntry) { + throw runtime_error("Root entry has not been created."); + } + fstream output(targetPath.c_str(), ios_base::out); + function indention = [&output] (int level) { + for(int i = 0; i < level; ++i) { + output << " "; + } + }; + function printNode; + printNode = [&output, &printNode, &indention] (const Entry *entry, int level) { + indention(level); + output << " - " << entry->label() << endl; + switch(entry->type()) { + case EntryType::Node: + for(const Entry *child : static_cast(entry)->children()) { + printNode(child, level + 1); + } + break; + case EntryType::Account: + for(const Field &field : static_cast(entry)->fields()) { + indention(level); + output << " " << field.name(); + for(int i = field.name().length(); i < 15; ++i) { + output << ' '; + } + output << field.value() << endl; + } + } + }; + printNode(m_rootEntry.get(), 0); + output.close(); +} + +/*! + * \brief Creates a backup of the file. Replaces an existent backup file. + * \throws Throws ios_base::failure when an IO error occurs. + */ +void PasswordFile::doBackup() +{ + if(!isOpen()) { + open(); + } + fstream backupFile(m_path + ".backup", ios::out | ios::binary); + backupFile.exceptions(ios_base::failbit | ios_base::badbit); + m_file.seekg(0); + backupFile << m_file.rdbuf(); + backupFile.close(); +} + +/*! + * \brief Returns an indication whether a root entry is present. + * \sa generateRootEntry() + * \sa rootEntry() + */ +bool PasswordFile::hasRootEntry() const +{ + return m_rootEntry != nullptr; +} + +/*! + * \brief Returns the root entry if present or nullptr otherwise. + */ +const NodeEntry *PasswordFile::rootEntry() const +{ + return m_rootEntry.get(); +} + +/*! + * \brief Returns the root entry if present or nullptr otherwise. + */ +NodeEntry *PasswordFile::rootEntry() +{ + return m_rootEntry.get(); +} + +/*! + * \brief Closes the file if currently opened. + */ +void PasswordFile::close() +{ + if(m_file.is_open()) { + m_file.close(); + } + m_file.clear(); +} + +/*! + * \brief Returns the current file path. + */ +const string &PasswordFile::path() const +{ + return m_path; +} + +/*! + * \brief Sets the current file path. Causes the file to be closed if currently opened. + */ +void PasswordFile::setPath(const string &value) +{ + close(); + m_path = value; +} + +/*! + * \brief Clears the current path. Causes the file to be closed if currently opened. + */ +void PasswordFile::clearPath() +{ + close(); + m_path.clear(); +} + +/*! + * \brief Returns the current password. It will be used when loading or saving using encryption. + */ +const char *PasswordFile::password() const +{ + return m_password; +} + +/*! + * \brief Sets the current password. It will be used when loading or saving using encryption. + */ +void PasswordFile::setPassword(const string &value) +{ + clearPassword(); + value.copy(m_password, 32, 0); +} + +/*! + * \brief Clears the current password. + */ +void PasswordFile::clearPassword() +{ + memset(m_password, 0, 32); +} + +/*! + * \brief Returns an indication whether encryption is used if the file is open; returns always false otherwise. + */ +bool PasswordFile::isEncryptionUsed() +{ + if(!isOpen()) { + return false; + } + m_file.seekg(0); + //check magic number + if(m_freader.readUInt32LE() != 0x7770616DU) { + return false; + } + //check version + uint32 version = m_freader.readUInt32LE(); + if(version == 0x1U || version == 0x2U) { + return true; + } else if(version == 0x3U) { + return m_freader.readByte() & 0x80; + } else { + return false; + } +} + +/*! + * \brief Returns an indication whether the file is open. + */ +bool PasswordFile::isOpen() const +{ + return m_file.is_open(); +} + +/*! + * \brief Returns the size of the file if the file is open; returns always zero otherwise. + */ +size_t PasswordFile::size() +{ + if(!isOpen()) { + return 0; + } + m_file.seekg(0, ios::end); + return m_file.tellg(); +} + +} diff --git a/io/passwordfile.h b/io/passwordfile.h new file mode 100644 index 0000000..36307db --- /dev/null +++ b/io/passwordfile.h @@ -0,0 +1,56 @@ +#ifndef PASSWORDFILE_H +#define PASSWORDFILE_H + +#include +#include + +#include +#include +#include +#include + +namespace Io { + +class NodeEntry; + +class LIB_EXPORT PasswordFile +{ +public: + explicit PasswordFile(); + explicit PasswordFile(const std::string &path, const std::string &password); + PasswordFile(const PasswordFile &other); + ~PasswordFile(); + void open(bool readOnly = false); + void generateRootEntry(); + void create(); + void close(); + void load(); + void save(bool useEncryption = true, bool useCompression = true); + void clearEntries(); + void clear(); + void exportToTextfile(const std::string &targetPath) const; + void doBackup(); + bool hasRootEntry() const; + const NodeEntry *rootEntry() const; + NodeEntry *rootEntry(); + const std::string &path() const; + const char *password() const; + void setPath(const std::string &value); + void clearPath(); + void setPassword(const std::string &value); + void clearPassword(); + bool isEncryptionUsed(); + bool isOpen() const; + size_t size(); +private: + std::string m_path; + char m_password[32]; + std::unique_ptr m_rootEntry; + std::fstream m_file; + IoUtilities::BinaryReader m_freader; + IoUtilities::BinaryWriter m_fwriter; +}; + +} + +#endif // PASSWORDFILE_H diff --git a/passwordfile.doxygen b/passwordfile.doxygen new file mode 100644 index 0000000..f41440a --- /dev/null +++ b/passwordfile.doxygen @@ -0,0 +1,2310 @@ +# Doxyfile 1.8.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Password file library" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "A library for reading and writing AES-256-CBC encrypted password files using OpenSSL." + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = gui io model + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.cpp *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /