├── .github └── FUNDING.yml ├── .gitignore ├── .gitmodules ├── CMakeLists.txt ├── CONTRIBUTING.md ├── Doc └── QtCreator.md ├── LICENSE ├── Qt-Secret-GUI ├── CMakeLists.txt ├── DigitalSignaturePage.qml ├── EncryptDecryptPage.qml ├── KeysGeneratePage.qml ├── Qt-Secret-GUI.pro ├── appcore.cpp ├── appcore.h ├── images │ ├── clear.png │ └── cpy.png ├── main.cpp ├── main.qml ├── modules │ ├── ActionButton.qml │ ├── DoubleStateMenu.qml │ ├── LabledText.qml │ ├── LoadPopup.qml │ ├── RowElement.qml │ └── RsaGenModule.qml ├── qml.qrc ├── qtquickcontrols2.conf ├── secretworker.cpp └── secretworker.h ├── Qt-Secret.pro ├── README.md ├── doxygen.conf ├── res ├── png │ ├── Qt-Secret Banner.png │ ├── Qt-Secret Logo.png │ ├── Qt-Secret_Banner_web.png │ └── Qt-Secret_Logo_web.png └── svg │ └── logoQtSecret.svg ├── src ├── CMakeLists.txt ├── Qt-RSA │ ├── qrsaencryption.cpp │ └── qrsaencryption.h ├── Qt-Secret.pri ├── Qt-Secret.pro ├── qtsecret_global.h └── res │ ├── Logo.png │ └── photo_2019-06-22_19-24-45.jpg ├── test.pri └── tests ├── CMakeLists.txt ├── Qt-SecretTest.pro └── main.cpp /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | patreon: QuasarApp 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # C++ objects and libs 2 | *.slo 3 | *.lo 4 | *.o 5 | *.a 6 | *.la 7 | *.lai 8 | *.so* 9 | *.dll 10 | *.dylib 11 | 12 | *Testing/* 13 | *docs/* 14 | 15 | # Qt-es 16 | object_script.*.Release 17 | object_script.*.Debug 18 | *_plugin_import.cpp 19 | /.qmake.cache 20 | /.qmake.stash 21 | *.pro.user 22 | *.pro.user.* 23 | *.qbs.user 24 | *.qbs.user.* 25 | *.moc 26 | moc_*.cpp 27 | moc_*.h 28 | qrc_*.cpp 29 | ui_*.h 30 | *.qmlc 31 | *.jsc 32 | Makefile* 33 | *build-* 34 | *build* 35 | 36 | # Qt unit tests 37 | target_wrapper.* 38 | 39 | # QtCreator 40 | *.autosave 41 | 42 | # QtCreator Qml 43 | *.qmlproject.user 44 | *.qmlproject.user.* 45 | 46 | # QtCreator CMake 47 | CMakeLists.txt.user* 48 | 49 | deployTests/ 50 | 51 | #cmake 52 | 53 | CMakeLists.txt.user 54 | CMakeCache.txt 55 | CMakeFiles 56 | CMakeScripts 57 | Testing 58 | Makefile 59 | cmake_install.cmake 60 | install_manifest.txt 61 | compile_commands.json 62 | CTestTestfile.cmake 63 | _deps 64 | *_autogen -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "src/Qt-AES"] 2 | path = src/Qt-AES 3 | url = https://github.com/QuasarApp/Qt-AES.git 4 | [submodule "src/mini-gmp"] 5 | path = src/mini-gmp 6 | url = https://github.com/QuasarApp/mini-gmp.git 7 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2018-2021 QuasarApp. 3 | # Distributed under the lgplv3 software license, see the accompanying 4 | # Everyone is permitted to copy and distribute verbatim copies 5 | # of this license document, but changing it is not allowed. 6 | # 7 | 8 | cmake_minimum_required(VERSION 3.10) 9 | project(Qt-Secret LANGUAGES CXX) 10 | if(TARGET ${PROJECT_NAME}) 11 | message("The ${PROJECT_NAME} arledy included in main Project") 12 | return() 13 | endif() 14 | 15 | include(src/mini-gmp/CMake/QuasarApp.cmake) 16 | include(src/mini-gmp/CMake/Version.cmake) 17 | 18 | if (NOT DEFINED QTSECRET_TESTS) 19 | set(QTSECRET_TESTS ON) 20 | 21 | if (DEFINED TARGET_PLATFORM_TOOLCHAIN) 22 | if (${TARGET_PLATFORM_TOOLCHAIN} STREQUAL "wasm32") 23 | set(QTSECRET_TESTS OFF) 24 | endif() 25 | endif() 26 | 27 | if (ANDROID OR IOS) 28 | set(QTSECRET_TESTS OFF) 29 | endif() 30 | endif() 31 | 32 | if (NOT DEFINED QTSECRET_GUI) 33 | set(QTSECRET_GUI ON) 34 | 35 | if (DEFINED TARGET_PLATFORM_TOOLCHAIN) 36 | if (${TARGET_PLATFORM_TOOLCHAIN} STREQUAL "wasm32") 37 | set(QTSECRET_GUI OFF) 38 | endif() 39 | endif() 40 | 41 | if (ANDROID OR IOS) 42 | set(QTSECRET_GUI OFF) 43 | endif() 44 | endif() 45 | 46 | # Add sub directories 47 | find_package(QT NAMES Qt6 Qt5 COMPONENTS Core REQUIRED) 48 | find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Core REQUIRED) 49 | 50 | # Add sub directories 51 | add_subdirectory(src/mini-gmp) 52 | add_subdirectory(src) 53 | if (QTSECRET_TESTS) 54 | add_subdirectory(tests) 55 | endif() 56 | 57 | IF(QTSECRET_GUI) 58 | message("The GUI Example is enabled") 59 | add_subdirectory(Qt-Secret-GUI) 60 | else() 61 | message("The GUI Example is disabled") 62 | endif() 63 | 64 | initAll() 65 | 66 | addDoc("Qt-Secret" ${CMAKE_CURRENT_SOURCE_DIR}/doxygen.conf) 67 | 68 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # QuassarApp operation rules 2 | ## General rules 3 | ### QuasarApp internal developers 4 | * If there is no indication, separate from the master branch. 5 | * We realize the task 6 | * Upon completion of work, issue a Pull Request to the master. 7 | 8 | ### External QuasarApp Developers 9 | * Making Fork repository. 10 | * If there is no indication, separate from the master branch. 11 | * We realize the task 12 | * Upon completion of work, issue a Pull Request to the master. 13 | * Before starting work on the Task, drag it to [inProgress](https://github.com/orgs/QuasarApp/projects) in projects 14 | 15 | ### Prohibited from working in QuassarApp 16 | 17 | * Use push force. All problems need to be solved by a new committee. 18 | * Push code directly to master. 19 | * Break the code design rules. If some aspect is not described, you need to write in the same style as it was written before you. 20 | * Move the code for no particular reason. 21 | 22 | 23 | ## Making Pull Request 24 | 25 | The content of the pull request must include: 26 | * The number of the task that solves (if performed according to the task) 27 | * A complete description of everything that was done in the task. 28 | * In the case when a pull creation is created, the Task is still running, marking the Pull Request header with a WIP tag (example [WIP] MyTask) 29 | * Pull Request must always be assigned to the branch from which you separated. 30 | 31 | ## Making Tasks 32 | If necessary, assign a task to someone 33 | You must: 34 | * Create relevant discussion on github, selected repository. 35 | * Completely describe the problem or task. 36 | * If you have a solution to the problem fully describe what and how to do. 37 | 38 | ## Code Registration 39 | 40 | When writing code follows the following rules: (inscribed written in order of importance) 41 | 1. If in order to achieve high performance gains (over 10%) you need to sacrifice any of the rules, donate them. 42 | 2. In no case do not use the C-style Cast. 43 | 3. All connected headers should be stored to the maximum in cpp files. 44 | 4. If the class uses pointers, then initialize the prototypes of these classes to the place where the header is connected: class a; a * value = nullptr; 45 | 5. In headings it is necessary to null the signs. 46 | 6. Template functions are described in cpp files. 47 | 7. If possible, think through your code so that it does not have a cast. 48 | 8. Write class access specifiers in the following order: private, private slots, protected, protected slots, public, public slots, signals 49 | 9. Carefully check and arrange spaces between operators in the code. 50 | 10. Moving the bracket to the next line is prohibited. 51 | 11. When transferring the shift should be equal to 4 spaces. 52 | 12. Before pushing the code, be sure to run the tests. 53 | 54 | # Правила работы QuassarApp 55 | ## Общие правила 56 | ### Внутренние разработчики QuasarApp 57 | * Если нет никаких указаний отделяемся от ветки master 58 | * Реализуем поставленную задачу 59 | * По завершению работы оформить Pull Request в master. 60 | 61 | ### Внешние разработчики QuasarApp 62 | * Делаем Fork репозитория. 63 | * Если нет никаких указаний отделяемся от ветки master 64 | * Реализуем поставленную задачу 65 | * По завершению работы оформить Pull Request в master. 66 | * Перед началом работы над Задачей, перетащить ее в [inProgress](https://github.com/orgs/QuasarApp/projects) в проектах 67 | 68 | ### При работе в QuassarApp запрещается 69 | 70 | * Использовать push force. Все проблемы нужно решать новым комитом. 71 | * Пушить код напрямую в master. 72 | * Нарушать правила оформления кода. Если какой то аспект не описан, писать нужно в том-же стиле как было написано до вас. 73 | * Перемещать код без особой на это причины. 74 | 75 | 76 | ## Оформление Pull Request 77 | 78 | Содержимое Pull Request должно обязательно включать: 79 | * Номер задания которую решает (если выполнялось по поставленной задаче) 80 | * Полное описание всего что было сделано в задаче. 81 | * В случае когда создается пулреквест а Задача еще выполняется помечать заголовок Pull Request тегом WIP (пример [WIP] MyTask) 82 | * Pull Request всегда должен быть назначен именно в ту ветку от которой вы отделялись. 83 | 84 | ## Оформление Задачи 85 | В случае необходимости назначить на кого-то задачу 86 | Вы должны: 87 | * Создать соответствующее обсуждение на github, выбранного репазитория. 88 | * Полностью описать проблему или задачу. 89 | * Если у вас есть решение задачи полностью описать что и как делать. 90 | 91 | ## Оформление кода 92 | 93 | При написании кода придерживается следующих правил: (привила записаны в порядке важности) 94 | 1. Если ради достижения высокого прироста производительности (более 10%) вам нужно пожертвовать каким либо из правил, жертвуйте ими. 95 | 2. Не в коем случае не использовать C-style Cast. 96 | 3. Все подключаемые заголовки по максимуму должны хранится в cpp файлах. 97 | 4. Если в классе используются указатели то инициализировать прототипы этих классов в место подключения заголовка: сlass a; a *value = nullptr; 98 | 5. В заголовках обязательно занулять указатели. 99 | 6. Шаблонные функции описывать в cpp файлах. 100 | 7. По возможности продумывать ваш код так что бы в нем не было cast. 101 | 8. Спецификаторы доступа класса писать в следующем порядке private, private slots, protected, protected slots, public, public slots, signals 102 | 9. Внимательно проверять и расставлять пробелы между операторами в коде. 103 | 10. Перенос скобки на следующую строку запрещается. 104 | 11. При переносе сдвиг должен быть равен 4 пробела. 105 | 12. Перед пушем кода обязательно прогнать тесты. 106 | -------------------------------------------------------------------------------- /Doc/QtCreator.md: -------------------------------------------------------------------------------- 1 | 2 | # incude Qt-Secret in qtCreator 3 | * Open QtCreator 4 | * Create a new subdirs project (file >> create a new project of file >> other projects >> subdirs project) and call it 'Master' 5 | * Copy **your project folder** into **the Master project folder** or if you use git then add your project like submodule of a master project. Use the command: "git submodules add **URL**" 6 | * Open Master.pro and add your project like subproject 7 | 8 | ``` qmake 9 | TEMPLATE = subdirs 10 | CONFIG += ordered 11 | 12 | SUBDIRS += \ 13 | youProjectFolder 14 | 15 | youProjectFolder.file = path/to/yuorProject.pro 16 | ``` 17 | * Open the Master project folder in git console. If git is not installed then install it [this](https://git-scm.com/download/win) 18 | * run: git submodule add https://github.com/QuasarApp/Qt-Secret.git 19 | * run: git submodule update --init --recursive 20 | * Open Master.pro 21 | * Add Qt-Secret library like subproject of Master 22 | ``` qmake 23 | TEMPLATE = subdirs 24 | CONFIG += ordered 25 | 26 | SUBDIRS += \ 27 | Qt-Secret \ 28 | youProjectFolder \ 29 | 30 | youProjectFolder.file = path/to/yuorProject.pro 31 | ``` 32 | * Open YouProject.pro 33 | * Include in your MyProject.pro file the pri file of Qt-Secret library (insert it to end of the file next line :) 34 | ``` qmake 35 | include($$PWD/../Qt-Secret/src/Qt-Secret.pri) 36 | 37 | ``` 38 | * Rebuild Master project 39 | * All done!. Now you need to build only a master project, because it will build both your project and the project Qt-Secret. QT-Secret will already be included in your project and you will be able to use it in your code. 40 | 41 | 42 | For Example, you can see my [master](https://github.com/QuasarApp/Qt-Secret/blob/master/Qt-Secret.pro) project and include library [lines](https://github.com/QuasarApp/Qt-Secret/blob/a6828ea53d8b6a5f60def149fee2792ae6d7d774/Qt-Secret-GUI/Qt-Secret-GUI.pro#L22). 43 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2018-2021 QuasarApp. 3 | # Distributed under the lgplv3 software license, see the accompanying 4 | # Everyone is permitted to copy and distribute verbatim copies 5 | # of this license document, but changing it is not allowed. 6 | # 7 | 8 | cmake_minimum_required(VERSION 3.10) 9 | set(CURRENT_PROJECT "${PROJECT_NAME}-GUI") 10 | 11 | 12 | set(CMAKE_INCLUDE_CURRENT_DIR ON) 13 | set(CMAKE_AUTOMOC ON) 14 | set(CMAKE_AUTORCC ON) 15 | set(CMAKE_CXX_STANDARD 17) 16 | set(CMAKE_CXX_STANDARD_REQUIRED ON) 17 | 18 | find_package(QT NAMES Qt6 Qt5 COMPONENTS Core Quick REQUIRED) 19 | find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Core Quick REQUIRED) 20 | 21 | file(GLOB SOURCE_CPP 22 | "*.cpp" 23 | "*.qrc" 24 | ) 25 | 26 | add_executable(${CURRENT_PROJECT} ${SOURCE_CPP}) 27 | target_link_libraries(${CURRENT_PROJECT} PRIVATE Qt${QT_VERSION_MAJOR}::Quick Qt-Secret) 28 | target_include_directories(${CURRENT_PROJECT} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) 29 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/DigitalSignaturePage.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | import QtQuick.Layouts 1.12 4 | import "modules/" 5 | 6 | Item { 7 | id: parentItem 8 | 9 | Connections { 10 | target: appCore 11 | function onQmlShowSignResult(message) { 12 | signOutText.setText(message) 13 | } 14 | } 15 | 16 | ColumnLayout { 17 | 18 | id: column 19 | spacing: 20 20 | anchors.fill: parent 21 | anchors.leftMargin: 20 22 | anchors.rightMargin: 20 23 | 24 | function changeState() { 25 | keyLabledText.labelText = (signCheckMenu.state ? qsTr("Private key:") : qsTr("Public key:")) 26 | inputText.labelText = (signCheckMenu.state ? qsTr("Text to sign:") : qsTr("Text to check sign:")) 27 | signOutText.labelText = (signCheckMenu.state ? qsTr("Signed text:") : qsTr("Result:")) 28 | } 29 | 30 | DoubleStateMenu { 31 | 32 | id: signCheckMenu 33 | verticalSize: 0.1 34 | firstStateName: qsTr("Sign message") 35 | secondStateName: qsTr("Check sign") 36 | onChangeState: column.changeState() 37 | onGetAction: appCore.getSignCheck(signCheckMenu.state, 38 | keyLabledText.textAreaText, 39 | inputText.textAreaText) 40 | } 41 | 42 | RowElement { 43 | id: keyLabledText 44 | verticalSize: 0.3 45 | labelText: qsTr("Private key:") 46 | buttonImageSource: "../images/clear.png" 47 | onButtonClicked: keyLabledText.setText("") 48 | } 49 | 50 | RowElement { 51 | id: inputText 52 | verticalSize: 0.3 53 | labelText: qsTr("Text to sign:") 54 | buttonImageSource: "../images/clear.png" 55 | onButtonClicked: inputText.setText("") 56 | } 57 | 58 | RowElement { 59 | id: signOutText 60 | verticalSize: 0.3 61 | labelText: qsTr("Signed text:") 62 | buttonImageSource: "../images/cpy.png" 63 | onButtonClicked: appCore.copyToClipboard(signOutText.textAreaText) 64 | } 65 | 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/EncryptDecryptPage.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | import QtQuick.Layouts 1.12 4 | import "modules/" 5 | 6 | Item { 7 | id: parentItem 8 | 9 | Connections { 10 | target: appCore 11 | function onQmlShowEncDecResult(message) { 12 | outputText.setText(message) 13 | } 14 | } 15 | 16 | ColumnLayout { 17 | 18 | id: column 19 | spacing: 20 20 | anchors.fill: parent 21 | anchors.leftMargin: 20 22 | anchors.rightMargin: 20 23 | 24 | function changeState() { 25 | keyLabledText.labelText = (encryptDecryptMenu.state ? qsTr("Public key:") : qsTr("Private key:")) 26 | inputText.labelText = (encryptDecryptMenu.state ? qsTr("Text to encrypt:") : qsTr("Text to decrypt:")) 27 | outputText.labelText = (encryptDecryptMenu.state ? qsTr("Encrypted text:") : qsTr("Decrypted text:")) 28 | } 29 | 30 | DoubleStateMenu { 31 | 32 | id: encryptDecryptMenu 33 | verticalSize: 0.1 34 | firstStateName: qsTr("Encrypt") 35 | secondStateName: qsTr("Decrypt") 36 | onChangeState: column.changeState() 37 | onGetAction: appCore.getEncryptDecrypt(encryptDecryptMenu.state, 38 | keyLabledText.textAreaText, 39 | inputText.textAreaText) 40 | } 41 | 42 | RowElement { 43 | id: keyLabledText 44 | verticalSize: 0.3 45 | labelText: qsTr("Public key:") 46 | buttonImageSource: "../images/clear.png" 47 | onButtonClicked: keyLabledText.setText("") 48 | } 49 | 50 | RowElement { 51 | id: inputText 52 | verticalSize: 0.3 53 | labelText: qsTr("Text to encrypt:") 54 | buttonImageSource: "../images/clear.png" 55 | onButtonClicked: inputText.setText("") 56 | } 57 | 58 | RowElement { 59 | id: outputText 60 | verticalSize: 0.3 61 | labelText: qsTr("Encrypted text:") 62 | buttonImageSource: "../images/cpy.png" 63 | onButtonClicked: appCore.copyToClipboard(outputText.textAreaText) 64 | } 65 | 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/KeysGeneratePage.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | import QtQuick.Layouts 1.12 4 | import "modules/" 5 | 6 | Item { 7 | id: parentItem 8 | 9 | Connections { 10 | 11 | target: appCore 12 | function onQmlShowKeys(pubKey, privKey) { 13 | publicKeyRow.setText(pubKey) 14 | privateKeyRow.setText(privKey) 15 | } 16 | } 17 | 18 | ColumnLayout { 19 | 20 | id: column 21 | spacing: 0 22 | anchors.fill: parent 23 | anchors.leftMargin: 20 24 | anchors.rightMargin: 20 25 | 26 | RsaGenModule { 27 | id: rsaGenModule 28 | Layout.fillWidth: true 29 | Layout.leftMargin: 0 30 | 31 | onButtonClicked: appCore.generateKeys(rsaGenModule.rsaSize) 32 | } 33 | 34 | RowElement { 35 | id: publicKeyRow 36 | labelText: qsTr("Public key:") 37 | buttonImageSource: "../images/cpy.png" 38 | onButtonClicked: appCore.copyToClipboard(publicKeyRow.textAreaText) 39 | } 40 | 41 | RowElement { 42 | id: privateKeyRow 43 | x: 0 44 | Layout.fillWidth: true 45 | Layout.leftMargin: 0 46 | labelText: qsTr("Private key:") 47 | buttonImageSource: "../images/cpy.png" 48 | onButtonClicked: appCore.copyToClipboard(privateKeyRow.textAreaText) 49 | } 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/Qt-Secret-GUI.pro: -------------------------------------------------------------------------------- 1 | QT += quick 2 | CONFIG += c++11 3 | 4 | # The following define makes your compiler emit warnings if you use 5 | # any Qt feature that has been marked deprecated (the exact warnings 6 | # depend on your compiler). Refer to the documentation for the 7 | # deprecated API to know how to port your code away from it. 8 | DEFINES += QT_DEPRECATED_WARNINGS 9 | 10 | # You can also make your code fail to compile if it uses deprecated APIs. 11 | # In order to do so, uncomment the following line. 12 | # You can also select to disable deprecated APIs only up to a certain version of Qt. 13 | #DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0 14 | 15 | SOURCES += \ 16 | appcore.cpp \ 17 | main.cpp \ 18 | secretworker.cpp 19 | 20 | RESOURCES += qml.qrc 21 | 22 | include($$PWD/../src/Qt-Secret.pri) 23 | 24 | HEADERS += \ 25 | appcore.h \ 26 | secretworker.h 27 | 28 | DISTFILES += 29 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/appcore.cpp: -------------------------------------------------------------------------------- 1 | #include "appcore.h" 2 | 3 | AppCore::AppCore(QObject *parent, QClipboard *clpbrd) : QObject(parent) { 4 | 5 | clipboard = clpbrd; 6 | 7 | connect(this, &AppCore::wrkGenerateKeys, &secWorker, &SecretWorker::generateKeys); 8 | connect(&secWorker, &SecretWorker::showKeysOnQml, this, &AppCore::printKeys); 9 | 10 | connect(this, &AppCore::wrkEncryptMessage, &secWorker, &SecretWorker::encryptMessage); 11 | connect(this, &AppCore::wrkDecryptMessage, &secWorker, &SecretWorker::decryptMessage); 12 | connect(&secWorker, &SecretWorker::showEncDecResOnQml, this, &AppCore::printEncDecResult); 13 | 14 | connect(this, &AppCore::wrkSignMessage, &secWorker, &SecretWorker::signMessage); 15 | connect(this, &AppCore::wrkCheckSign, &secWorker, &SecretWorker::checkSign); 16 | connect(&secWorker, &SecretWorker::showSignResOnQml, this, &AppCore::printSignResult); 17 | 18 | secWorker.moveToThread(&workThread); 19 | workThread.start(); 20 | } 21 | 22 | AppCore::~AppCore() { 23 | 24 | workThread.quit(); 25 | workThread.wait(); 26 | } 27 | 28 | void AppCore::copyToClipboard(QString text) { 29 | 30 | clipboard->setText(text); 31 | } 32 | 33 | // generate keys 34 | void AppCore::generateKeys(int rsa) { 35 | 36 | emit qmlOpenPopup(); 37 | emit wrkGenerateKeys(rsa); 38 | } 39 | 40 | void AppCore::printKeys() { 41 | 42 | emit qmlShowKeys(secWorker.pubKey.toHex(), secWorker.privKey.toHex()); 43 | emit qmlClosePopup(); 44 | } 45 | 46 | // encryption and decryption 47 | void AppCore::getEncryptDecrypt(bool actionType, QString key, QString message) { 48 | 49 | emit qmlOpenPopup(); 50 | 51 | // encryption 52 | if(actionType) { 53 | emit wrkEncryptMessage(key, message); 54 | } 55 | // decryption 56 | else { 57 | emit wrkDecryptMessage(key, message); 58 | } 59 | } 60 | 61 | void AppCore::printEncDecResult() { 62 | 63 | emit qmlShowEncDecResult(secWorker.message); 64 | emit qmlClosePopup(); 65 | } 66 | 67 | // sign message and check sign 68 | void AppCore::getSignCheck(bool actionType, QString key, QString message) { 69 | 70 | emit qmlOpenPopup(); 71 | 72 | // sign message 73 | if(actionType) { 74 | emit wrkSignMessage(key, message); 75 | } 76 | // check sign 77 | else { 78 | emit wrkCheckSign(key, message); 79 | } 80 | } 81 | 82 | void AppCore::printSignResult() { 83 | 84 | emit qmlShowSignResult(secWorker.message); 85 | emit qmlClosePopup(); 86 | } 87 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/appcore.h: -------------------------------------------------------------------------------- 1 | #ifndef APPCORE_H 2 | #define APPCORE_H 3 | 4 | #include 5 | #include 6 | #include 7 | #include 8 | 9 | class AppCore : public QObject 10 | { 11 | Q_OBJECT 12 | public: 13 | explicit AppCore(QObject *parent = nullptr, QClipboard *clpbrd = nullptr); 14 | ~AppCore(); 15 | 16 | SecretWorker secWorker; 17 | QThread workThread; 18 | 19 | QClipboard *clipboard; 20 | 21 | signals: 22 | // general to all pages 23 | void qmlOpenPopup(); // from AppCore to qml 24 | void qmlClosePopup(); // from AppCore to qml 25 | 26 | // generate keys 27 | void wrkGenerateKeys(int rsa); // from AppCore to secWorker 28 | void qmlShowKeys(QByteArray pubKey, QByteArray privKey); // to qml 29 | 30 | // encryption and decryption 31 | void wrkEncryptMessage(QString pubKey, QString message); 32 | void wrkDecryptMessage(QString privKey, QString message); 33 | void qmlShowEncDecResult(QString message); 34 | 35 | // digital signature 36 | void wrkSignMessage(QString privKey, QString message); 37 | void wrkCheckSign(QString pubKey, QString message); 38 | void qmlShowSignResult(QString message); 39 | 40 | public slots: 41 | void copyToClipboard(QString text); 42 | 43 | // generate keys 44 | void generateKeys(int rsa); 45 | void printKeys(); 46 | 47 | // encryption and decryption 48 | void getEncryptDecrypt(bool actionType, QString key, QString message); 49 | void printEncDecResult(); 50 | 51 | // sign message and check sign 52 | void getSignCheck(bool actionType, QString key, QString message); 53 | void printSignResult(); 54 | }; 55 | 56 | #endif // APPCORE_H 57 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/images/clear.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/QuasarApp/Qt-Secret/3c5ced89576260dc8b40b634c6946ca0adea54fe/Qt-Secret-GUI/images/clear.png -------------------------------------------------------------------------------- /Qt-Secret-GUI/images/cpy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/QuasarApp/Qt-Secret/3c5ced89576260dc8b40b634c6946ca0adea54fe/Qt-Secret-GUI/images/cpy.png -------------------------------------------------------------------------------- /Qt-Secret-GUI/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include "appcore.h" 5 | 6 | int main(int argc, char *argv[]) 7 | { 8 | #if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) 9 | QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling); 10 | #endif 11 | QGuiApplication app(argc, argv); 12 | 13 | QQmlApplicationEngine engine; 14 | 15 | QClipboard *clipboard = QGuiApplication::clipboard(); 16 | 17 | AppCore appCore(clipboard); 18 | QQmlContext *context = engine.rootContext(); 19 | context->setContextProperty("appCore", &appCore); 20 | 21 | const QUrl url(QStringLiteral("qrc:/main.qml")); 22 | QObject::connect(&engine, &QQmlApplicationEngine::objectCreated, 23 | &app, [url](QObject *obj, const QUrl &objUrl) { 24 | if (!obj && url == objUrl) 25 | QCoreApplication::exit(-1); 26 | }, Qt::QueuedConnection); 27 | engine.load(url); 28 | 29 | return app.exec(); 30 | } 31 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/main.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.12 2 | import QtQuick.Controls 2.12 3 | import QtQuick.Layouts 1.12 4 | import QtQml.Models 2.12 5 | import QtQuick.Window 2.12 6 | import QtQuick.Controls.Material 2.12 7 | import Qt.labs.settings 1.0 8 | import "modules/" 9 | 10 | ApplicationWindow { 11 | id: window 12 | visible: true 13 | width: 800 14 | height: 480 15 | 16 | minimumWidth: 640 17 | minimumHeight: 480 18 | title: qsTr("Qt-Secret-GUI") 19 | 20 | Connections { 21 | target: appCore 22 | function onQmlClosePopup() { 23 | loadPopup.close() 24 | } 25 | function onQmlOpenPopup() { 26 | loadPopup.open() 27 | } 28 | } 29 | 30 | SwipeView { 31 | id: swipeView 32 | anchors.fill: parent 33 | currentIndex: tabBar.currentIndex 34 | 35 | anchors.topMargin: tabBar.height + 20 36 | anchors.bottomMargin: 15 37 | 38 | KeysGeneratePage {} 39 | 40 | EncryptDecryptPage {} 41 | 42 | DigitalSignaturePage {} 43 | } 44 | 45 | TabBar { 46 | id: tabBar 47 | width: parent.width 48 | currentIndex: swipeView.currentIndex 49 | 50 | TabButton { 51 | text: qsTr("Keys generate") 52 | } 53 | TabButton { 54 | text: qsTr("Encryption and decryption") 55 | } 56 | TabButton { 57 | text: qsTr("Digital signature") 58 | } 59 | } 60 | 61 | LoadPopup { id: loadPopup } 62 | 63 | } 64 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/modules/ActionButton.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | 4 | Button { 5 | 6 | id: btn 7 | 8 | property string source: "../images/cpy.png" 9 | implicitWidth: 46 10 | implicitHeight: 46 11 | 12 | icon.source: btn.source 13 | } 14 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/modules/DoubleStateMenu.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | import QtQuick.Layouts 1.12 4 | 5 | RowLayout { 6 | 7 | id: doubleStateMenu 8 | 9 | property double verticalSize: 0.1 10 | property string firstStateName 11 | property string secondStateName 12 | property bool state: true 13 | 14 | signal changeState() 15 | signal getAction() 16 | 17 | spacing: 20 18 | Layout.minimumHeight: 50 19 | Layout.fillWidth: true 20 | Layout.maximumHeight: parentItem.height * verticalSize 21 | 22 | RadioButton { 23 | text: firstStateName 24 | checked: true 25 | onToggled: { 26 | doubleStateMenu.state = true 27 | changeState() 28 | } 29 | } 30 | 31 | RadioButton { 32 | text: secondStateName 33 | onToggled: { 34 | doubleStateMenu.state = false 35 | changeState() 36 | } 37 | } 38 | 39 | Button { 40 | id: processButton 41 | text: doubleStateMenu.state ? firstStateName : secondStateName 42 | onClicked: getAction() 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/modules/LabledText.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | import QtQuick.Layouts 1.12 4 | 5 | RowLayout { 6 | 7 | id: labledText 8 | 9 | spacing: 20 10 | Layout.minimumHeight: 50 11 | Layout.fillWidth: true 12 | 13 | property string labelText: qsTr("Label") 14 | property string textAreaText: rowElementTA.text 15 | property double verticalSize: 0.2 16 | 17 | function setText(text) { 18 | rowElementTA.text = text 19 | } 20 | 21 | Label { 22 | id: rowElementLabel 23 | text: labledText.labelText 24 | verticalAlignment: Text.AlignVCenter 25 | horizontalAlignment: Text.AlignHCenter 26 | } 27 | 28 | ScrollView { 29 | id: rowElementSV 30 | clip: true; 31 | 32 | Layout.fillWidth: true 33 | Layout.maximumHeight: parentItem.height * verticalSize 34 | 35 | ScrollBar.horizontal: ScrollBar { 36 | policy: ScrollBar.AlwaysOff 37 | } 38 | 39 | TextField { 40 | id: rowElementTA 41 | selectByMouse: true 42 | width: rowElementSV.width 43 | wrapMode: Text.WrapAnywhere 44 | verticalAlignment: Text.AlignTop 45 | } 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/modules/LoadPopup.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | 4 | Popup { 5 | id: popup 6 | anchors.centerIn: Overlay.overlay 7 | modal: true 8 | focus: true 9 | closePolicy: Popup.NoAutoClose 10 | 11 | BusyIndicator { 12 | running: true 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/modules/RowElement.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | import QtQuick.Layouts 1.12 4 | 5 | RowLayout { 6 | 7 | id: rowElement 8 | 9 | property string labelText 10 | property string textAreaText: labledText.textAreaText 11 | property double verticalSize: 0.2 12 | property string buttonImageSource 13 | 14 | signal buttonClicked() 15 | 16 | function setText(text) { 17 | labledText.setText(text) 18 | } 19 | 20 | spacing: 20 21 | Layout.minimumHeight: 50 22 | Layout.fillWidth: true 23 | 24 | LabledText { 25 | id: labledText 26 | labelText: rowElement.labelText 27 | verticalSize: rowElement.verticalSize 28 | } 29 | 30 | ActionButton { 31 | onClicked: rowElement.buttonClicked() 32 | source: rowElement.buttonImageSource 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/modules/RsaGenModule.qml: -------------------------------------------------------------------------------- 1 | import QtQuick 2.0 2 | import QtQuick.Controls 2.12 3 | import QtQuick.Layouts 1.12 4 | 5 | RowLayout { 6 | 7 | id: rsaSizeModule 8 | spacing: 20 9 | Layout.minimumHeight: 50 10 | Layout.leftMargin: 30 11 | 12 | property int rsaSize: rsaSizeCB.model[rsaSizeCB.currentIndex] 13 | 14 | signal buttonClicked() 15 | 16 | function setComboBoxIndex(index) { 17 | rsaSizeCB.currentIndex = index 18 | } 19 | 20 | Label { 21 | id: rsaSizeLabel 22 | text: qsTr("RSA size:") 23 | verticalAlignment: Text.AlignVCenter 24 | horizontalAlignment: Text.AlignHCenter 25 | } 26 | 27 | ComboBox { 28 | id: rsaSizeCB 29 | currentIndex: 0 30 | editable: false 31 | model: [64, 128, 256, 512, 1024, 2048, 4096, 8192] 32 | } 33 | 34 | Button { 35 | id: generateButton 36 | text: qsTr("Generate") 37 | 38 | onClicked: { 39 | onClicked: rsaSizeModule.buttonClicked() 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/qml.qrc: -------------------------------------------------------------------------------- 1 | 2 | 3 | DigitalSignaturePage.qml 4 | EncryptDecryptPage.qml 5 | KeysGeneratePage.qml 6 | main.qml 7 | qtquickcontrols2.conf 8 | images/cpy.png 9 | modules/RowElement.qml 10 | modules/LoadPopup.qml 11 | modules/RsaGenModule.qml 12 | modules/LabledText.qml 13 | modules/ActionButton.qml 14 | images/clear.png 15 | modules/DoubleStateMenu.qml 16 | 17 | 18 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/qtquickcontrols2.conf: -------------------------------------------------------------------------------- 1 | [Controls] 2 | Style=Material 3 | 4 | 5 | [Material] 6 | Theme=Light 7 | Accent=Teal 8 | Primary=BlueGrey 9 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/secretworker.cpp: -------------------------------------------------------------------------------- 1 | #include "secretworker.h" 2 | 3 | SecretWorker::SecretWorker(QObject *parent) : QObject(parent) 4 | {} 5 | 6 | void SecretWorker::generateKeys(int rsa) { 7 | 8 | QRSAEncryption::generatePairKey(pubKey, privKey, QRSAEncryption::Rsa(rsa)); 9 | emit showKeysOnQml(); 10 | } 11 | 12 | void SecretWorker::encryptMessage(QString encPubKey, QString inputText) { 13 | 14 | message = QString(QRSAEncryption::encode(inputText.toUtf8(), 15 | QByteArray::fromHex(encPubKey.toUtf8()), 16 | QRSAEncryption::Rsa(encPubKey.length() * 2)).toHex()); 17 | emit showEncDecResOnQml(); 18 | } 19 | 20 | void SecretWorker::decryptMessage(QString decPrivKey, QString inputMessage) { 21 | 22 | message = QString(QRSAEncryption::decode(QByteArray::fromHex(inputMessage.toUtf8()), 23 | QByteArray::fromHex(decPrivKey.toUtf8()), 24 | QRSAEncryption::Rsa(decPrivKey.length() * 2))); 25 | emit showEncDecResOnQml(); 26 | } 27 | 28 | void SecretWorker::signMessage(QString signPrivKey, QString inputMessage) { 29 | 30 | message = QString(QRSAEncryption::signMessage(inputMessage.toUtf8(), 31 | QByteArray::fromHex(signPrivKey.toUtf8()), 32 | QRSAEncryption::Rsa(signPrivKey.length() * 2))); 33 | emit showSignResOnQml(); 34 | } 35 | 36 | void SecretWorker::checkSign(QString signPubKey, QString inputMessage) { 37 | 38 | message = QRSAEncryption::checkSignMessage(inputMessage.toUtf8(), 39 | QByteArray::fromHex(signPubKey.toUtf8()), 40 | QRSAEncryption::Rsa(signPubKey.length() * 2)) ? "Sign is true" : "Sign is false"; 41 | emit showSignResOnQml(); 42 | } 43 | -------------------------------------------------------------------------------- /Qt-Secret-GUI/secretworker.h: -------------------------------------------------------------------------------- 1 | #ifndef SECRETWORKER_H 2 | #define SECRETWORKER_H 3 | 4 | #include 5 | #include 6 | #include 7 | 8 | class SecretWorker : public QObject 9 | { 10 | Q_OBJECT 11 | public: 12 | explicit SecretWorker(QObject *parent = nullptr); 13 | 14 | QByteArray pubKey; 15 | QByteArray privKey; 16 | 17 | QString message; 18 | bool checkResult; 19 | 20 | public slots: 21 | void generateKeys(int rsa); 22 | 23 | void encryptMessage(QString encPubKey, QString inputText); 24 | void decryptMessage(QString decPrivKey, QString inputMessage); 25 | 26 | void signMessage(QString signPrivKey, QString inputMessage); 27 | void checkSign(QString signPubKey, QString inputMessage); 28 | 29 | signals: 30 | void showKeysOnQml(); 31 | void showEncDecResOnQml(); 32 | void showSignResOnQml(); 33 | }; 34 | 35 | #endif // SECRETWORKER_H 36 | -------------------------------------------------------------------------------- /Qt-Secret.pro: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2018-2020 QuasarApp. 3 | # Distributed under the lgplv3 software license, see the accompanying 4 | # Everyone is permitted to copy and distribute verbatim copies 5 | # of this license document, but changing it is not allowed. 6 | # 7 | 8 | TEMPLATE = subdirs 9 | CONFIG += ordered 10 | 11 | SUBDIRS += \ 12 | minigmp \ 13 | src \ 14 | Qt-Secret-GUI 15 | 16 | contains(DEFINES, WITHOUT_GUI): { 17 | SUBDIRS -= Qt-Secret-GUI 18 | } 19 | 20 | minigmp.file = src/mini-gmp/GMP.pro 21 | src.file = src/Qt-Secret.pro 22 | 23 | # fix configurate project 24 | QMAKE_EXTRA_TARGETS += \ 25 | test 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ![Qt-Secret Logo](res/png/Qt-Secret_Banner_web.png) 2 | 3 | # Note 4 | The OpenSSL library is better for security and performance, so we implemented a Qt wrapper library to make it easier to use. See the [EasySSL](https://github.com/QuasarApp/easyssl) library. 5 | 6 | Fast encryption library supporting RSA and AES algorithms. 7 | 8 | # Futures 9 | The Qt-Secret library supports the following algorithms: 10 | 11 | ### RSA 12 | The current implementation supports the following key sizes: 13 | #### Supported sizes 14 | * RSA64 15 | * RSA128 16 | * RSA256 17 | * RSA512 18 | * RSA1024 19 | * RSA2048 20 | * RSA3072 21 | * RSA4096 22 | * RSA6144 23 | * RSA8192 24 | 25 | #### Supported futures 26 | 27 | * Encryption and decryption of messages. 28 | * Signature and verification of the message signature. 29 | 30 | ### AES 31 | AES implementation was borrowed from [bricke](https://github.com/bricke/Qt-AES), because it fulfills the goals of this library. 32 | 33 | Individual thanks [bricke](https://github.com/bricke) for implementing the AES encryption class. 34 | 35 | #### AES Levels 36 | The class supports all AES key lengths 37 | 38 | * AES_128 39 | * AES_192 40 | * AES_256 41 | 42 | #### Modes 43 | The class supports the following operating modes 44 | 45 | * ECB 46 | * CBC 47 | * CFB 48 | * OFB 49 | 50 | #### Padding 51 | By default the padding method is `ISO`, however, the class supports: 52 | 53 | * ZERO 54 | * PKCS7 55 | * ISO 56 | 57 | 58 | # Build 59 | 60 | ## with qmake 61 | 62 | * git clone https://github.com/QuasarApp/Qt-Secret.git 63 | * cd Qt-Secret 64 | * git submodule update --init --recursive 65 | * sudo apt install qt5-default 66 | * qmake -r DEFINE+=WITHOUT_GUI Qt-Secret.pro 67 | > DEFINE+=WITHOUT_GUI fot build without gui example, if you want build gui example remove this line. For build the gui example you need to install qml controls 2 in you os. Try **sudo apt install qml-module-qtquick-controls2 qtdeclarative5-dev qtdeclarative5-qtquick2-plugin** 68 | * make -j8 69 | * make test #(for testing) 70 | 71 | ## with cmake 72 | 73 | * git clone https://github.com/QuasarApp/Qt-Secret.git 74 | * cd Qt-Secret 75 | * git submodule update --init --recursive 76 | * sudo apt install qt5-default 77 | * cmake -DCMAKE_PREFIX_PATH=you/Qt/dir . 78 | * make -j8 79 | * make test #(for testing) 80 | 81 | # Include 82 | 83 | ## for qmake projects 84 | 85 | * cd yourRepo 86 | * git submodule add https://github.com/QuasarApp/Qt-Secret.git # add the repository of Qt-Secret into your repo like submodule 87 | * git submodule update --init --recursive 88 | * Add to the list of libraries for the Qt-Secret assembly. For example, you can create Main.Pro in which connect Qt-Secret and your project.pro files as subprojects. 89 | 90 | **Main.pro:** 91 | ``` qmake 92 | TEMPLATE = subdirs 93 | CONFIG += ordered 94 | 95 | SUBDIRS += \ 96 | Qt-Secret \ 97 | MyProject 98 | ``` 99 | * Include in your MyProject.pro file the pri file of Qt-Secret library 100 | ``` qmake 101 | include($$PWD/../Qt-Secret/src/Qt-Secret.pri) 102 | ``` 103 | * Rebuild your project 104 | 105 | ### For cmake projects 106 | 107 | * cd yourRepo 108 | * git submodule add https://github.com/QuasarApp/Qt-Secret.git # add the repository of Qt-Secret into your repo like submodule 109 | * git submodule update --init --recursive 110 | * Include in your CMakeLists.txt file the main CMakeLists.txt file of Qt-Secret library 111 | ``` cmake 112 | add_subdirectory(Qt-Secret) 113 | target_link_libraries(MyBinary PUBLIC Qt-Secret) 114 | ``` 115 | * Rebuild your project 116 | 117 | #### Note 118 | 119 | By Default Qt-Secret makes as a static library. If you want to create a shared library just add the BUILD_SHARED_LIBS into your main CMakeLists.txt file. Example : 120 | 121 | ```cmake 122 | set(BUILD_SHARED_LIBS ON) 123 | add_subdirectory(Qt-Secret) 124 | target_link_libraries(MyBinary PUBLIC Qt-Secret) 125 | ``` 126 | 127 | ## For other build systems 128 | 129 | * cd yourRepo 130 | * git submodule add https://github.com/QuasarApp/Qt-Secret.git # add the repository of Qt-Secret into your repo like submodule 131 | * git submodule update --init --recursive 132 | * Add the rule for build Qt-Secret 133 | * Add INCLUDEPATH and LIBS for your build system 134 | * Rebuild your project 135 | 136 | 137 | #### Detailed instructions of include in QtCreator see [here](Doc/QtCreator.md). 138 | 139 | # Usage 140 | 141 | ## RSA 142 | 143 | ### Encryption and decryption of messages. 144 | 145 | ``` cpp 146 | #include 147 | #include 148 | 149 | bool testEncryptAndDecryptExample() { 150 | 151 | QByteArray pub, priv; 152 | QRSAEncryption e(QRSAEncryption::Rsa::RSA_2048); 153 | e.generatePairKey(pub, priv); // or other rsa size 154 | 155 | QByteArray msg = "test message"; 156 | 157 | auto encryptMessage = e.encode(msg, pub); 158 | 159 | if (encryptMessage == msg) 160 | return false; 161 | 162 | auto decodeMessage = e.decode(encryptMessage, priv); 163 | 164 | return decodeMessage == msg; 165 | } 166 | 167 | int main() { 168 | if (testEncryptAndDecryptExample()) { 169 | qInfo() << "Success!"; 170 | } 171 | } 172 | ``` 173 | 174 | ### Signature and verification of the message signature. 175 | 176 | ``` cpp 177 | #include 178 | #include 179 | 180 | bool testExample() { 181 | QByteArray pub, priv; 182 | QRSAEncryption e(QRSAEncryption::Rsa::RSA_2048); 183 | e.generatePairKey(pub, priv); // or other rsa size 184 | 185 | QByteArray msg = "test message"; 186 | 187 | auto signedMessage = e.signMessage(msg, priv); 188 | 189 | if (e.checkSignMessage(signedMessage, pub)) { 190 | qInfo() <<" message signed success"; 191 | return true; 192 | } 193 | 194 | return false; 195 | 196 | } 197 | 198 | int main() { 199 | if (testExample()) { 200 | qInfo() <<"success!"; 201 | } 202 | } 203 | ``` 204 | 205 | ## AES 206 | 207 | Sample code using a 128bit key in ECB mode 208 | ``` cpp 209 | #include "qaesencryption.h" 210 | 211 | QAESEncryption encryption(QAESEncryption::AES_128, QAESEncryption::ECB); 212 | QByteArray encodedText = encryption.encode(plainText, key); 213 | 214 | QByteArray decodedText = encryption.decode(encodedText, key); 215 | ``` 216 | 217 | Example for 256bit CBC using QString 218 | ``` cpp 219 | #include 220 | #include "qaesencryption.h" 221 | 222 | QAESEncryption encryption(QAESEncryption::AES_256, QAESEncryption::CBC); 223 | 224 | QString inputStr("The Advanced Encryption Standard (AES), also known by its original name Rijndael " 225 | "is a specification for the encryption of electronic data established by the U.S. " 226 | "National Institute of Standards and Technology (NIST) in 2001"); 227 | QString key("your-string-key"); 228 | QString iv("your-IV-vector"); 229 | 230 | QByteArray hashKey = QCryptographicHash::hash(key.toLocal8Bit(), QCryptographicHash::Sha256); 231 | QByteArray hashIV = QCryptographicHash::hash(iv.toLocal8Bit(), QCryptographicHash::Md5); 232 | 233 | QByteArray encodeText = encryption.encode(inputStr.toLocal8Bit(), hashKey, hashIV); 234 | QByteArray decodeText = encryption.decode(encodeText, hashKey, hashIV); 235 | 236 | QString decodedString = QString(encryption.removePadding(decodeText)); 237 | 238 | //decodedString == inputStr !!! 239 | ``` 240 | 241 | ### Example via static invocation 242 | Static invocation without creating instances, 256 bit key, ECB mode, starting from *QString* text/key 243 | ``` cpp 244 | #include 245 | #include "qaesencryption.h" 246 | 247 | QString inputStr("The Advanced Encryption Standard (AES), also known by its original name Rijndael " 248 | "is a specification for the encryption of electronic data established by the U.S. " 249 | "National Institute of Standards and Technology (NIST) in 2001"); 250 | QString key("your-string-key"); 251 | QString iv("your-IV-vector"); 252 | 253 | QByteArray hashKey = QCryptographicHash::hash(key.toLocal8Bit(), QCryptographicHash::Sha256); 254 | QByteArray hashIV = QCryptographicHash::hash(iv.toLocal8Bit(), QCryptographicHash::Md5); 255 | 256 | //Static invocation 257 | QByteArray encrypted = QAESEncryption::Crypt(QAESEncryption::AES_256, QAESEncryption::CBC, 258 | inputStr.toLocal8Bit(), hashKey, hashIV); 259 | //... 260 | // Removal of Padding via Static function 261 | QString decodedString = QString(QAESEncryption::RemovePadding(decodeText)); 262 | ``` 263 | -------------------------------------------------------------------------------- /doxygen.conf: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.13 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = Qt-Secret 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = docs 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = YES 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219 | # page for each member. If set to NO, the documentation of a member will be part 220 | # of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = NO 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note: For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307 | # to that level are automatically included in the table of contents, even if 308 | # they do not have an id attribute. 309 | # Note: This feature currently applies only to Markdown headings. 310 | # Minimum value: 0, maximum value: 99, default value: 0. 311 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312 | 313 | TOC_INCLUDE_HEADINGS = 0 314 | 315 | # When enabled doxygen tries to link words that correspond to documented 316 | # classes, or namespaces to their corresponding documentation. Such a link can 317 | # be prevented in individual cases by putting a % sign in front of the word or 318 | # globally by setting AUTOLINK_SUPPORT to NO. 319 | # The default value is: YES. 320 | 321 | AUTOLINK_SUPPORT = YES 322 | 323 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324 | # to include (a tag file for) the STL sources as input, then you should set this 325 | # tag to YES in order to let doxygen match functions declarations and 326 | # definitions whose arguments contain STL classes (e.g. func(std::string); 327 | # versus func(std::string) {}). This also make the inheritance and collaboration 328 | # diagrams that involve STL classes more complete and accurate. 329 | # The default value is: NO. 330 | 331 | BUILTIN_STL_SUPPORT = NO 332 | 333 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 334 | # enable parsing support. 335 | # The default value is: NO. 336 | 337 | CPP_CLI_SUPPORT = NO 338 | 339 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341 | # will parse them like normal C++ but will assume all classes use public instead 342 | # of private inheritance when no explicit protection keyword is present. 343 | # The default value is: NO. 344 | 345 | SIP_SUPPORT = NO 346 | 347 | # For Microsoft's IDL there are propget and propput attributes to indicate 348 | # getter and setter methods for a property. Setting this option to YES will make 349 | # doxygen to replace the get and set methods by a property in the documentation. 350 | # This will only work if the methods are indeed getting or setting a simple 351 | # type. If this is not the case, or you want to show the methods anyway, you 352 | # should set this option to NO. 353 | # The default value is: YES. 354 | 355 | IDL_PROPERTY_SUPPORT = YES 356 | 357 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358 | # tag is set to YES then doxygen will reuse the documentation of the first 359 | # member in the group (if any) for the other members of the group. By default 360 | # all members of a group must be documented explicitly. 361 | # The default value is: NO. 362 | 363 | DISTRIBUTE_GROUP_DOC = NO 364 | 365 | # If one adds a struct or class to a group and this option is enabled, then also 366 | # any nested class or struct is added to the same group. By default this option 367 | # is disabled and one has to add nested compounds explicitly via \ingroup. 368 | # The default value is: NO. 369 | 370 | GROUP_NESTED_COMPOUNDS = NO 371 | 372 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 373 | # (for instance a group of public functions) to be put as a subgroup of that 374 | # type (e.g. under the Public Functions section). Set it to NO to prevent 375 | # subgrouping. Alternatively, this can be done per class using the 376 | # \nosubgrouping command. 377 | # The default value is: YES. 378 | 379 | SUBGROUPING = YES 380 | 381 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382 | # are shown inside the group in which they are included (e.g. using \ingroup) 383 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384 | # and RTF). 385 | # 386 | # Note that this feature does not work in combination with 387 | # SEPARATE_MEMBER_PAGES. 388 | # The default value is: NO. 389 | 390 | INLINE_GROUPED_CLASSES = NO 391 | 392 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393 | # with only public data fields or simple typedef fields will be shown inline in 394 | # the documentation of the scope in which they are defined (i.e. file, 395 | # namespace, or group documentation), provided this scope is documented. If set 396 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 397 | # Man pages) or section (for LaTeX and RTF). 398 | # The default value is: NO. 399 | 400 | INLINE_SIMPLE_STRUCTS = NO 401 | 402 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403 | # enum is documented as struct, union, or enum with the name of the typedef. So 404 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405 | # with name TypeT. When disabled the typedef will appear as a member of a file, 406 | # namespace, or class. And the struct will be named TypeS. This can typically be 407 | # useful for C code in case the coding convention dictates that all compound 408 | # types are typedef'ed and only the typedef is referenced, never the tag name. 409 | # The default value is: NO. 410 | 411 | TYPEDEF_HIDES_STRUCT = NO 412 | 413 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414 | # cache is used to resolve symbols given their name and scope. Since this can be 415 | # an expensive process and often the same symbol appears multiple times in the 416 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417 | # doxygen will become slower. If the cache is too large, memory is wasted. The 418 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420 | # symbols. At the end of a run doxygen will report the cache usage and suggest 421 | # the optimal cache size from a speed point of view. 422 | # Minimum value: 0, maximum value: 9, default value: 0. 423 | 424 | LOOKUP_CACHE_SIZE = 0 425 | 426 | #--------------------------------------------------------------------------- 427 | # Build related configuration options 428 | #--------------------------------------------------------------------------- 429 | 430 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431 | # documentation are documented, even if no documentation was available. Private 432 | # class members and static file members will be hidden unless the 433 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434 | # Note: This will also disable the warnings about undocumented members that are 435 | # normally produced when WARNINGS is set to YES. 436 | # The default value is: NO. 437 | 438 | EXTRACT_ALL = YES 439 | 440 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441 | # be included in the documentation. 442 | # The default value is: NO. 443 | 444 | EXTRACT_PRIVATE = NO 445 | 446 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447 | # scope will be included in the documentation. 448 | # The default value is: NO. 449 | 450 | EXTRACT_PACKAGE = NO 451 | 452 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453 | # included in the documentation. 454 | # The default value is: NO. 455 | 456 | EXTRACT_STATIC = NO 457 | 458 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459 | # locally in source files will be included in the documentation. If set to NO, 460 | # only classes defined in header files are included. Does not have any effect 461 | # for Java sources. 462 | # The default value is: YES. 463 | 464 | EXTRACT_LOCAL_CLASSES = YES 465 | 466 | # This flag is only useful for Objective-C code. If set to YES, local methods, 467 | # which are defined in the implementation section but not in the interface are 468 | # included in the documentation. If set to NO, only methods in the interface are 469 | # included. 470 | # The default value is: NO. 471 | 472 | EXTRACT_LOCAL_METHODS = NO 473 | 474 | # If this flag is set to YES, the members of anonymous namespaces will be 475 | # extracted and appear in the documentation as a namespace called 476 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 477 | # the file that contains the anonymous namespace. By default anonymous namespace 478 | # are hidden. 479 | # The default value is: NO. 480 | 481 | EXTRACT_ANON_NSPACES = NO 482 | 483 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484 | # undocumented members inside documented classes or files. If set to NO these 485 | # members will be included in the various overviews, but no documentation 486 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 487 | # The default value is: NO. 488 | 489 | HIDE_UNDOC_MEMBERS = NO 490 | 491 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492 | # undocumented classes that are normally visible in the class hierarchy. If set 493 | # to NO, these classes will be included in the various overviews. This option 494 | # has no effect if EXTRACT_ALL is enabled. 495 | # The default value is: NO. 496 | 497 | HIDE_UNDOC_CLASSES = NO 498 | 499 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500 | # (class|struct|union) declarations. If set to NO, these declarations will be 501 | # included in the documentation. 502 | # The default value is: NO. 503 | 504 | HIDE_FRIEND_COMPOUNDS = NO 505 | 506 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507 | # documentation blocks found inside the body of a function. If set to NO, these 508 | # blocks will be appended to the function's detailed documentation block. 509 | # The default value is: NO. 510 | 511 | HIDE_IN_BODY_DOCS = NO 512 | 513 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 514 | # \internal command is included. If the tag is set to NO then the documentation 515 | # will be excluded. Set it to YES to include the internal documentation. 516 | # The default value is: NO. 517 | 518 | INTERNAL_DOCS = NO 519 | 520 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521 | # names in lower-case letters. If set to YES, upper-case letters are also 522 | # allowed. This is useful if you have classes or files whose names only differ 523 | # in case and if your file system supports case sensitive file names. Windows 524 | # and Mac users are advised to set this option to NO. 525 | # The default value is: system dependent. 526 | 527 | CASE_SENSE_NAMES = YES 528 | 529 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530 | # their full class and namespace scopes in the documentation. If set to YES, the 531 | # scope will be hidden. 532 | # The default value is: NO. 533 | 534 | HIDE_SCOPE_NAMES = NO 535 | 536 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537 | # append additional text to a page's title, such as Class Reference. If set to 538 | # YES the compound reference will be hidden. 539 | # The default value is: NO. 540 | 541 | HIDE_COMPOUND_REFERENCE= NO 542 | 543 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544 | # the files that are included by a file in the documentation of that file. 545 | # The default value is: YES. 546 | 547 | SHOW_INCLUDE_FILES = YES 548 | 549 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550 | # grouped member an include statement to the documentation, telling the reader 551 | # which file to include in order to use the member. 552 | # The default value is: NO. 553 | 554 | SHOW_GROUPED_MEMB_INC = NO 555 | 556 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557 | # files with double quotes in the documentation rather than with sharp brackets. 558 | # The default value is: NO. 559 | 560 | FORCE_LOCAL_INCLUDES = NO 561 | 562 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563 | # documentation for inline members. 564 | # The default value is: YES. 565 | 566 | INLINE_INFO = YES 567 | 568 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569 | # (detailed) documentation of file and class members alphabetically by member 570 | # name. If set to NO, the members will appear in declaration order. 571 | # The default value is: YES. 572 | 573 | SORT_MEMBER_DOCS = YES 574 | 575 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576 | # descriptions of file, namespace and class members alphabetically by member 577 | # name. If set to NO, the members will appear in declaration order. Note that 578 | # this will also influence the order of the classes in the class list. 579 | # The default value is: NO. 580 | 581 | SORT_BRIEF_DOCS = NO 582 | 583 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584 | # (brief and detailed) documentation of class members so that constructors and 585 | # destructors are listed first. If set to NO the constructors will appear in the 586 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588 | # member documentation. 589 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590 | # detailed member documentation. 591 | # The default value is: NO. 592 | 593 | SORT_MEMBERS_CTORS_1ST = NO 594 | 595 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596 | # of group names into alphabetical order. If set to NO the group names will 597 | # appear in their defined order. 598 | # The default value is: NO. 599 | 600 | SORT_GROUP_NAMES = NO 601 | 602 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603 | # fully-qualified names, including namespaces. If set to NO, the class list will 604 | # be sorted only by class name, not including the namespace part. 605 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606 | # Note: This option applies only to the class list, not to the alphabetical 607 | # list. 608 | # The default value is: NO. 609 | 610 | SORT_BY_SCOPE_NAME = NO 611 | 612 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613 | # type resolution of all parameters of a function it will reject a match between 614 | # the prototype and the implementation of a member function even if there is 615 | # only one candidate or it is obvious which candidate to choose by doing a 616 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617 | # accept a match between prototype and implementation in such cases. 618 | # The default value is: NO. 619 | 620 | STRICT_PROTO_MATCHING = NO 621 | 622 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623 | # list. This list is created by putting \todo commands in the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_TODOLIST = YES 627 | 628 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629 | # list. This list is created by putting \test commands in the documentation. 630 | # The default value is: YES. 631 | 632 | GENERATE_TESTLIST = YES 633 | 634 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635 | # list. This list is created by putting \bug commands in the documentation. 636 | # The default value is: YES. 637 | 638 | GENERATE_BUGLIST = YES 639 | 640 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641 | # the deprecated list. This list is created by putting \deprecated commands in 642 | # the documentation. 643 | # The default value is: YES. 644 | 645 | GENERATE_DEPRECATEDLIST= YES 646 | 647 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 648 | # sections, marked by \if ... \endif and \cond 649 | # ... \endcond blocks. 650 | 651 | ENABLED_SECTIONS = 652 | 653 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654 | # initial value of a variable or macro / define can have for it to appear in the 655 | # documentation. If the initializer consists of more lines than specified here 656 | # it will be hidden. Use a value of 0 to hide initializers completely. The 657 | # appearance of the value of individual variables and macros / defines can be 658 | # controlled using \showinitializer or \hideinitializer command in the 659 | # documentation regardless of this setting. 660 | # Minimum value: 0, maximum value: 10000, default value: 30. 661 | 662 | MAX_INITIALIZER_LINES = 30 663 | 664 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665 | # the bottom of the documentation of classes and structs. If set to YES, the 666 | # list will mention the files that were used to generate the documentation. 667 | # The default value is: YES. 668 | 669 | SHOW_USED_FILES = YES 670 | 671 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672 | # will remove the Files entry from the Quick Index and from the Folder Tree View 673 | # (if specified). 674 | # The default value is: YES. 675 | 676 | SHOW_FILES = YES 677 | 678 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679 | # page. This will remove the Namespaces entry from the Quick Index and from the 680 | # Folder Tree View (if specified). 681 | # The default value is: YES. 682 | 683 | SHOW_NAMESPACES = YES 684 | 685 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 686 | # doxygen should invoke to get the current version for each file (typically from 687 | # the version control system). Doxygen will invoke the program by executing (via 688 | # popen()) the command command input-file, where command is the value of the 689 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690 | # by doxygen. Whatever the program writes to standard output is used as the file 691 | # version. For an example see the documentation. 692 | 693 | FILE_VERSION_FILTER = 694 | 695 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696 | # by doxygen. The layout file controls the global structure of the generated 697 | # output files in an output format independent way. To create the layout file 698 | # that represents doxygen's defaults, run doxygen with the -l option. You can 699 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 700 | # will be used as the name of the layout file. 701 | # 702 | # Note that if you run doxygen from a directory containing a file called 703 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704 | # tag is left empty. 705 | 706 | LAYOUT_FILE = src/mini-gmp/CMake/DoxyStyle/DoxygenLayout.xml 707 | 708 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709 | # the reference definitions. This must be a list of .bib files. The .bib 710 | # extension is automatically appended if omitted. This requires the bibtex tool 711 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712 | # For LaTeX the style of the bibliography can be controlled using 713 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714 | # search path. See also \cite for info how to create references. 715 | 716 | CITE_BIB_FILES = 717 | 718 | #--------------------------------------------------------------------------- 719 | # Configuration options related to warning and progress messages 720 | #--------------------------------------------------------------------------- 721 | 722 | # The QUIET tag can be used to turn on/off the messages that are generated to 723 | # standard output by doxygen. If QUIET is set to YES this implies that the 724 | # messages are off. 725 | # The default value is: NO. 726 | 727 | QUIET = NO 728 | 729 | # The WARNINGS tag can be used to turn on/off the warning messages that are 730 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731 | # this implies that the warnings are on. 732 | # 733 | # Tip: Turn warnings on while writing the documentation. 734 | # The default value is: YES. 735 | 736 | WARNINGS = YES 737 | 738 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740 | # will automatically be disabled. 741 | # The default value is: YES. 742 | 743 | WARN_IF_UNDOCUMENTED = YES 744 | 745 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746 | # potential errors in the documentation, such as not documenting some parameters 747 | # in a documented function, or documenting parameters that don't exist or using 748 | # markup commands wrongly. 749 | # The default value is: YES. 750 | 751 | WARN_IF_DOC_ERROR = YES 752 | 753 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754 | # are documented, but have no documentation for their parameters or return 755 | # value. If set to NO, doxygen will only warn about wrong or incomplete 756 | # parameter documentation, but not about the absence of documentation. 757 | # The default value is: NO. 758 | 759 | WARN_NO_PARAMDOC = NO 760 | 761 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762 | # a warning is encountered. 763 | # The default value is: NO. 764 | 765 | WARN_AS_ERROR = NO 766 | 767 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 768 | # can produce. The string should contain the $file, $line, and $text tags, which 769 | # will be replaced by the file and line number from which the warning originated 770 | # and the warning text. Optionally the format may contain $version, which will 771 | # be replaced by the version of the file (if it could be obtained via 772 | # FILE_VERSION_FILTER) 773 | # The default value is: $file:$line: $text. 774 | 775 | WARN_FORMAT = "$file:$line: $text" 776 | 777 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 778 | # messages should be written. If left blank the output is written to standard 779 | # error (stderr). 780 | 781 | WARN_LOGFILE = 782 | 783 | #--------------------------------------------------------------------------- 784 | # Configuration options related to the input files 785 | #--------------------------------------------------------------------------- 786 | 787 | # The INPUT tag is used to specify the files and/or directories that contain 788 | # documented source files. You may enter file names like myfile.cpp or 789 | # directories like /usr/src/myproject. Separate the files or directories with 790 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791 | # Note: If this tag is empty the current directory is searched. 792 | 793 | INPUT = ./ \ 794 | src \ 795 | src/Qt-AES \ 796 | src/Qt-RSA 797 | 798 | # This tag can be used to specify the character encoding of the source files 799 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 800 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 801 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 802 | # possible encodings. 803 | # The default value is: UTF-8. 804 | 805 | INPUT_ENCODING = UTF-8 806 | 807 | # If the value of the INPUT tag contains directories, you can use the 808 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 809 | # *.h) to filter out the source-files in the directories. 810 | # 811 | # Note that for custom extensions or not directly supported extensions you also 812 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 813 | # read by doxygen. 814 | # 815 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 816 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 817 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 818 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 819 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 820 | 821 | FILE_PATTERNS = *.c \ 822 | *.cc \ 823 | *.cxx \ 824 | *.cpp \ 825 | *.c++ \ 826 | *.java \ 827 | *.ii \ 828 | *.ixx \ 829 | *.ipp \ 830 | *.i++ \ 831 | *.inl \ 832 | *.idl \ 833 | *.ddl \ 834 | *.odl \ 835 | *.h \ 836 | *.hh \ 837 | *.hxx \ 838 | *.hpp \ 839 | *.h++ \ 840 | *.cs \ 841 | *.d \ 842 | *.php \ 843 | *.php4 \ 844 | *.php5 \ 845 | *.phtml \ 846 | *.inc \ 847 | *.m \ 848 | *.markdown \ 849 | *.md \ 850 | *.mm \ 851 | *.dox \ 852 | *.py \ 853 | *.pyw \ 854 | *.f90 \ 855 | *.f95 \ 856 | *.f03 \ 857 | *.f08 \ 858 | *.f \ 859 | *.for \ 860 | *.tcl \ 861 | *.vhd \ 862 | *.vhdl \ 863 | *.ucf \ 864 | *.qsf 865 | 866 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 867 | # be searched for input files as well. 868 | # The default value is: NO. 869 | 870 | RECURSIVE = NO 871 | 872 | # The EXCLUDE tag can be used to specify files and/or directories that should be 873 | # excluded from the INPUT source files. This way you can easily exclude a 874 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 875 | # 876 | # Note that relative paths are relative to the directory from which doxygen is 877 | # run. 878 | 879 | EXCLUDE = 880 | 881 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 882 | # directories that are symbolic links (a Unix file system feature) are excluded 883 | # from the input. 884 | # The default value is: NO. 885 | 886 | EXCLUDE_SYMLINKS = NO 887 | 888 | # If the value of the INPUT tag contains directories, you can use the 889 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 890 | # certain files from those directories. 891 | # 892 | # Note that the wildcards are matched against the file with absolute path, so to 893 | # exclude all test directories for example use the pattern */test/* 894 | 895 | EXCLUDE_PATTERNS = 896 | 897 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 898 | # (namespaces, classes, functions, etc.) that should be excluded from the 899 | # output. The symbol name can be a fully qualified name, a word, or if the 900 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 901 | # AClass::ANamespace, ANamespace::*Test 902 | # 903 | # Note that the wildcards are matched against the file with absolute path, so to 904 | # exclude all test directories use the pattern */test/* 905 | 906 | EXCLUDE_SYMBOLS = 907 | 908 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 909 | # that contain example code fragments that are included (see the \include 910 | # command). 911 | 912 | EXAMPLE_PATH = 913 | 914 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 915 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 916 | # *.h) to filter out the source-files in the directories. If left blank all 917 | # files are included. 918 | 919 | EXAMPLE_PATTERNS = * 920 | 921 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 922 | # searched for input files to be used with the \include or \dontinclude commands 923 | # irrespective of the value of the RECURSIVE tag. 924 | # The default value is: NO. 925 | 926 | EXAMPLE_RECURSIVE = NO 927 | 928 | # The IMAGE_PATH tag can be used to specify one or more files or directories 929 | # that contain images that are to be included in the documentation (see the 930 | # \image command). 931 | 932 | IMAGE_PATH = 933 | 934 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 935 | # invoke to filter for each input file. Doxygen will invoke the filter program 936 | # by executing (via popen()) the command: 937 | # 938 | # 939 | # 940 | # where is the value of the INPUT_FILTER tag, and is the 941 | # name of an input file. Doxygen will then use the output that the filter 942 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 943 | # will be ignored. 944 | # 945 | # Note that the filter must not add or remove lines; it is applied before the 946 | # code is scanned, but not when the output code is generated. If lines are added 947 | # or removed, the anchors will not be placed correctly. 948 | # 949 | # Note that for custom extensions or not directly supported extensions you also 950 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 951 | # properly processed by doxygen. 952 | 953 | INPUT_FILTER = 954 | 955 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 956 | # basis. Doxygen will compare the file name with each pattern and apply the 957 | # filter if there is a match. The filters are a list of the form: pattern=filter 958 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 959 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 960 | # patterns match the file name, INPUT_FILTER is applied. 961 | # 962 | # Note that for custom extensions or not directly supported extensions you also 963 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 964 | # properly processed by doxygen. 965 | 966 | FILTER_PATTERNS = 967 | 968 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 969 | # INPUT_FILTER) will also be used to filter the input files that are used for 970 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 971 | # The default value is: NO. 972 | 973 | FILTER_SOURCE_FILES = NO 974 | 975 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 976 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 977 | # it is also possible to disable source filtering for a specific pattern using 978 | # *.ext= (so without naming a filter). 979 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 980 | 981 | FILTER_SOURCE_PATTERNS = 982 | 983 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 984 | # is part of the input, its contents will be placed on the main page 985 | # (index.html). This can be useful if you have a project on for instance GitHub 986 | # and want to reuse the introduction page also for the doxygen output. 987 | 988 | USE_MDFILE_AS_MAINPAGE = ./README.md 989 | 990 | #--------------------------------------------------------------------------- 991 | # Configuration options related to source browsing 992 | #--------------------------------------------------------------------------- 993 | 994 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 995 | # generated. Documented entities will be cross-referenced with these sources. 996 | # 997 | # Note: To get rid of all source code in the generated output, make sure that 998 | # also VERBATIM_HEADERS is set to NO. 999 | # The default value is: NO. 1000 | 1001 | SOURCE_BROWSER = YES 1002 | 1003 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1004 | # classes and enums directly into the documentation. 1005 | # The default value is: NO. 1006 | 1007 | INLINE_SOURCES = NO 1008 | 1009 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1010 | # special comment blocks from generated source code fragments. Normal C, C++ and 1011 | # Fortran comments will always remain visible. 1012 | # The default value is: YES. 1013 | 1014 | STRIP_CODE_COMMENTS = YES 1015 | 1016 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1017 | # function all documented functions referencing it will be listed. 1018 | # The default value is: NO. 1019 | 1020 | REFERENCED_BY_RELATION = NO 1021 | 1022 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1023 | # all documented entities called/used by that function will be listed. 1024 | # The default value is: NO. 1025 | 1026 | REFERENCES_RELATION = NO 1027 | 1028 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1029 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1030 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1031 | # link to the documentation. 1032 | # The default value is: YES. 1033 | 1034 | REFERENCES_LINK_SOURCE = YES 1035 | 1036 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1037 | # source code will show a tooltip with additional information such as prototype, 1038 | # brief description and links to the definition and documentation. Since this 1039 | # will make the HTML file larger and loading of large files a bit slower, you 1040 | # can opt to disable this feature. 1041 | # The default value is: YES. 1042 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1043 | 1044 | SOURCE_TOOLTIPS = YES 1045 | 1046 | # If the USE_HTAGS tag is set to YES then the references to source code will 1047 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1048 | # source browser. The htags tool is part of GNU's global source tagging system 1049 | # (see http://www.gnu.org/software/global/global.html). You will need version 1050 | # 4.8.6 or higher. 1051 | # 1052 | # To use it do the following: 1053 | # - Install the latest version of global 1054 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1055 | # - Make sure the INPUT points to the root of the source tree 1056 | # - Run doxygen as normal 1057 | # 1058 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1059 | # tools must be available from the command line (i.e. in the search path). 1060 | # 1061 | # The result: instead of the source browser generated by doxygen, the links to 1062 | # source code will now point to the output of htags. 1063 | # The default value is: NO. 1064 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1065 | 1066 | USE_HTAGS = NO 1067 | 1068 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1069 | # verbatim copy of the header file for each class for which an include is 1070 | # specified. Set to NO to disable this. 1071 | # See also: Section \class. 1072 | # The default value is: YES. 1073 | 1074 | VERBATIM_HEADERS = YES 1075 | 1076 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1077 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1078 | # cost of reduced performance. This can be particularly helpful with template 1079 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1080 | # information. 1081 | # Note: The availability of this option depends on whether or not doxygen was 1082 | # generated with the -Duse-libclang=ON option for CMake. 1083 | # The default value is: NO. 1084 | 1085 | CLANG_ASSISTED_PARSING = NO 1086 | 1087 | # If clang assisted parsing is enabled you can provide the compiler with command 1088 | # line options that you would normally use when invoking the compiler. Note that 1089 | # the include paths will already be set by doxygen for the files and directories 1090 | # specified with INPUT and INCLUDE_PATH. 1091 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1092 | 1093 | CLANG_OPTIONS = 1094 | 1095 | #--------------------------------------------------------------------------- 1096 | # Configuration options related to the alphabetical class index 1097 | #--------------------------------------------------------------------------- 1098 | 1099 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1100 | # compounds will be generated. Enable this if the project contains a lot of 1101 | # classes, structs, unions or interfaces. 1102 | # The default value is: YES. 1103 | 1104 | ALPHABETICAL_INDEX = YES 1105 | 1106 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1107 | # which the alphabetical index list will be split. 1108 | # Minimum value: 1, maximum value: 20, default value: 5. 1109 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1110 | 1111 | COLS_IN_ALPHA_INDEX = 5 1112 | 1113 | # In case all classes in a project start with a common prefix, all classes will 1114 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1115 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1116 | # while generating the index headers. 1117 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1118 | 1119 | IGNORE_PREFIX = 1120 | 1121 | #--------------------------------------------------------------------------- 1122 | # Configuration options related to the HTML output 1123 | #--------------------------------------------------------------------------- 1124 | 1125 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1126 | # The default value is: YES. 1127 | 1128 | GENERATE_HTML = YES 1129 | 1130 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1131 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1132 | # it. 1133 | # The default directory is: html. 1134 | # This tag requires that the tag GENERATE_HTML is set to YES. 1135 | 1136 | HTML_OUTPUT = . 1137 | 1138 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1139 | # generated HTML page (for example: .htm, .php, .asp). 1140 | # The default value is: .html. 1141 | # This tag requires that the tag GENERATE_HTML is set to YES. 1142 | 1143 | HTML_FILE_EXTENSION = .html 1144 | 1145 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1146 | # each generated HTML page. If the tag is left blank doxygen will generate a 1147 | # standard header. 1148 | # 1149 | # To get valid HTML the header file that includes any scripts and style sheets 1150 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1151 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1152 | # default header using 1153 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1154 | # YourConfigFile 1155 | # and then modify the file new_header.html. See also section "Doxygen usage" 1156 | # for information on how to generate the default header that doxygen normally 1157 | # uses. 1158 | # Note: The header is subject to change so you typically have to regenerate the 1159 | # default header when upgrading to a newer version of doxygen. For a description 1160 | # of the possible markers and block names see the documentation. 1161 | # This tag requires that the tag GENERATE_HTML is set to YES. 1162 | 1163 | HTML_HEADER = 1164 | 1165 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1166 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1167 | # footer. See HTML_HEADER for more information on how to generate a default 1168 | # footer and what special commands can be used inside the footer. See also 1169 | # section "Doxygen usage" for information on how to generate the default footer 1170 | # that doxygen normally uses. 1171 | # This tag requires that the tag GENERATE_HTML is set to YES. 1172 | 1173 | HTML_FOOTER = 1174 | 1175 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1176 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1177 | # the HTML output. If left blank doxygen will generate a default style sheet. 1178 | # See also section "Doxygen usage" for information on how to generate the style 1179 | # sheet that doxygen normally uses. 1180 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1181 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1182 | # obsolete. 1183 | # This tag requires that the tag GENERATE_HTML is set to YES. 1184 | 1185 | HTML_STYLESHEET = 1186 | 1187 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1188 | # cascading style sheets that are included after the standard style sheets 1189 | # created by doxygen. Using this option one can overrule certain style aspects. 1190 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1191 | # standard style sheet and is therefore more robust against future updates. 1192 | # Doxygen will copy the style sheet files to the output directory. 1193 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1194 | # style sheet in the list overrules the setting of the previous ones in the 1195 | # list). For an example see the documentation. 1196 | # This tag requires that the tag GENERATE_HTML is set to YES. 1197 | 1198 | HTML_EXTRA_STYLESHEET = src/mini-gmp/CMake/DoxyStyle/doxygenStyles.css 1199 | 1200 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1201 | # other source files which should be copied to the HTML output directory. Note 1202 | # that these files will be copied to the base HTML output directory. Use the 1203 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1204 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1205 | # files will be copied as-is; there are no commands or markers available. 1206 | # This tag requires that the tag GENERATE_HTML is set to YES. 1207 | 1208 | HTML_EXTRA_FILES = 1209 | 1210 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1211 | # will adjust the colors in the style sheet and background images according to 1212 | # this color. Hue is specified as an angle on a colorwheel, see 1213 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1214 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1215 | # purple, and 360 is red again. 1216 | # Minimum value: 0, maximum value: 359, default value: 220. 1217 | # This tag requires that the tag GENERATE_HTML is set to YES. 1218 | 1219 | HTML_COLORSTYLE_HUE = 220 1220 | 1221 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1222 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1223 | # value of 255 will produce the most vivid colors. 1224 | # Minimum value: 0, maximum value: 255, default value: 100. 1225 | # This tag requires that the tag GENERATE_HTML is set to YES. 1226 | 1227 | HTML_COLORSTYLE_SAT = 100 1228 | 1229 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1230 | # luminance component of the colors in the HTML output. Values below 100 1231 | # gradually make the output lighter, whereas values above 100 make the output 1232 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1233 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1234 | # change the gamma. 1235 | # Minimum value: 40, maximum value: 240, default value: 80. 1236 | # This tag requires that the tag GENERATE_HTML is set to YES. 1237 | 1238 | HTML_COLORSTYLE_GAMMA = 80 1239 | 1240 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1241 | # page will contain the date and time when the page was generated. Setting this 1242 | # to YES can help to show when doxygen was last run and thus if the 1243 | # documentation is up to date. 1244 | # The default value is: NO. 1245 | # This tag requires that the tag GENERATE_HTML is set to YES. 1246 | 1247 | HTML_TIMESTAMP = NO 1248 | 1249 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1250 | # documentation will contain sections that can be hidden and shown after the 1251 | # page has loaded. 1252 | # The default value is: NO. 1253 | # This tag requires that the tag GENERATE_HTML is set to YES. 1254 | 1255 | HTML_DYNAMIC_SECTIONS = NO 1256 | 1257 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1258 | # shown in the various tree structured indices initially; the user can expand 1259 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1260 | # such a level that at most the specified number of entries are visible (unless 1261 | # a fully collapsed tree already exceeds this amount). So setting the number of 1262 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1263 | # representing an infinite number of entries and will result in a full expanded 1264 | # tree by default. 1265 | # Minimum value: 0, maximum value: 9999, default value: 100. 1266 | # This tag requires that the tag GENERATE_HTML is set to YES. 1267 | 1268 | HTML_INDEX_NUM_ENTRIES = 100 1269 | 1270 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1271 | # generated that can be used as input for Apple's Xcode 3 integrated development 1272 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1273 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1274 | # Makefile in the HTML output directory. Running make will produce the docset in 1275 | # that directory and running make install will install the docset in 1276 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1277 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1278 | # for more information. 1279 | # The default value is: NO. 1280 | # This tag requires that the tag GENERATE_HTML is set to YES. 1281 | 1282 | GENERATE_DOCSET = NO 1283 | 1284 | # This tag determines the name of the docset feed. A documentation feed provides 1285 | # an umbrella under which multiple documentation sets from a single provider 1286 | # (such as a company or product suite) can be grouped. 1287 | # The default value is: Doxygen generated docs. 1288 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1289 | 1290 | DOCSET_FEEDNAME = "Doxygen generated docs" 1291 | 1292 | # This tag specifies a string that should uniquely identify the documentation 1293 | # set bundle. This should be a reverse domain-name style string, e.g. 1294 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1295 | # The default value is: org.doxygen.Project. 1296 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1297 | 1298 | DOCSET_BUNDLE_ID = org.doxygen.Project 1299 | 1300 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1301 | # the documentation publisher. This should be a reverse domain-name style 1302 | # string, e.g. com.mycompany.MyDocSet.documentation. 1303 | # The default value is: org.doxygen.Publisher. 1304 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1305 | 1306 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1307 | 1308 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1309 | # The default value is: Publisher. 1310 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1311 | 1312 | DOCSET_PUBLISHER_NAME = Publisher 1313 | 1314 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1315 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1316 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1317 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1318 | # Windows. 1319 | # 1320 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1321 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1322 | # files are now used as the Windows 98 help format, and will replace the old 1323 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1324 | # HTML files also contain an index, a table of contents, and you can search for 1325 | # words in the documentation. The HTML workshop also contains a viewer for 1326 | # compressed HTML files. 1327 | # The default value is: NO. 1328 | # This tag requires that the tag GENERATE_HTML is set to YES. 1329 | 1330 | GENERATE_HTMLHELP = NO 1331 | 1332 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1333 | # file. You can add a path in front of the file if the result should not be 1334 | # written to the html output directory. 1335 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1336 | 1337 | CHM_FILE = 1338 | 1339 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1340 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1341 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1342 | # The file has to be specified with full path. 1343 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1344 | 1345 | HHC_LOCATION = 1346 | 1347 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1348 | # (YES) or that it should be included in the master .chm file (NO). 1349 | # The default value is: NO. 1350 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1351 | 1352 | GENERATE_CHI = NO 1353 | 1354 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1355 | # and project file content. 1356 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1357 | 1358 | CHM_INDEX_ENCODING = 1359 | 1360 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1361 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1362 | # enables the Previous and Next buttons. 1363 | # The default value is: NO. 1364 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1365 | 1366 | BINARY_TOC = NO 1367 | 1368 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1369 | # the table of contents of the HTML help documentation and to the tree view. 1370 | # The default value is: NO. 1371 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1372 | 1373 | TOC_EXPAND = NO 1374 | 1375 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1376 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1377 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1378 | # (.qch) of the generated HTML documentation. 1379 | # The default value is: NO. 1380 | # This tag requires that the tag GENERATE_HTML is set to YES. 1381 | 1382 | GENERATE_QHP = NO 1383 | 1384 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1385 | # the file name of the resulting .qch file. The path specified is relative to 1386 | # the HTML output folder. 1387 | # This tag requires that the tag GENERATE_QHP is set to YES. 1388 | 1389 | QCH_FILE = 1390 | 1391 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1392 | # Project output. For more information please see Qt Help Project / Namespace 1393 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1394 | # The default value is: org.doxygen.Project. 1395 | # This tag requires that the tag GENERATE_QHP is set to YES. 1396 | 1397 | QHP_NAMESPACE = org.doxygen.Project 1398 | 1399 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1400 | # Help Project output. For more information please see Qt Help Project / Virtual 1401 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1402 | # folders). 1403 | # The default value is: doc. 1404 | # This tag requires that the tag GENERATE_QHP is set to YES. 1405 | 1406 | QHP_VIRTUAL_FOLDER = doc 1407 | 1408 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1409 | # filter to add. For more information please see Qt Help Project / Custom 1410 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1411 | # filters). 1412 | # This tag requires that the tag GENERATE_QHP is set to YES. 1413 | 1414 | QHP_CUST_FILTER_NAME = 1415 | 1416 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1417 | # custom filter to add. For more information please see Qt Help Project / Custom 1418 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1419 | # filters). 1420 | # This tag requires that the tag GENERATE_QHP is set to YES. 1421 | 1422 | QHP_CUST_FILTER_ATTRS = 1423 | 1424 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1425 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1426 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1427 | # This tag requires that the tag GENERATE_QHP is set to YES. 1428 | 1429 | QHP_SECT_FILTER_ATTRS = 1430 | 1431 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1432 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1433 | # generated .qhp file. 1434 | # This tag requires that the tag GENERATE_QHP is set to YES. 1435 | 1436 | QHG_LOCATION = 1437 | 1438 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1439 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1440 | # install this plugin and make it available under the help contents menu in 1441 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1442 | # to be copied into the plugins directory of eclipse. The name of the directory 1443 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1444 | # After copying Eclipse needs to be restarted before the help appears. 1445 | # The default value is: NO. 1446 | # This tag requires that the tag GENERATE_HTML is set to YES. 1447 | 1448 | GENERATE_ECLIPSEHELP = NO 1449 | 1450 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1451 | # the directory name containing the HTML and XML files should also have this 1452 | # name. Each documentation set should have its own identifier. 1453 | # The default value is: org.doxygen.Project. 1454 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1455 | 1456 | ECLIPSE_DOC_ID = QuasarApp.Qt-Secret 1457 | 1458 | # If you want full control over the layout of the generated HTML pages it might 1459 | # be necessary to disable the index and replace it with your own. The 1460 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1461 | # of each HTML page. A value of NO enables the index and the value YES disables 1462 | # it. Since the tabs in the index contain the same information as the navigation 1463 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1464 | # The default value is: NO. 1465 | # This tag requires that the tag GENERATE_HTML is set to YES. 1466 | 1467 | DISABLE_INDEX = NO 1468 | 1469 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1470 | # structure should be generated to display hierarchical information. If the tag 1471 | # value is set to YES, a side panel will be generated containing a tree-like 1472 | # index structure (just like the one that is generated for HTML Help). For this 1473 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1474 | # (i.e. any modern browser). Windows users are probably better off using the 1475 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1476 | # further fine-tune the look of the index. As an example, the default style 1477 | # sheet generated by doxygen has an example that shows how to put an image at 1478 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1479 | # the same information as the tab index, you could consider setting 1480 | # DISABLE_INDEX to YES when enabling this option. 1481 | # The default value is: NO. 1482 | # This tag requires that the tag GENERATE_HTML is set to YES. 1483 | 1484 | GENERATE_TREEVIEW = YES 1485 | 1486 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1487 | # doxygen will group on one line in the generated HTML documentation. 1488 | # 1489 | # Note that a value of 0 will completely suppress the enum values from appearing 1490 | # in the overview section. 1491 | # Minimum value: 0, maximum value: 20, default value: 4. 1492 | # This tag requires that the tag GENERATE_HTML is set to YES. 1493 | 1494 | ENUM_VALUES_PER_LINE = 4 1495 | 1496 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1497 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1498 | # Minimum value: 0, maximum value: 1500, default value: 250. 1499 | # This tag requires that the tag GENERATE_HTML is set to YES. 1500 | 1501 | TREEVIEW_WIDTH = 250 1502 | 1503 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1504 | # external symbols imported via tag files in a separate window. 1505 | # The default value is: NO. 1506 | # This tag requires that the tag GENERATE_HTML is set to YES. 1507 | 1508 | EXT_LINKS_IN_WINDOW = NO 1509 | 1510 | # Use this tag to change the font size of LaTeX formulas included as images in 1511 | # the HTML documentation. When you change the font size after a successful 1512 | # doxygen run you need to manually remove any form_*.png images from the HTML 1513 | # output directory to force them to be regenerated. 1514 | # Minimum value: 8, maximum value: 50, default value: 10. 1515 | # This tag requires that the tag GENERATE_HTML is set to YES. 1516 | 1517 | FORMULA_FONTSIZE = 10 1518 | 1519 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1520 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1521 | # supported properly for IE 6.0, but are supported on all modern browsers. 1522 | # 1523 | # Note that when changing this option you need to delete any form_*.png files in 1524 | # the HTML output directory before the changes have effect. 1525 | # The default value is: YES. 1526 | # This tag requires that the tag GENERATE_HTML is set to YES. 1527 | 1528 | FORMULA_TRANSPARENT = YES 1529 | 1530 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1531 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1532 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1533 | # installed or if you want to formulas look prettier in the HTML output. When 1534 | # enabled you may also need to install MathJax separately and configure the path 1535 | # to it using the MATHJAX_RELPATH option. 1536 | # The default value is: NO. 1537 | # This tag requires that the tag GENERATE_HTML is set to YES. 1538 | 1539 | USE_MATHJAX = NO 1540 | 1541 | # When MathJax is enabled you can set the default output format to be used for 1542 | # the MathJax output. See the MathJax site (see: 1543 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1544 | # Possible values are: HTML-CSS (which is slower, but has the best 1545 | # compatibility), NativeMML (i.e. MathML) and SVG. 1546 | # The default value is: HTML-CSS. 1547 | # This tag requires that the tag USE_MATHJAX is set to YES. 1548 | 1549 | MATHJAX_FORMAT = HTML-CSS 1550 | 1551 | # When MathJax is enabled you need to specify the location relative to the HTML 1552 | # output directory using the MATHJAX_RELPATH option. The destination directory 1553 | # should contain the MathJax.js script. For instance, if the mathjax directory 1554 | # is located at the same level as the HTML output directory, then 1555 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1556 | # Content Delivery Network so you can quickly see the result without installing 1557 | # MathJax. However, it is strongly recommended to install a local copy of 1558 | # MathJax from http://www.mathjax.org before deployment. 1559 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1560 | # This tag requires that the tag USE_MATHJAX is set to YES. 1561 | 1562 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1563 | 1564 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1565 | # extension names that should be enabled during MathJax rendering. For example 1566 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1567 | # This tag requires that the tag USE_MATHJAX is set to YES. 1568 | 1569 | MATHJAX_EXTENSIONS = 1570 | 1571 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1572 | # of code that will be used on startup of the MathJax code. See the MathJax site 1573 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1574 | # example see the documentation. 1575 | # This tag requires that the tag USE_MATHJAX is set to YES. 1576 | 1577 | MATHJAX_CODEFILE = 1578 | 1579 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1580 | # the HTML output. The underlying search engine uses javascript and DHTML and 1581 | # should work on any modern browser. Note that when using HTML help 1582 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1583 | # there is already a search function so this one should typically be disabled. 1584 | # For large projects the javascript based search engine can be slow, then 1585 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1586 | # search using the keyboard; to jump to the search box use + S 1587 | # (what the is depends on the OS and browser, but it is typically 1588 | # , /