"Fossies" - the Fresh Open Source Software Archive

Member "src/Readme.txt" (10 Oct 2018, 9911 Bytes) of package /windows/misc/VeraCrypt_1.23-Hotfix-2_Source.zip:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "Readme.txt": 1.21_Source_vs_1.22_Source.

    1 This archive contains the source code of VeraCrypt.
    2 It is based on original TrueCrypt 7.1a with security enhancements and modifications.
    3 
    4 
    5 Important
    6 =========
    7 
    8 You may use the source code contained in this archive only if you accept and
    9 agree to the license terms contained in the file 'License.txt', which is
   10 included in this archive.
   11 
   12 Note that the license specifies, for example, that a derived work must not be
   13 called 'TrueCrypt' or 'VeraCrypt'
   14 
   15 
   16 
   17 Contents
   18 ========
   19 
   20 I. Windows
   21    Requirements for Building VeraCrypt for Windows.
   22    Instructions for Building VeraCrypt for Windows.
   23 	Instructions for Signing and Packaging VeraCrypt for Windows.
   24 
   25 II. Linux and Mac OS X
   26     Requirements for Building VeraCrypt for Linux and Mac OS X.
   27     Instructions for Building VeraCrypt for Linux and Mac OS X.
   28 	Mac OS X specifics
   29 
   30 III. FreeBSD
   31 
   32 IV. Third-Party Developers (Contributors)
   33 
   34 V. Legal Information
   35 
   36 VI. Further Information
   37 
   38 
   39 
   40 I. Windows
   41 ==========
   42 
   43 Requirements for Building VeraCrypt for Windows:
   44 ------------------------------------------------
   45 
   46 - Microsoft Visual C++ 2010 SP1 (Professional Edition or compatible)
   47 - Microsoft Visual C++ 1.52 (available from MSDN Subscriber Downloads)
   48 - Microsoft Windows SDK for Windows 7.1 (configured for Visual C++ 2010)
   49 - Microsoft Windows SDK for Windows 8.1 (needed for SHA-256 code signing)
   50 - Microsoft Windows Driver Kit 7.1.0 (build 7600.16385.1)
   51 - NASM assembler 2.08 or compatible
   52 - YASM 1.3.0 or newer.
   53 - gzip compressor
   54 - upx packer (available at https://upx.github.io/)
   55 
   56 IMPORTANT:
   57 
   58 The 64-bit editions of Windows Vista and later versions of Windows, and in
   59 some cases (e.g. playback of HD DVD content) also the 32-bit editions, do not
   60 allow the VeraCrypt driver to run without an appropriate digital signature.
   61 Therefore, all .sys files in official VeraCrypt binary packages are digitally
   62 signed with the digital certificate of the IDRIX, which was
   63 issued by Thawte certification authority. At the end of each official .exe and
   64 .sys file, there are embedded digital signatures and all related certificates
   65 (i.e. all certificates in the relevant certification chain, such as the
   66 certification authority certificates, CA-MS cross-certificate, and the
   67 IDRIX certificate).
   68 Keep this in mind if you compile VeraCrypt
   69 and compare your binaries with the official binaries. If your binaries are
   70 unsigned, the sizes of the official binaries will usually be approximately
   71 10 KB greater than sizes of your binaries (there may be further differences
   72 if you use a different version of the compiler, or if you install a different
   73 or no service pack for Visual Studio, or different hotfixes for it, or if you
   74 use different versions of the required SDKs).
   75 
   76 
   77 Instructions for Building VeraCrypt for Windows:
   78 ------------------------------------------------
   79 
   80 1) Create an environment variable 'MSVC16_ROOT' pointing to the folder 'MSVC15'
   81    extracted from the Visual C++ 1.52 self-extracting package.
   82 
   83    Note: The 16-bit installer MSVC15\SETUP.EXE cannot be run on 64-bit Windows,
   84    but it is actually not necessary to run it. You only need to extract the
   85    folder 'MSVC15', which contains the 32-bit binaries required to build the
   86    VeraCrypt Boot Loader.
   87 
   88 2) If you have installed the Windows Driver Development Kit in another
   89    directory than '%SYSTEMDRIVE%\WinDDK', create an environment variable
   90    'WINDDK_ROOT' pointing to the DDK installation directory.
   91 
   92 3) Open the solution file 'VeraCrypt.sln' in Microsoft Visual Studio 2010.
   93 
   94 4) Select 'All' as the active solution configuration.
   95 
   96 5) Build the solution.
   97 
   98 6) If successful, there should be newly built VeraCrypt binaries in the
   99    'Release' folder.
  100 
  101 Instructions for Signing and Packaging VeraCrypt for Windows:
  102 -------------------------------------------------------------
  103 
  104 First, create an environment variable 'WSDK81' pointing to the Windows SDK
  105 for Windows 8.1 installation directory.
  106 The folder "Signing" contains a batch file (sign.bat) that will sign all
  107 VeraCrypt components using a code signing certificate present on the
  108 certificate store and also build the final installation setup.
  109 The batch file suppose that the code signing certificate is issued by Thawt.
  110 This is the case for IDRIX's certificate. If yours is issued by another CA,
  111 then you should put the Root and Intermediate certificates in the "Signing"
  112 folder and then modify sign.bat accordingly.
  113 
  114 VeraCrypt EFI Boot Loader:
  115 --------------------------
  116 
  117 VeraCrypt source code contains pre-built EFI binaries under src\Boot\EFI.
  118 The source code of VeraCrypt EFI Boot Loader is licensed under LGPL and 
  119 it is available at https://github.com/veracrypt/VeraCrypt-DCS.
  120 For build instructions, please refer to the file src\Boot\EFI\Readme.txt.
  121 
  122 
  123 II. Linux and Mac OS X
  124 ======================
  125 
  126 Requirements for Building VeraCrypt for Linux and Mac OS X:
  127 -----------------------------------------------------------
  128 
  129 - GNU Make
  130 - GNU C++ Compiler 4.0 or compatible
  131 - Apple Xcode (Mac OS X only)
  132 - YASM 1.3.0 or newer (Linux only, x86/x64 architecture only)
  133 - pkg-config
  134 - wxWidgets 3.0 shared library and header files installed or
  135   wxWidgets 3.0 library source code (available at https://www.wxwidgets.org)
  136 - FUSE library and header files (available at https://github.com/libfuse/libfuse
  137   and https://osxfuse.github.io/)
  138 
  139 
  140 Instructions for Building VeraCrypt for Linux and Mac OS X:
  141 -----------------------------------------------------------
  142 
  143 1) Change the current directory to the root of the VeraCrypt source code.
  144 
  145 2) If you have no wxWidgets shared library installed, run the following
  146    command to configure the wxWidgets static library for VeraCrypt and to
  147    build it:
  148 
  149    $ make WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild
  150 
  151    The variable WX_ROOT must point to the location of the source code of the
  152    wxWidgets library. Output files will be placed in the './wxrelease/'
  153    directory.
  154 
  155 3) To build VeraCrypt, run the following command:
  156 
  157    $ make
  158 
  159    or if you have no wxWidgets shared library installed:
  160 
  161    $ make WXSTATIC=1
  162 
  163 4) If successful, the VeraCrypt executable should be located in the directory
  164    'Main'.
  165 
  166 By default, a universal executable supporting both graphical and text user
  167 interface (through the switch --text) is built.
  168 On Linux, a console-only executable, which requires no GUI library, can be
  169 built using the 'NOGUI' parameter:
  170 
  171    $ make NOGUI=1 WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild
  172    $ make NOGUI=1 WXSTATIC=1
  173 
  174 On MacOSX, building a console-only executable is not supported.
  175 
  176 Mac OS X specifics:
  177 -----------------------------------------------------------
  178 
  179 Under MacOSX, the SDK for OSX 10.7 is used by default. To use another version
  180 of the SDK (i.e. 10.6), you can export the environment variable VC_OSX_TARGET:
  181 
  182 	$ export VC_OSX_TARGET=10.6
  183 
  184 
  185 Before building under MacOSX, pkg-config must be installed if not yet available.
  186 Get it from https://pkgconfig.freedesktop.org/releases/pkg-config-0.28.tar.gz and
  187 compile using the following commands :
  188 
  189 	$ ./configure --with-internal-glib
  190 	$ make
  191 	$ sudo make install
  192 
  193 After making sure pkg-config is available, download and install OSXFuse from
  194 https://osxfuse.github.io/ (MacFUSE compatibility layer must selected)
  195 
  196 The script build_veracrypt_macosx.sh available under "src/Build" performs the
  197 full build of VeraCrypt including the creation of the installer pkg. It expects
  198 to find the wxWidgets 3.0.3 sources at the same level as where you put
  199 VeraCrypt sources (i.e. if "src" path is "/Users/joe/Projects/VeraCrypt/src"
  200 then wxWidgets should be at "/Users/joe/Projects/wxWidgets-3.0.3")
  201 
  202 The build process uses Code Signing certificates whose ID is specified in
  203 src/Main/Main.make (look for lines containing "Developer ID Application" and 
  204 "Developer ID Installer"). You'll have to modify these lines to put the ID of
  205 your Code Signing certificates or comment them if you don't have one.
  206 
  207 Because of incompatibility issues with OSXFUSE, the SDK 10.9 generates a
  208 VeraCrypt binary that has issues communicating with the OSXFUSE kernel extension.
  209 Thus, we recommend using a different OSX SDK version for building VeraCrypt.
  210 
  211 
  212 
  213 III. FreeBSD
  214 ============================
  215 
  216 FreeBSD is supported starting from version 11.
  217 The build requirements and instructions are the same as Linux except that gmake
  218 should be used instead of make.
  219 
  220 
  221 
  222 IV. Third-Party Developers (Contributors)
  223 =========================================
  224 
  225 If you intend to implement a feature, please contact us first to make sure:
  226 
  227 1) That the feature has not been implemented (we may have already implemented
  228    it, but haven't released the code yet).
  229 2) That the feature is acceptable.
  230 3) Whether we need help of third-party developers with implementing the feature.
  231 
  232 Information on how to contact us can be found at:
  233 https://www.veracrypt.fr/
  234 
  235 
  236 
  237 V. Legal Information
  238 ====================
  239 
  240 Copyright Information
  241 ---------------------
  242 
  243 This software as a whole:  
  244 Copyright (c) 2013-2018 IDRIX. All rights reserved.
  245 
  246 Portions of this software:  
  247 Copyright (c) 2013-2018 IDRIX. All rights reserved.  
  248 Copyright (c) 2003-2012 TrueCrypt Developers Association. All rights reserved.  
  249 Copyright (c) 1998-2000 Paul Le Roux. All rights reserved.  
  250 Copyright (c) 1998-2008 Brian Gladman, Worcester, UK. All rights reserved.  
  251 Copyright (c) 1995-2017 Jean-loup Gailly and Mark Adler.  
  252 Copyright (c) 2016 Disk Cryptography Services for EFI (DCS), Alex Kolotnikov  
  253 Copyright (c) 1999-2017 Dieter Baron and Thomas Klausner.  
  254 Copyright (c) 2013, Alexey Degtyarev. All rights reserved.  
  255 Copyright (c) 1999-2016 Jack Lloyd. All rights reserved.  
  256 
  257 For more information, please see the legal notices attached to parts of the
  258 source code.
  259 
  260 Trademark Information
  261 ---------------------
  262 
  263 Any trademarks contained in the source code, binaries, and/or in the
  264 documentation, are the sole property of their respective owners.
  265 
  266 
  267 
  268 VI. Further Information
  269 =======================
  270 
  271 https://www.veracrypt.fr