diff --git a/README.md b/README.md index 771be85b..c25f4fa4 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ called 'TrueCrypt' or 'VeraCrypt' A detailed guide on how to build VeraCrypt on Windows can be found in the [documentation](./doc/html/CompilingGuidelineWin.html) in the repository and -it is also available [online](https://veracrypt.jp/en/CompilingGuidelineWin.html). +it is also available [online](https://veracrypt.jp/en/CompilingGuidelineWin.html) or on the [mirror](https://veracrypt.io/en/CompilingGuidelineWin.html). IMPORTANT: @@ -79,7 +79,7 @@ For build instructions, please refer to the file src\Boot\EFI\Readme.txt. A detailed guide on how to build VeraCrypt on Linux can be found in the [documentation](./doc/html/CompilingGuidelineLinux.html) in the repository and -it is also available [online](https://veracrypt.jp/en/CompilingGuidelineLinux.html). +it is also available [online](https://veracrypt.jp/en/CompilingGuidelineLinux.html) or on the [mirror](https://veracrypt.io/en/CompilingGuidelineLinux.html). ## Requirements for Building VeraCrypt for Linux and Mac OS X: @@ -201,6 +201,7 @@ If you intend to implement a feature, please contact us first to make sure: Information on how to contact us can be found at: https://veracrypt.jp/ +https://veracrypt.io/ (mirror) # V. Legal Information @@ -234,3 +235,4 @@ documentation, are the sole property of their respective owners. # VI. Further Information https://veracrypt.jp +https://veracrypt.io (mirror) diff --git a/src/Readme.txt b/src/Readme.txt index 5d716d8e..d0571c0d 100644 --- a/src/Readme.txt +++ b/src/Readme.txt @@ -1,5 +1,5 @@ This archive contains the source code of VeraCrypt. -It is based on original TrueCrypt 7.1a with security enhancements and modifications. +It is based on the original TrueCrypt 7.1a with security enhancements and modifications. Important @@ -13,17 +13,12 @@ Note that the license specifies, for example, that a derived work must not be called 'TrueCrypt' or 'VeraCrypt' - Contents ======== I. Windows - Instructions for Signing and Packaging VeraCrypt for Windows. II. Linux and Mac OS X - Requirements for Building VeraCrypt for Linux and Mac OS X. - Instructions for Building VeraCrypt for Linux and Mac OS X. - Mac OS X specifics III. FreeBSD @@ -42,13 +37,15 @@ Requirements for Building VeraCrypt for Windows: ------------------------------------------------ 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://veracrypt.jp/en/CompilingGuidelineWin.html +the file doc/html/CompilingGuidelineWin.html in the repository. It is also available online at: +https://veracrypt.jp/en/CompilingGuidelineWin.html +or on the mirror: +https://veracrypt.io/en/CompilingGuidelineWin.html IMPORTANT: 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 +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 @@ -57,28 +54,30 @@ GlobalSign certification authority. At the end of each official .exe and (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 will usually be approximately 10 KiB greater than the 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: -------------------------------------------------------------- +------------------------------------------------------------ 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 and MSI package. -The batch file suppose that the code signing certificate is issued by +certificate store and build the final installation setup and MSI package. +The batch file assumes 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. +To generate MSI packages, WiX Toolset v3.11 must be installed. VeraCrypt EFI Boot Loader: -------------------------- @@ -93,8 +92,10 @@ 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://veracrypt.jp/en/CompilingGuidelineLinux.html +the file doc/html/CompilingGuidelineLinux.html in the repository. It is also available online at: +https://veracrypt.jp/en/CompilingGuidelineLinux.html +or on the mirror: +https://veracrypt.io/en/CompilingGuidelineLinux.html Requirements for Building VeraCrypt for Linux and Mac OS X: ----------------------------------------------------------- @@ -148,36 +149,36 @@ built using the 'NOGUI' parameter: On MacOSX, building a console-only executable is not supported. Mac OS X specifics: ------------------------------------------------------------ +------------------- Under MacOSX, the latest installed SDK is used by default. To use a different version of the SDK when building using make, you can export the environment variable VC_OSX_SDK: - $ export VC_OSX_SDK=13.0 + $ export VC_OSX_SDK=13.0 For development dependencies management, you can use homebrew (https://brew.sh). - $ brew install pkg-config yasm wxwidgets + $ brew install pkg-config yasm wxwidgets You also need system dependencies - $ brew install --cask macfuse packages + $ brew install --cask macfuse packages -After installating dependencies via brew, you can build a local development build +After installing dependencies via brew, you can build a local development build - $ ./src/Build/build_veracrypt_macosx.sh -b + $ ./src/Build/build_veracrypt_macosx.sh -b -If you want to build the package, you also need to pass `-p` to the build script above. The built -executable will be in `.src/Main` +If you want to build the package, you must pass `-p` to the build script above. The built +executable will be in .src/Main If you prefer to build from sources, or without homebrew, pkg-config and packages must be installed. Get pkg-config from https://pkgconfig.freedesktop.org/releases/pkg-config-0.29.2.tar.gz and -compile using the following commands : +compile using the following commands: - $ CFLAGS="-Wno-int-conversion" CXXFLAGS="-Wno-int-conversion" ./configure --with-internal-glib - $ make - $ sudo make install + $ CFLAGS="-Wno-int-conversion" CXXFLAGS="-Wno-int-conversion" ./configure --with-internal-glib + $ make + $ sudo make install After making sure pkg-config is available, download and install OSXFuse from https://osxfuse.github.io/ @@ -191,18 +192,17 @@ then wxWidgets should be at "/Users/joe/Projects/wxWidgets-3.2.5") The make build process uses Code Signing certificates whose ID is specified in 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. +your Code Signing certificates or comment them out if you don't have one. Because of incompatibility issues with OSXFUSE, the SDK 10.9 generates a VeraCrypt binary that has issues communicating with the OSXFUSE kernel extension. Thus, we recommend using a different OSX SDK version for building VeraCrypt. -To build the installation package, you will need Packages (http://s.sudre.free.fr/Software/Packages/about.html). -The Packages installer that is used for VeraCrypt official build has been notarized by IDRIX and it is available at +The Packages installer that is used for the VeraCrypt official build has been notarized by IDRIX and it is available at https://github.com/idrassi/packages/releases III. FreeBSD -============================ +============ FreeBSD is supported starting from version 11. The build requirements and instructions are the same as Linux except that gmake @@ -218,10 +218,11 @@ If you intend to implement a feature, please contact us first to make sure: 1) That the feature has not been implemented (we may have already implemented it, but haven't released the code yet). 2) That the feature is acceptable. -3) Whether we need help of third-party developers with implementing the feature. +3) Whether we need the help of third-party developers with implementing the feature. Information on how to contact us can be found at: https://veracrypt.jp/ +https://veracrypt.io/ (mirror) @@ -263,3 +264,4 @@ VI. Further Information ======================= https://veracrypt.jp +https://veracrypt.io (mirror)