From cc5212fdb1a9165b1b4f63ad21198172a068ee43 Mon Sep 17 00:00:00 2001 From: Felix Reichmann <54814163+Van-Fouran@users.noreply.github.com> Date: Tue, 16 Aug 2022 08:21:55 +0200 Subject: Documentation overwork (#953) Github PR: https://github.com/veracrypt/VeraCrypt/pull/953 * Create CompilingGuidelinerh * Initial Upload Windows Compiling Guide * Removed RIPEMD-160 from Product64.wxs. See commit from 21.03.2022 * Completed Win compiling guideline * Added link to detailed compiling guide * Added link to detailed compiling guide * Restructured docu main page * Added sourceforge link * Added compiling guide for Linux * References to detailed instructions * Revert "Removed RIPEMD-160 from Product64.wxs. See commit from 21.03.2022" This reverts commit 024ae2a4659a6d9e65673531338e10bd10b8a3a0. * Correction of a div box --- doc/html/CompilingGuidelineLinux.html | 329 ++++++ doc/html/CompilingGuidelineWin.html | 1231 ++++++++++++++++++++ doc/html/CompilingGuidelineWin/AddNewSystemVar.jpg | Bin 0 -> 71100 bytes doc/html/CompilingGuidelineWin/CertVerifyFails.jpg | Bin 0 -> 15443 bytes .../CertificateCannotBeVerified.jpg | Bin 0 -> 87022 bytes .../DistributionPackageDamaged.jpg | Bin 0 -> 10581 bytes doc/html/CompilingGuidelineWin/DownloadVS2010.jpg | Bin 0 -> 167558 bytes doc/html/CompilingGuidelineWin/DownloadVS2019.jpg | Bin 0 -> 231800 bytes .../CompilingGuidelineWin/DownloadVSBuildTools.jpg | Bin 0 -> 187788 bytes doc/html/CompilingGuidelineWin/NasmCommandLine.jpg | Bin 0 -> 27541 bytes .../CompilingGuidelineWin/RegeditPermissions-1.jpg | Bin 0 -> 42281 bytes .../CompilingGuidelineWin/RegeditPermissions-2.jpg | Bin 0 -> 82730 bytes .../CompilingGuidelineWin/RegeditPermissions-3.jpg | Bin 0 -> 48073 bytes .../CompilingGuidelineWin/RegeditPermissions-4.jpg | Bin 0 -> 20213 bytes .../SelectAdvancedSystemSettings.jpg | Bin 0 -> 142348 bytes .../SelectEnvironmentVariables.jpg | Bin 0 -> 41283 bytes .../CompilingGuidelineWin/SelectPathVariable.jpg | Bin 0 -> 71894 bytes doc/html/CompilingGuidelineWin/SelectThisPC.jpg | Bin 0 -> 50245 bytes .../CompilingGuidelineWin/VS2010BuildSolution.jpg | Bin 0 -> 59737 bytes .../CompilingGuidelineWin/VS2010Win32Config.jpg | Bin 0 -> 167454 bytes doc/html/CompilingGuidelineWin/VS2010X64Config.jpg | Bin 0 -> 149165 bytes .../CompilingGuidelineWin/VS2019ARM64Config.jpg | Bin 0 -> 58551 bytes .../CompilingGuidelineWin/VS2019BuildSolution.jpg | Bin 0 -> 49572 bytes doc/html/CompilingGuidelineWin/YasmCommandLine.jpg | Bin 0 -> 33328 bytes doc/html/CompilingGuidelineWin/gzipCommandLine.jpg | Bin 0 -> 28217 bytes doc/html/CompilingGuidelineWin/upxCommandLine.jpg | Bin 0 -> 52807 bytes doc/html/Documentation.html | 489 ++++++-- doc/html/LinuxPrepAndBuild.sh | 20 + doc/html/Miscellaneous.html | 48 - 29 files changed, 1956 insertions(+), 161 deletions(-) create mode 100644 doc/html/CompilingGuidelineLinux.html create mode 100644 doc/html/CompilingGuidelineWin.html create mode 100644 doc/html/CompilingGuidelineWin/AddNewSystemVar.jpg create mode 100644 doc/html/CompilingGuidelineWin/CertVerifyFails.jpg create mode 100644 doc/html/CompilingGuidelineWin/CertificateCannotBeVerified.jpg create mode 100644 doc/html/CompilingGuidelineWin/DistributionPackageDamaged.jpg create mode 100644 doc/html/CompilingGuidelineWin/DownloadVS2010.jpg create mode 100644 doc/html/CompilingGuidelineWin/DownloadVS2019.jpg create mode 100644 doc/html/CompilingGuidelineWin/DownloadVSBuildTools.jpg create mode 100644 doc/html/CompilingGuidelineWin/NasmCommandLine.jpg create mode 100644 doc/html/CompilingGuidelineWin/RegeditPermissions-1.jpg create mode 100644 doc/html/CompilingGuidelineWin/RegeditPermissions-2.jpg create mode 100644 doc/html/CompilingGuidelineWin/RegeditPermissions-3.jpg create mode 100644 doc/html/CompilingGuidelineWin/RegeditPermissions-4.jpg create mode 100644 doc/html/CompilingGuidelineWin/SelectAdvancedSystemSettings.jpg create mode 100644 doc/html/CompilingGuidelineWin/SelectEnvironmentVariables.jpg create mode 100644 doc/html/CompilingGuidelineWin/SelectPathVariable.jpg create mode 100644 doc/html/CompilingGuidelineWin/SelectThisPC.jpg create mode 100644 doc/html/CompilingGuidelineWin/VS2010BuildSolution.jpg create mode 100644 doc/html/CompilingGuidelineWin/VS2010Win32Config.jpg create mode 100644 doc/html/CompilingGuidelineWin/VS2010X64Config.jpg create mode 100644 doc/html/CompilingGuidelineWin/VS2019ARM64Config.jpg create mode 100644 doc/html/CompilingGuidelineWin/VS2019BuildSolution.jpg create mode 100644 doc/html/CompilingGuidelineWin/YasmCommandLine.jpg create mode 100644 doc/html/CompilingGuidelineWin/gzipCommandLine.jpg create mode 100644 doc/html/CompilingGuidelineWin/upxCommandLine.jpg create mode 100644 doc/html/LinuxPrepAndBuild.sh delete mode 100644 doc/html/Miscellaneous.html (limited to 'doc') diff --git a/doc/html/CompilingGuidelineLinux.html b/doc/html/CompilingGuidelineLinux.html new file mode 100644 index 00000000..a8460518 --- /dev/null +++ b/doc/html/CompilingGuidelineLinux.html @@ -0,0 +1,329 @@ + + + + + + + +VeraCrypt - Free Open source disk encryption with strong security for the Paranoid + + + + + + +
+VeraCrypt +
+ + + +
+

+Documentation +>> +Compiling Gudineline for Linux +

+ +
+This guide describes how to set up a Linux System that can compile the VeraCrypt. Further it is described how VeraCrypt is going to be compiled.
+The procedure for a Ubuntu 22.04 LTS system is described here as an example, but the procedure for other Linux systems is analogous. +
+ +
+
+
+The following components are required for compiling VeraCrypt: +
    +
  1. GNU Make
  2. +
  3. GNU C++ Compiler 4.0
  4. +
  5. YASM 1.3.0
  6. +
  7. pkg-config
  8. +
  9. wxWidgets 3.2 shared library and header files installed or wxWidgets 3.0 library source code
  10. +
  11. FUSE library and header files
  12. +
+
+ +
+If you do not want to perform the single steps below, you can run these commands to build an environment and to compile VeraCrpyt:
+Download as script: Script
+ +sudo apt update
+sudo apt install -y build-essential yasm pkg-config libgtk-3-dev
+wget https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.0/wxWidgets-3.2.0.tar.bz2
+tar -xf wxWidgets-3.2.0.tar.bz2
+cd wxWidgets-3.2.0
+mkdir gtk-build
+cd gtk-build
+../configure
+make
+sudo make install
+sudo ldconfig
+cd ../..
+rm -r wxWidgets-3.2.0
+rm wxWidgets-3.2.0.tar.bz2
+sudo apt install -y libfuse-dev git
+git clone https://github.com/veracrypt/VeraCrypt.git +cd ~/VeraCrypt/src
+make +
+
+ +
+
+ Installation of GNU Make + Installation of GNU Make +
+

+

    +
  1. + Open a terminal +
  2. +
  3. + Execute the following commands:
    + + sudo apt update
    + sudo apt install build-essential +
    +
  4. +
+

+
+
+ +
+ Installation of GNU C++ Compiler 4.0 + Installation of GNU C++ Compiler 4.0 +
+

If the build-essential were already installed in the step before, this step can be skipped. +

    +
  1. + Open a terminal +
  2. +
  3. + Execute the following commands:
    + + sudo apt update
    + sudo apt install build-essential +
    +
  4. +
+

+
+
+ +
+ Installation of YASM + Installation of YASM +
+

+

    +
  1. + Open a terminal +
  2. +
  3. + Execute the following commands:
    + + sudo apt update
    + sudo apt install yasm +
    +
  4. +
+

+
+
+ +
+ Installation of pkg-config + Installation of pkg-config +
+

+

    +
  1. + Open a terminal +
  2. +
  3. + Execute the following commands:
    + + sudo apt update
    + sudo apt install pkg-config +
    +
  4. +
+

+
+
+ +
+ Installation of wxWidgets 3.2 + Installation of wxWidgets 3.2 +
+

+

    +
  1. + Open a terminal +
  2. +
  3. + Execute the following commands:
    + + sudo apt install libgtk-3-dev
    + wget https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.0/wxWidgets-3.2.0.tar.bz2
    + tar -xf wxWidgets-3.2.0.tar.bz2
    + cd wxWidgets-3.2.0
    + mkdir gtk-build
    + cd gtk-build
    + ../configure
    + make
    + sudo make install
    + sudo ldconfig
    + cd ../..
    + rm -r wxWidgets-3.2.0
    +
    +
  4. +
+

+
+
+ +
+ Installation of libfuse + Installation of libfuse +
+

+

    +
  1. + Open a terminal +
  2. +
  3. + Execute the following commands:
    + + sudo apt update
    + sudo apt install libfuse-dev +
    +
  4. +
+

+
+
+ +
+ Download VeraCrypt + Download VeraCrypt +
+

+

    +
  1. + Open a terminal +
  2. +
  3. + Execute the following commands:
    + + sudo apt update
    + sudo apt install git
    + git clone https://github.com/veracrypt/VeraCrypt.git +
    +
  4. +
+

+
+
+ +
+ Compile VeraCrypt + Compile VeraCrypt +
+

Remarks:
+

    +
  • + If you have not installed wxWidgets like described here, you may have to modify the make statement to reference to the right file:
    + make WXSTATIC=1 +
  • +
  • + By default, a universal executable supporting both graphical and text user interface (through the switch --text) is built.
    + On Linux, a console-only executable, which requires no GUI library, can be built using the 'NOGUI' parameter:
    + + make NOGUI=1 WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild
    + make NOGUI=1 WXSTATIC=1 +
    +
  • +
+ Steps: +
    +
  1. + Open a terminal +
  2. +
  3. + Execute the following commands:
    + + cd ~/VeraCrypt/src
    + make +
    +
  4. +
  5. + If successful, the VeraCrypt executable should be located in the directory 'Main'. +
  6. +
+

+
+
+ +
+ diff --git a/doc/html/CompilingGuidelineWin.html b/doc/html/CompilingGuidelineWin.html new file mode 100644 index 00000000..5b5554c2 --- /dev/null +++ b/doc/html/CompilingGuidelineWin.html @@ -0,0 +1,1231 @@ + + + + + + + +VeraCrypt - Free Open source disk encryption with strong security for the Paranoid + + + + + + +
+VeraCrypt +
+ + + +
+

+Documentation +>> +Compiling Gudineline for Windows +

+ +
+This guide describes how to set up a Windows system that can compile the VeraCrypt. Further it is described how VeraCrypt is going to be compiled.
+The procedure for a Windows 10 system is described here as an example, but the procedure for other Windows systems is analogous. +
+ +
+The following components are required for compiling VeraCrypt: + +
    +
  1. Microsoft Visual Studio 2010
  2. +
  3. Microsoft Visual Studio 2010 Service Pack 1
  4. +
  5. NASM
  6. +
  7. YASM
  8. +
  9. Visual C++ 1.52
  10. +
  11. Windows SDK 7.1
  12. +
  13. Windows Driver Kit 7.1
  14. +
  15. Windows 8.1 SDK
  16. +
  17. gzip
  18. +
  19. upx
  20. +
  21. 7zip
  22. +
  23. Wix3
  24. +
  25. Microsoft Visual Studio 2019
  26. +
  27. Windows 10 SDK
  28. +
  29. Windows Driver Kit 1903
  30. +
  31. Visual Studio build tools
  32. + +
+ +
+ + +
+
+ Installation of Microsoft Visual Studio 2010 + Installation of Microsoft Visual Studio 2010 +
+

+

    +
  1. + Visit the following Microsoft website and log in with a free Microsoft account:
    + https://my.visualstudio.com/Downloads?q=Visual%20Studio%202010%20Professional&pgroup= +
  2. +
  3. + Please download a (trial) version of “Visual Studio Professional 2010”
    + +
  4. +
  5. + Mount the downloaded ISO file by doubleclicking it +
  6. +
  7. + Run the file "autorun.exe" as administrator +
  8. +
  9. + Install Microsoft Visual Studio 2010 with the default settings +
  10. +
+ The installation of the Microsoft SQL Server 2008 Express Service Pack 1 (x64) may fail, but it is not required for compiling VeraCrypt. +

+
+
+ +
+ Installation of Microsoft Visual Studio 2010 Service Pack 1 + Installation of Microsoft Visual Studio 2010 Service Pack 1 +
+

+ Note: The content the official installer from Microsoft tries to download is no longer available. Therefore, it is necessary to use an offline installer. +

    +
  1. + Visit the website of the internet archive and download the iso image of the Microsoft Visual Studio 2010 Service Pack 1:
    + https://archive.org/details/vs-2010-sp-1dvd-1 +
  2. +
  3. + Mount the downloaded ISO file by doubleclicking it +
  4. +
  5. + Run the file "Setup.exe" as administrator +
  6. +
  7. + Install Microsoft Visual Studio 2010 Service Pack 1 with the default settings +
  8. +
+

+
+
+ +
+ Installation of NASM + Installation of NASM +
+

+

    +
  1. + Download “nasm-2.08-installer.exe” at:
    + https://www.nasm.us/pub/nasm/releasebuilds/2.08/win32/ +
  2. +
  3. + Run the file as administrator +
  4. +
  5. + Install NASM with the default settings +
  6. +
  7. + Add NASM to the path Variable. This will make the command globally available on the command line.
    +
      +
    1. + Open a file explorer +
    2. +
    3. + Within the left file tree, please make a right click on "This PC" and select "Properties"
      + +
    4. +
    5. + Within the right menu, please click on "Advanced system settings"
      + +
    6. +
    7. + Please click on "Environment Variables"
      + +
    8. +
    9. + Within the area of the system variables, please select the "Path" variable and click on "Edit..."
      + +
    10. +
    11. + Click on "New" and add the following value:
      +

      C:\Program Files (x86)\nasm

      +
    12. +
    13. + Close the windows by clicking on "OK" +
    14. +
    +
  8. +
  9. + To check if the configuration is working correctly, please open a command prompt and watch the output of the following command:
    +

    nasm


    + +
  10. +
+

+
+
+ +
+ Installation of YASM + Installation of YASM +
+

+

    +
  1. + Please create the following folder:
    + C:\Program Files\YASM +
  2. +
  3. + Please download the file "Win64 VS2010 .zip" at:
    + https://yasm.tortall.net/Download.html +
  4. +
  5. + Your browser might inform you that the file might be a security risk due to the low download rate or the unencrypted connection. Nevertheless, the official website is the most reliable source for this file, so we recommend to allow the download +
  6. +
  7. + Unzip the zip file and copy the files to “C:\Program Files\YASM” +
  8. +
  9. + Please download the file "Win64 .exe" at:
    + https://yasm.tortall.net/Download.html +
  10. +
  11. + Your browser might inform you that the file might be a security risk due to the low download rate or the unencrypted connection. Nevertheless, the official website is the most reliable source for this file, so we recommend to allow the download +
  12. +
  13. + Rename the file to “yasm.exe” and copy it to “C:\Program Files\YASM” +
  14. +
  15. + Add YASM to the path Variable and create a new system variable for YASM. This will make the command globally available on the command line.
    +
      +
    1. + Open a file explorer +
    2. +
    3. + Within the left file tree, please make a right click on "This PC" and select "Properties"
      + +
    4. +
    5. + Within the right menu, please click on "Advanced system settings"
      + +
    6. +
    7. + Please click on "Environment Variables"
      + +
    8. +
    9. + Within the area of the system variables, please select the "Path" variable and click on "Edit..."
      + +
    10. +
    11. + Click on "New" and add the following value:
      +

      C:\Program Files\YASM

      +
    12. +
    13. + Close the top window by clicking on "OK" +
    14. +
    15. + Within the area of the system variables, please click on "New..."
      + +
    16. +
    17. + Fill out the form with the following values:
      +

      Variable name: YASMPATH
      Variable value: C:\Program Files\YASM

      +
    18. +
    19. + Close the windows by clicking on "OK" +
    20. +
    +
  16. +
  17. + To check if the configuration is working correctly, please open a command prompt and watch the output of the following command:
    +

    yasm


    + and
    +

    vsyasm


    + +
  18. +
+

+
+
+ +
+ Installation of Microsoft Visual C++ 1.52 + Installation of Microsoft Visual C++ 1.52 +
+

+

    +
  1. + Visual C++ 1.52 is available via the paid Microsoft MSDN subscription. If you do not have a subscription, you download the ISO image via the internet archive:
    + https://archive.org/details/ms-vc152 +
  2. +
  3. + Create the folder “C:\MSVC15” +
  4. +
  5. + Mount the ISO file and copy the content of the folder “MSVC” to “C:\MSVC15” +
  6. +
  7. + Create a system variable for Microsoft Visual C++ 1.52
    +
      +
    1. + Open a file explorer +
    2. +
    3. + Within the left file tree, please make a right click on "This PC" and select "Properties"
      + +
    4. +
    5. + Within the right menu, please click on "Advanced system settings"
      + +
    6. +
    7. + Please click on "Environment Variables"
      + +
    8. +
    9. + Within the area of the system variables, please click on "New..."
      + +
    10. +
    11. + Fill out the form with the following values:
      +

      Variable name: MSVC16_ROOT
      Variable value: C:\MSVC15

      +
    12. +
    13. + Close the windows by clicking on "OK" +
    14. +
    +
  8. +
+

+
+
+ +
+ Installation of the Windows SDK 7.1 + Installation of the Windows SDK 7.1 +
+

+ The installer requires .Net Framework 4 (Not a newer one like .Net Framework 4.8!). Since a newer version is already preinstalled with Windows 10, the installer has to be tricked: +

    +
  1. + Click on the start button and search for: "regedit.msc". Start the first finding. +
  2. +
  3. + Navigate to "HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\NET Framework Setup\NDP\v4\" +
  4. +
  5. + Change the permissions for the "Client" folder, so you can edit the keys:
    +
      +
    1. + Right click on the subfolder "Client" and select "Permissions..." +
    2. +
    3. + Click on "Advanced"
      + +
    4. +
    5. + Change the owner to your user and click on "Add"
      + +
    6. +
    7. + Set the principal to your user, select "Full Control" and click on "OK"
      + +
    8. +
    9. + Within the folder "Client" note down the value of the entry "Version" +
    10. +
    11. + Doubleclick on the entry "Version" and change the value to "4.0.30319"
      + +
    12. +
    +
  6. +
  7. + Change the permissions for the "Full" folder, so you can edit the keys:
    +
      +
    1. + Right click on the subfolder "Full" and select "Permissions..." +
    2. +
    3. + Click on "Advanced"
      + +
    4. +
    5. + Change the owner to your user and click on "Add"
      + +
    6. +
    7. + Set the principal to your user, select "Full Control" and click on "OK"
      + +
    8. +
    9. + Within the folder "Full" note down the value of the entry "Version" +
    10. +
    11. + Doubleclick on the entry "Version" and change the value to "4.0.30319"
      + +
    12. +
    +
  8. +
  9. + Download the Windows SDK 7.1 at:
    + https://www.microsoft.com/en-us/download/details.aspx?id=8279 +
  10. +
  11. + Run the downloaded file as administrator and install the application with default settings +
  12. +
  13. + After the installation, revert the changes done in the registry editor.
    + Note: The owner "TrustedInstaller" can be restored by searching for: "NT Service\TrustedInstaller" +
  14. +
+

+
+
+ +
+ Installation of the Windows Driver Kit 7.1 + Installation of the Windows Driver Kit 7.1 +
+

+

    +
  1. + Please download the ISO of the Windows Diver Kit 7.1 at:
    + https://www.microsoft.com/en-us/download/details.aspx?id=11800 +
  2. +
  3. + Mount the downloaded ISO file by doubleclicking it +
  4. +
  5. + Run the file "KitSetup.exe" as administrator. Within the installation select all features to be installed.
    + Note: It might be that during the installed you are requested to install the .NET Framework 3.5. In this case click on "Download and install this feature". +
  6. +
  7. + Install the Driver Kit to the default location +
  8. +
+

+
+
+ +
+ Installation of the Windows 8.1 SDK + Installation of the Windows 8.1 SDK +
+

+

    +
  1. + Please download the ISO of the Windows 8.1 SDK at:
    + https://developer.microsoft.com/de-de/windows/downloads/sdk-archive/ +
  2. +
  3. + Run the downloaded file as administrator and install the Windows 8.1 SDK with default settings +
  4. +
  5. + Create a system variable for the Windows 8.1 SDK
    +
      +
    1. + Open a file explorer +
    2. +
    3. + Within the left file tree, please make a right click on "This PC" and select "Properties"
      + +
    4. +
    5. + Within the right menu, please click on "Advanced system settings"
      + +
    6. +
    7. + Please click on "Environment Variables"
      + +
    8. +
    9. + Within the area of the system variables, please click on "New..."
      + +
    10. +
    11. + Fill out the form with the following values:
      +

      Variable name: WSDK81
      Variable value: C:\Program Files (x86)\Windows Kits\8.1\

      +
    12. +
    13. + Close the windows by clicking on "OK" +
    14. +
    +
  6. +
+

+
+
+ +
+ Installation of gzip + Installation of gzip +
+

+

    +
  1. + Please create the following folder:
    + C:\Program Files (x86)\gzip +
  2. +
  3. + Please download gzip version at:
    + https://sourceforge.net/projects/gnuwin32/files/gzip/1.3.12-1/gzip-1.3.12-1-bin.zip/download?use-mirror=netix&download= +
  4. +
  5. + Copy the content of the downloaded zip to “C:\Program Files (x86)\gzip” +
  6. +
  7. + Add gzip to the path Variable. This will make the command globally available on the command line.
    +
      +
    1. + Open a file explorer +
    2. +
    3. + Within the left file tree, please make a right click on "This PC" and select "Properties"
      + +
    4. +
    5. + Within the right menu, please click on "Advanced system settings"
      + +
    6. +
    7. + Please click on "Environment Variables"
      + +
    8. +
    9. + Within the area of the system variables, please select the "Path" variable and click on "Edit..."
      + +
    10. +
    11. + Click on "New" and add the following value:
      +

      C:\Program Files (x86)\gzip\bin

      +
    12. +
    13. + Close the windows by clicking on "OK" +
    14. +
    +
  8. +
  9. + To check if the configuration is working correctly, please open a command prompt and watch the output of the following command:
    +

    gzip


    + +
  10. +
+

+
+
+ +
+ Installation of upx + Installation of upx +
+

+

    +
  1. + Please create the following folder:
    + C:\Program Files (x86)\upx +
  2. +
  3. + Please download the latest upx-X-XX-win64.zip version at:
    + https://github.com/upx/upx/releases/tag/v3.96 +
  4. +
  5. + Copy the content of the downloaded zip to “C:\Program Files (x86)\upx” +
  6. +
  7. + Add gzip to the path Variable. This will make the command globally available on the command line.
    +
      +
    1. + Open a file explorer +
    2. +
    3. + Within the left file tree, please make a right click on "This PC" and select "Properties"
      + +
    4. +
    5. + Within the right menu, please click on "Advanced system settings"
      + +
    6. +
    7. + Please click on "Environment Variables"
      + +
    8. +
    9. + Within the area of the system variables, please select the "Path" variable and click on "Edit..."
      + +
    10. +
    11. + Click on "New" and add the following value:
      +

      C:\Program Files (x86)\upx

      +
    12. +
    13. + Close the windows by clicking on "OK" +
    14. +
    +
  8. +
  9. + To check if the configuration is working correctly, please open a command prompt and watch the output of the following command:
    +

    upx


    + +
  10. +
+

+
+
+ +
+ Installation of 7zip + Installation of 7zip +
+

+

    +
  1. + Please download the latest version of 7zip at:
    + https://www.7-zip.de/ +
  2. +
  3. + Run the downloaded file as administrator and install 7zip with default settings +
  4. +
+

+
+
+ +
+ Installation of Wix3 + Installation of Wix3 +
+

+

    +
  1. + Please download wix311.exe at:
    + https://github.com/wixtoolset/wix3/releases +
  2. +
  3. + Run the downloaded file as administrator and install 7zip with default settings +
  4. +
+

+
+
+ +
+ Installation of Microsoft Visual Studio 2019 + Installation of Microsoft Visual Studio 2019 +
+

+

    +
  1. + Visit the following Microsoft website and log in with a free Microsoft account:
    + https://my.visualstudio.com/Downloads?q=visual%20studio%202019%20Professional +
  2. +
  3. + Please download the latest (trial) version of “Visual Studio Professional 2019”
    + +
  4. +
  5. + Run the downloaded file as administrator and go through the wizard.
    + Select the following Workloads for installation:
    +
      +
    1. + Desktop development with C++ +
    2. +
    3. + .NET desktop development +
    4. +
    + Select the following individual components for installation: +
      +
    1. + .NET +
        +
      1. + .NET 6.0 Runtime +
      2. +
      3. + .NET Core 3.1 Runtime (LTS) +
      4. +
      5. + .NET Framework 4 targeting pack +
      6. +
      7. + .NET Framework 4.5 targeting pack +
      8. +
      9. + .NET Framework 4.5.1 targeting pack +
      10. +
      11. + .NET Framework 4.5.2 targeting pack +
      12. +
      13. + .NET Framework 4.6 targeting pack +
      14. +
      15. + .NET Framework 4.6.1 targeting pack +
      16. +
      17. + .NET Framework 4.7.2 targeting pack +
      18. +
      19. + .NET Framework 4.8 SDK +
      20. +
      21. + .NET Framework 4.8 targeting pack +
      22. +
      23. + .NET SDK +
      24. +
      25. + ML.NET Model Builder (Preview) +
      26. +
      +
    2. +
    3. + Cloud, database, and server +
        +
      1. + CLR data types for SQL Server +
      2. +
      3. + Connectivity and publishing tools +
      4. +
      +
    4. +
    5. + Code tools +
        +
      1. + NuGet package manager +
      2. +
      3. + Text Template Transformation +
      4. +
      +
    6. +
    7. + Compilers, build tools, and runtimes +
        +
      1. + .NET Compiler Platform SDK +
      2. +
      3. + C# and Visual Basic Roslyn compilers +
      4. +
      5. + C++ 2019 Redistributable Update +
      6. +
      7. + C++ CMake tools for Windows +
      8. +
      9. + C++/CLI support for v142 build tools (Latest) +
      10. +
      11. + MSBuild +
      12. +
      13. + MSVC v142 - VS 2019 C++ ARM64 build tools (Latest) +
      14. +
      15. + MSVC v142 - VS 2019 C++ ARM64 Spectre-mitigated libs (Latest) +
      16. +
      17. + MSVC v142 - VS 2019 C++ x64/x86 build tools (Latest) +
      18. +
      19. + MSVC v142 - VS 2019 C++ x64/x86 Spectre-mitigated libs (Latest) +
      20. +
      +
    8. +
    9. + Debugging and testing +
        +
      1. + .NET profiling tools +
      2. +
      3. + C++ AddressSanatizer +
      4. +
      5. + C++ profiling tools +
      6. +
      7. + Just-In-Time debugger +
      8. +
      9. + Test Adapter for Boost.Test +
      10. +
      11. + Test Adapter for Google Test +
      12. +
      +
    10. +
    11. + Development activities +
        +
      1. + C# and Visual Basic +
      2. +
      3. + C++ core features +
      4. +
      5. + F# language support +
      6. +
      7. + IntelliCode +
      8. +
      9. + JavaScript and TypeScript language support +
      10. +
      11. + Live Share +
      12. +
      +
    12. +
    13. + Emulators +
        + NONE +
      +
    14. +
    15. + Games and Graphics +
        +
      1. + Graphics debugger and GPU profiler for DirectX +
      2. +
      +
    16. +
    17. + SDKs, libraries, and frameworks +
        +
      1. + C++ ATL for latest v142 build tools (ARM64) +
      2. +
      3. + C++ ATL for latest v142 build tools (x86 & x64) +
      4. +
      5. + C++ ATL for latest v142 build tools with Spectre Mitigations (ARM64) +
      6. +
      7. + C++ ATL for latest v142 build tools with Spectre Mitigations (x86 & x64) +
      8. +
      9. + C++ MFC for latest v142 build tools (ARM64) +
      10. +
      11. + C++ MFC for latest v142 build tools (x86 & x64) +
      12. +
      13. + C++ MFC for latest v142 build tools with Spectre Mitigations (ARM64) +
      14. +
      15. + C++ MFC for latest v142 build tools with Spectre Mitigations (x86 & x64) +
      16. +
      17. + Entity Framework 6 tools +
      18. +
      19. + TypeScript 4.3 SDK +
      20. +
      21. + Windows 10 SDK (10.0.19041.0) +
      22. +
      23. + Windows Universal C Runtime +
      24. +
      +
    18. +
    +
  6. +
+

+
+
+ +
+ Installation of the Windows Driver Kit 2004 + Installation of the Windows Driver Kit 2004 +
+

+

    +
  1. + Please download the Windows Driver Kit (WDK) 2004 at:
    + https://docs.microsoft.com/en-us/windows-hardware/drivers/other-wdk-downloads +
  2. +
  3. + Run the downloaded file as administrator and install the WDK with default settings +
  4. +
  5. + At the end of the installation you will be asked, if you want to "install Windows Driver Kit Visual Studio extension".
    + Please make sure, that this option is selected before closing the dialog. +
  6. +
  7. + A different setup will start automatically and will detect Visual Studio Professional 2019 as possible tarket for the extension.
    + Please select it and proceed with the installation. +
  8. +
+

+
+
+ +
+ Installation of the Visual Studio build tools + Installation of the Visual Studio build tools +
+

+

    +
  1. + Visit the following Microsoft website and log in with a free Microsoft account:
    + https://my.visualstudio.com/Downloads?q=visual%20studio%202019%20build%20tools +
  2. +
  3. + Please download the latest version of “Build Tools for Visual Studio 2019”
    + +
  4. +
  5. + Run the downloaded file as administrator and go through the wizard. Select the following individual components for installation: +
      +
    1. + .NET +
        + NONE +
      +
    2. +
    3. + Cloud, database, and server +
        + NONE +
      +
    4. +
    5. + Code tools +
        + NONE +
      +
    6. +
    7. + Compilers, build tools, and runtimes +
        +
      1. + C++/CLI support for v142 build tools (Latest) +
      2. +
      3. + MSVC v142 - VS 2019 C++ ARM64 build tools (Latest) +
      4. +
      5. + MSVC v142 - VS 2019 C++ ARM64 Spectre-mitigated libs (Latest) +
      6. +
      7. + MSVC v142 - VS 2019 C++ x64/x86 build tools (Latest) +
      8. +
      9. + MSVC v142 - VS 2019 C++ x64/x86 Spectre-mitigated libs (Latest) +
      10. +
      +
    8. +
    9. + Debugging and testing +
        + NONE +
      +
    10. +
    11. + Development activities +
        + NONE +
      +
    12. +
    13. + SDKs, libraries, and frameworks +
        +
      1. + C++ ATL for latest v142 build tools (ARM64) +
      2. +
      3. + C++ ATL for latest v142 build tools (x86 & x64) +
      4. +
      5. + C++ ATL for latest v142 build tools with Spectre Mitigations (ARM64) +
      6. +
      7. + C++ ATL for latest v142 build tools with Spectre Mitigations (x86 & x64) +
      8. +
      +
    14. +
    +
  6. +
+

+
+
+ +
+ Download VeraCrypt Source Files + Download VeraCrypt Source Files +
+

+

    +
  1. + Visit the VeraCrypt Github repository at:
    + https://github.com/veracrypt/VeraCrypt +
  2. +
  3. + Please click on the green button with the label "Code" and download the code.
    + You can download the repository as zip file, but you may consider to use the git protocol in order to track changes. +
  4. +
+

+
+
+ +
+ Compile the Win32/x64 Versions of VeraCrypt + Compile the Win32/x64 Versions of VeraCrypt +
+

+

    +
  1. + Please open the file "src/VeraCrypt.sln" in Visual Studio 2010 +
  2. +
  3. + Please select "All|Win32" as active configuration
    + +
  4. +
  5. + Please click on "Build -> Build Solution"
    + +
  6. +
  7. + The compiling process should end with warnings, but without errors. Some projects should be skipped. +
  8. +
  9. + Please select "All|x64" as active configuration
    + +
  10. +
  11. + Please click on "Build -> Build Solution"
    + +
  12. +
  13. + The compiling process should end with warnings, but without errors. Some projects should be skipped.
    + Please close Visual Studio 2010 after the compiling process finished +
  14. +
+

+
+
+ +
+ Compile the ARM64 Version of VeraCrypt + Compile the ARM64 Version of VeraCrypt +
+

+

    +
  1. + Please open the file "src/VeraCrypt_vs2019.sln" in Visual Studio 2019 +
  2. +
  3. + Please select "All|ARM64" as active configuration
    + +
  4. +
  5. + Please click on "Build -> Build Solution"
    + +
  6. +
  7. + The compiling process should end with warnings, but without errors. One project should be skipped.
    + Please close Visual Studio 2019 after the compiling process finished +
  8. +
+

+
+
+ +
+ Build the VeraCrypt Executables + Build the VeraCrypt Executables +
+

+

    +
  1. + Please open a command line as administrator +
  2. +
  3. + Go into the folder "src/Signing/" +
  4. +
  5. + Run the script "sign_test.bat" +
  6. +
  7. + You will find the generated exectuables within the folder "src/Release/Setup Files" +
  8. +
+

+
+
+ +
+ Import the Certificates + Import the Certificates +
+

With the sign_test.bat script you just signed the VeraCrypt executables. This is necessary, since Windows only accepts drivers, which are trusted by a signed Certificate Authority.
+ Since you did not use the official VeraCrypt signing certificate to sign your code, but a public development version, you have to import and therefore trust the certifcates used. +

    +
  1. + Open the folder "src/Signing" +
  2. +
  3. + Import the following certificates to your Local Machine Certificate storage, by double clicking them: +
      +
    • GlobalSign_R3Cross.cer
    • +
    • GlobalSign_SHA256_EV_CodeSigning_CA.cer
    • +
    • TestCertificates/idrix_codeSign.pfx
    • +
    • TestCertificates/idrix_Sha256CodeSign.pfx
    • +
    • TestCertificates/idrix_SHA256TestRootCA.crt
    • +
    • TestCertificates/idrix_TestRootCA.crt
    • +
    +
  4. +
+

+
+
+ +
+ Known Issues + Known Issues +
+

+

    +
  • + This distribution package is damaged
    +
    + On Windows 10 or higher you might get the error message above. It occurs, if the authenticode signature check fails.
    + Currently this check works incorrectly, so it might fail every time. A workaround is to skip the verification.
    + Please see https://sourceforge.net/p/veracrypt/discussion/technical/thread/83d5a2d6e8/ for further details. +
      +
    1. + Open the file "src/Common/Dlgcode.c" +
    2. +
    3. + Look for the function "VerifyModuleSignature" +
    4. +
    5. + Replace the following lines:
      + Find:
      +

      + if (!IsOSAtLeast (WIN_10))
      + return TRUE; +


      + Replace:
      +

      + return TRUE; +

      +
    6. +
    7. + Compile the VeraCrypt code again +
    8. +
    +
  • +
  • + Certificate failure
    +
    + Windows validates the signature for every driver which is going to be installed.
    + This validation can fail during the installation process of VeraCrypt for two reasons: +
      +
    1. + The certificate used for signing is not trusted by Windows
      + You can verify if you are affected by checking the properties of the executable: +
        +
      1. + Make a right click on the VeraCrypt Setup executable: "src/Release/Setup Files/VeraCrypt Setup 1.XX.exe" +
      2. +
      3. + Click on properties +
      4. +
      5. + Go to the top menu "Digital Signatures". Her you will find two signatures in the Signature list +
      6. + Check both by double clicking on it. If the headline says "The certificate in the signature cannot be verified", the corresponding signing certificate was not imported correctly.
        + Click on "View Certificate" and then on "Install Certificate..." to import the certificate to your certificate storage
        +
        +
      7. +
      +
    2. +
    3. + The driver was modified after the signing process.
      + In this case, please use the script "src/Signing/sign_test.bat" to sign your code again with the test certificates +
    4. +
    +
  • +
+

+
+
+ +
+ diff --git a/doc/html/CompilingGuidelineWin/AddNewSystemVar.jpg b/doc/html/CompilingGuidelineWin/AddNewSystemVar.jpg new file mode 100644 index 00000000..8e4bded1 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/AddNewSystemVar.jpg differ diff --git a/doc/html/CompilingGuidelineWin/CertVerifyFails.jpg b/doc/html/CompilingGuidelineWin/CertVerifyFails.jpg new file mode 100644 index 00000000..c7166ffa Binary files /dev/null and b/doc/html/CompilingGuidelineWin/CertVerifyFails.jpg differ diff --git a/doc/html/CompilingGuidelineWin/CertificateCannotBeVerified.jpg b/doc/html/CompilingGuidelineWin/CertificateCannotBeVerified.jpg new file mode 100644 index 00000000..f5dc2f21 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/CertificateCannotBeVerified.jpg differ diff --git a/doc/html/CompilingGuidelineWin/DistributionPackageDamaged.jpg b/doc/html/CompilingGuidelineWin/DistributionPackageDamaged.jpg new file mode 100644 index 00000000..e04f07c7 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/DistributionPackageDamaged.jpg differ diff --git a/doc/html/CompilingGuidelineWin/DownloadVS2010.jpg b/doc/html/CompilingGuidelineWin/DownloadVS2010.jpg new file mode 100644 index 00000000..1e4ba165 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/DownloadVS2010.jpg differ diff --git a/doc/html/CompilingGuidelineWin/DownloadVS2019.jpg b/doc/html/CompilingGuidelineWin/DownloadVS2019.jpg new file mode 100644 index 00000000..98428292 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/DownloadVS2019.jpg differ diff --git a/doc/html/CompilingGuidelineWin/DownloadVSBuildTools.jpg b/doc/html/CompilingGuidelineWin/DownloadVSBuildTools.jpg new file mode 100644 index 00000000..37217733 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/DownloadVSBuildTools.jpg differ diff --git a/doc/html/CompilingGuidelineWin/NasmCommandLine.jpg b/doc/html/CompilingGuidelineWin/NasmCommandLine.jpg new file mode 100644 index 00000000..d3a2f2f3 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/NasmCommandLine.jpg differ diff --git a/doc/html/CompilingGuidelineWin/RegeditPermissions-1.jpg b/doc/html/CompilingGuidelineWin/RegeditPermissions-1.jpg new file mode 100644 index 00000000..46fcabbc Binary files /dev/null and b/doc/html/CompilingGuidelineWin/RegeditPermissions-1.jpg differ diff --git a/doc/html/CompilingGuidelineWin/RegeditPermissions-2.jpg b/doc/html/CompilingGuidelineWin/RegeditPermissions-2.jpg new file mode 100644 index 00000000..5e3432cc Binary files /dev/null and b/doc/html/CompilingGuidelineWin/RegeditPermissions-2.jpg differ diff --git a/doc/html/CompilingGuidelineWin/RegeditPermissions-3.jpg b/doc/html/CompilingGuidelineWin/RegeditPermissions-3.jpg new file mode 100644 index 00000000..7aa66aa0 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/RegeditPermissions-3.jpg differ diff --git a/doc/html/CompilingGuidelineWin/RegeditPermissions-4.jpg b/doc/html/CompilingGuidelineWin/RegeditPermissions-4.jpg new file mode 100644 index 00000000..aa9f1c7b Binary files /dev/null and b/doc/html/CompilingGuidelineWin/RegeditPermissions-4.jpg differ diff --git a/doc/html/CompilingGuidelineWin/SelectAdvancedSystemSettings.jpg b/doc/html/CompilingGuidelineWin/SelectAdvancedSystemSettings.jpg new file mode 100644 index 00000000..753840d5 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/SelectAdvancedSystemSettings.jpg differ diff --git a/doc/html/CompilingGuidelineWin/SelectEnvironmentVariables.jpg b/doc/html/CompilingGuidelineWin/SelectEnvironmentVariables.jpg new file mode 100644 index 00000000..709589ba Binary files /dev/null and b/doc/html/CompilingGuidelineWin/SelectEnvironmentVariables.jpg differ diff --git a/doc/html/CompilingGuidelineWin/SelectPathVariable.jpg b/doc/html/CompilingGuidelineWin/SelectPathVariable.jpg new file mode 100644 index 00000000..ef5aa44d Binary files /dev/null and b/doc/html/CompilingGuidelineWin/SelectPathVariable.jpg differ diff --git a/doc/html/CompilingGuidelineWin/SelectThisPC.jpg b/doc/html/CompilingGuidelineWin/SelectThisPC.jpg new file mode 100644 index 00000000..439182d7 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/SelectThisPC.jpg differ diff --git a/doc/html/CompilingGuidelineWin/VS2010BuildSolution.jpg b/doc/html/CompilingGuidelineWin/VS2010BuildSolution.jpg new file mode 100644 index 00000000..7870cb51 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/VS2010BuildSolution.jpg differ diff --git a/doc/html/CompilingGuidelineWin/VS2010Win32Config.jpg b/doc/html/CompilingGuidelineWin/VS2010Win32Config.jpg new file mode 100644 index 00000000..f0be29b0 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/VS2010Win32Config.jpg differ diff --git a/doc/html/CompilingGuidelineWin/VS2010X64Config.jpg b/doc/html/CompilingGuidelineWin/VS2010X64Config.jpg new file mode 100644 index 00000000..b8d989a2 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/VS2010X64Config.jpg differ diff --git a/doc/html/CompilingGuidelineWin/VS2019ARM64Config.jpg b/doc/html/CompilingGuidelineWin/VS2019ARM64Config.jpg new file mode 100644 index 00000000..825079da Binary files /dev/null and b/doc/html/CompilingGuidelineWin/VS2019ARM64Config.jpg differ diff --git a/doc/html/CompilingGuidelineWin/VS2019BuildSolution.jpg b/doc/html/CompilingGuidelineWin/VS2019BuildSolution.jpg new file mode 100644 index 00000000..015ab357 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/VS2019BuildSolution.jpg differ diff --git a/doc/html/CompilingGuidelineWin/YasmCommandLine.jpg b/doc/html/CompilingGuidelineWin/YasmCommandLine.jpg new file mode 100644 index 00000000..9b414160 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/YasmCommandLine.jpg differ diff --git a/doc/html/CompilingGuidelineWin/gzipCommandLine.jpg b/doc/html/CompilingGuidelineWin/gzipCommandLine.jpg new file mode 100644 index 00000000..958f3f6a Binary files /dev/null and b/doc/html/CompilingGuidelineWin/gzipCommandLine.jpg differ diff --git a/doc/html/CompilingGuidelineWin/upxCommandLine.jpg b/doc/html/CompilingGuidelineWin/upxCommandLine.jpg new file mode 100644 index 00000000..cb0af820 Binary files /dev/null and b/doc/html/CompilingGuidelineWin/upxCommandLine.jpg differ diff --git a/doc/html/Documentation.html b/doc/html/Documentation.html index f9315c22..0466abe4 100644 --- a/doc/html/Documentation.html +++ b/doc/html/Documentation.html @@ -1,5 +1,52 @@ + + + @@ -29,119 +76,335 @@

Table of Contents

This documentation is not guaranteed to be error-free and is provided "as is" without warranty of any kind. For more information, see Disclaimers.

- + + +Preface
+Introduction + +
+
+ ▶   End-User Guidelines and Information + ▼   End-User Guidelines and Information + +
+ +
+ + +
+
+ ▶   Technical Details + ▼   Technical Details +
+ +
+
+ +Troubleshooting
+Incompatibilities
+Known Issues and Limitations
+Frequently Asked Questions
+Contact
+Legal Information
+Version History
+Acknowledgements
+References
diff --git a/doc/html/LinuxPrepAndBuild.sh b/doc/html/LinuxPrepAndBuild.sh new file mode 100644 index 00000000..58329b8f --- /dev/null +++ b/doc/html/LinuxPrepAndBuild.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +sudo apt update +sudo apt install -y build-essential yasm pkg-config libgtk-3-dev +wget https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.0/wxWidgets-3.2.0.tar.bz2 +tar -xf wxWidgets-3.2.0.tar.bz2 +cd wxWidgets-3.2.0 +mkdir gtk-build +cd gtk-build +../configure +make +sudo make install +sudo ldconfig +cd ../.. +rm -r wxWidgets-3.2.0 +rm wxWidgets-3.2.0.tar.bz2 +sudo apt install -y libfuse-dev git +git clone https://github.com/veracrypt/VeraCrypt.git +cd ~/VeraCrypt/src +make diff --git a/doc/html/Miscellaneous.html b/doc/html/Miscellaneous.html deleted file mode 100644 index 95eb6af8..00000000 --- a/doc/html/Miscellaneous.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - -VeraCrypt - Free Open source disk encryption with strong security for the Paranoid - - - - - - -
-VeraCrypt -
- - - -
-

-Documentation ->> -Miscellaneous -

- - - -- cgit v1.2.3