VeraCrypt
aboutsummaryrefslogtreecommitdiff
path: root/src/Readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/Readme.txt')
-rw-r--r--src/Readme.txt111
1 files changed, 43 insertions, 68 deletions
diff --git a/src/Readme.txt b/src/Readme.txt
index 0a99475d..be740b73 100644
--- a/src/Readme.txt
+++ b/src/Readme.txt
@@ -18,8 +18,6 @@ Contents
========
I. Windows
- Requirements for Building VeraCrypt for Windows.
- Instructions for Building VeraCrypt for Windows.
Instructions for Signing and Packaging VeraCrypt for Windows.
II. Linux and Mac OS X
@@ -43,15 +41,9 @@ I. Windows
Requirements for Building VeraCrypt for Windows:
------------------------------------------------
-- Microsoft Visual C++ 2010 SP1 (Professional Edition or compatible)
-- Microsoft Visual C++ 1.52 (available from MSDN Subscriber Downloads)
-- Microsoft Windows SDK for Windows 7.1 (configured for Visual C++ 2010)
-- Microsoft Windows SDK for Windows 8.1 (needed for SHA-256 code signing)
-- Microsoft Windows Driver Kit 7.1.0 (build 7600.16385.1)
-- NASM assembler 2.08 or compatible
-- YASM 1.3.0 or newer.
-- gzip compressor
-- upx packer (available at https://upx.github.io/)
+A detailed guide on how to build VeraCrypt on Windows can be found in
+the file doc/html/CompilingGuidelineWin.html. it is also available online
+at https://www.veracrypt.fr/en/CompilingGuidelineWin.html
IMPORTANT:
@@ -59,44 +51,19 @@ The 64-bit editions of Windows Vista and later versions of Windows, and in
some cases (e.g. playback of HD DVD content) also the 32-bit editions, do not
allow the VeraCrypt driver to run without an appropriate digital signature.
Therefore, all .sys files in official VeraCrypt binary packages are digitally
-signed with the digital certificate of the IDRIX, which was
-issued by Thawte certification authority. At the end of each official .exe and
+signed with the digital certificate of the IDRIX, which was issued by
+GlobalSign certification authority. At the end of each official .exe and
.sys file, there are embedded digital signatures and all related certificates
(i.e. all certificates in the relevant certification chain, such as the
certification authority certificates, CA-MS cross-certificate, and the
IDRIX certificate).
-Keep this in mind if you compile VeraCrypt
-and compare your binaries with the official binaries. If your binaries are
-unsigned, the sizes of the official binaries will usually be approximately
-10 KiB greater than sizes of your binaries (there may be further differences
-if you use a different version of the compiler, or if you install a different
-or no service pack for Visual Studio, or different hotfixes for it, or if you
-use different versions of the required SDKs).
-
-
-Instructions for Building VeraCrypt for Windows:
-------------------------------------------------
-
-1) Create an environment variable 'MSVC16_ROOT' pointing to the folder 'MSVC15'
- extracted from the Visual C++ 1.52 self-extracting package.
-
- Note: The 16-bit installer MSVC15\SETUP.EXE cannot be run on 64-bit Windows,
- but it is actually not necessary to run it. You only need to extract the
- folder 'MSVC15', which contains the 32-bit binaries required to build the
- VeraCrypt Boot Loader.
-
-2) If you have installed the Windows Driver Development Kit in another
- directory than '%SYSTEMDRIVE%\WinDDK', create an environment variable
- 'WINDDK_ROOT' pointing to the DDK installation directory.
-
-3) Open the solution file 'VeraCrypt.sln' in Microsoft Visual Studio 2010.
-
-4) Select 'All' as the active solution configuration.
-
-5) Build the solution.
-
-6) If successful, there should be newly built VeraCrypt binaries in the
- 'Release' folder.
+Keep this in mind if you compile VeraCrypt and compare your binaries with the
+official binaries. If your binaries are unsigned, the sizes of the official
+binaries will usually be approximately 10 KiB greater than sizes of your
+binaries (there may be further differences if you use a different version of
+the compiler, or if you install a different or no service pack for Visual
+Studio, or different hotfixes for it, or if you use different versions of
+the required SDKs).
Instructions for Signing and Packaging VeraCrypt for Windows:
-------------------------------------------------------------
@@ -105,17 +72,19 @@ First, create an environment variable 'WSDK81' pointing to the Windows SDK
for Windows 8.1 installation directory.
The folder "Signing" contains a batch file (sign.bat) that will sign all
VeraCrypt components using a code signing certificate present on the
-certificate store and also build the final installation setup.
-The batch file suppose that the code signing certificate is issued by Thawt.
-This is the case for IDRIX's certificate. If yours is issued by another CA,
-then you should put the Root and Intermediate certificates in the "Signing"
-folder and then modify sign.bat accordingly.
+certificate store and also build the final installation setup and MSI package.
+The batch file suppose that the code signing certificate is issued by
+GlobalSign. This is the case for IDRIX's certificate. If yours is issued by
+another CA, then you should put its intermediate certificates in the "Signing"
+folder and modify sign.bat accordingly.
+
+In order to generate MSI packages, WiX Toolset v3.11 must be installed.
VeraCrypt EFI Boot Loader:
--------------------------
VeraCrypt source code contains pre-built EFI binaries under src\Boot\EFI.
-The source code of VeraCrypt EFI Boot Loader is licensed under LGPL and
+The source code of VeraCrypt EFI Boot Loader is licensed under LGPL and
it is available at https://github.com/veracrypt/VeraCrypt-DCS.
For build instructions, please refer to the file src\Boot\EFI\Readme.txt.
@@ -123,6 +92,10 @@ For build instructions, please refer to the file src\Boot\EFI\Readme.txt.
II. Linux and Mac OS X
======================
+A detailed guide on how to build VeraCrypt on Linux can be found in
+the file doc/html/CompilingGuidelineLinux.html. it is also available online
+at https://www.veracrypt.fr/en/CompilingGuidelineLinux.html
+
Requirements for Building VeraCrypt for Linux and Mac OS X:
-----------------------------------------------------------
@@ -135,6 +108,7 @@ Requirements for Building VeraCrypt for Linux and Mac OS X:
wxWidgets 3.0 library source code (available at https://www.wxwidgets.org)
- FUSE library and header files (available at https://github.com/libfuse/libfuse
and https://osxfuse.github.io/)
+- PCSC-lite library and header files (available at https://github.com/LudovicRousseau/PCSC)
Instructions for Building VeraCrypt for Linux and Mac OS X:
@@ -146,7 +120,7 @@ Instructions for Building VeraCrypt for Linux and Mac OS X:
command to configure the wxWidgets static library for VeraCrypt and to
build it:
- $ make WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild
+ $ make WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild
The variable WX_ROOT must point to the location of the source code of the
wxWidgets library. Output files will be placed in the './wxrelease/'
@@ -154,11 +128,11 @@ Instructions for Building VeraCrypt for Linux and Mac OS X:
3) To build VeraCrypt, run the following command:
- $ make
+ $ make
or if you have no wxWidgets shared library installed:
- $ make WXSTATIC=1
+ $ make WXSTATIC=1
4) If successful, the VeraCrypt executable should be located in the directory
'Main'.
@@ -168,18 +142,18 @@ 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
+ $ make NOGUI=1 WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild
+ $ make NOGUI=1 WXSTATIC=1
On MacOSX, building a console-only executable is not supported.
Mac OS X specifics:
-----------------------------------------------------------
-Under MacOSX, the SDK for OSX 10.7 is used by default. To use another version
-of the SDK (i.e. 10.6), you can export the environment variable VC_OSX_TARGET:
+Under MacOSX, the SDK for OSX 11.3 is used by default. To use another version
+of the SDK (i.e. 10.15), you can export the environment variable VC_OSX_TARGET:
- $ export VC_OSX_TARGET=10.6
+ $ export VC_OSX_TARGET=10.15
Before building under MacOSX, pkg-config must be installed if not yet available.
@@ -191,16 +165,16 @@ compile using the following commands :
$ sudo make install
After making sure pkg-config is available, download and install OSXFuse from
-https://osxfuse.github.io/ (MacFUSE compatibility layer must selected)
+https://osxfuse.github.io/
The script build_veracrypt_macosx.sh available under "src/Build" performs the
full build of VeraCrypt including the creation of the installer pkg. It expects
-to find the wxWidgets 3.0.3 sources at the same level as where you put
+to find the wxWidgets 3.1.2 sources at the same level as where you put
VeraCrypt sources (i.e. if "src" path is "/Users/joe/Projects/VeraCrypt/src"
-then wxWidgets should be at "/Users/joe/Projects/wxWidgets-3.0.3")
+then wxWidgets should be at "/Users/joe/Projects/wxWidgets-3.1.2")
The build process uses Code Signing certificates whose ID is specified in
-src/Main/Main.make (look for lines containing "Developer ID Application" and
+src/Main/Main.make (look for lines containing "Developer ID Application" and
"Developer ID Installer"). You'll have to modify these lines to put the ID of
your Code Signing certificates or comment them if you don't have one.
@@ -241,19 +215,20 @@ Copyright Information
---------------------
This software as a whole:
-Copyright (c) 2013-2019 IDRIX. All rights reserved.
+Copyright (c) 2013-2023 IDRIX. All rights reserved.
Portions of this software:
-Copyright (c) 2013-2019 IDRIX. All rights reserved.
+Copyright (c) 2013-2023 IDRIX. All rights reserved.
Copyright (c) 2003-2012 TrueCrypt Developers Association. All rights reserved.
Copyright (c) 1998-2000 Paul Le Roux. All rights reserved.
Copyright (c) 1998-2008 Brian Gladman, Worcester, UK. All rights reserved.
-Copyright (c) 1995-2017 Jean-loup Gailly and Mark Adler.
+Copyright (c) 1995-2023 Jean-loup Gailly and Mark Adler.
Copyright (c) 2016 Disk Cryptography Services for EFI (DCS), Alex Kolotnikov
-Copyright (c) 1999-2017 Dieter Baron and Thomas Klausner.
+Copyright (c) 1999-2023 Dieter Baron and Thomas Klausner.
Copyright (c) 2013, Alexey Degtyarev. All rights reserved.
Copyright (c) 1999-2016 Jack Lloyd. All rights reserved.
-Copyright (c) 2013-2018 Stephan Mueller <smueller@chronox.de>
+Copyright (c) 2013-2019 Stephan Mueller <smueller@chronox.de>
+Copyright (c) 1999-2023 Igor Pavlov
For more information, please see the legal notices attached to parts of the
source code.