docs/BUILD.md

   1 oclHashcat build documentation
   2 =
   3 # Revision:
   4 * 1.1
   5
   6 # Authors:
   7 * Gabriele Gristina <<matrix@hashcat.net>>
   8 * Christoph Heuwieser <<dropdead@hashcat.net>>
   9
  10 # Dependencies
  11
  12 To compile **oclHashcat** the following third party libraries are required:
  13
  14 - AMD-APP-SDK v3.0 ( http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing-app-sdk/ )
  15 - ADL_SDK v8.0 ( http://developer.amd.com/tools-and-sdks/graphics-development/display-library-adl-sdk/ )
  16 - NVAPI R352 ( https://developer.nvidia.com/nvapi )
  17 - GDK v352_55 ( https://developer.nvidia.com/gpu-deployment-kit )
  18
  19 To be able to compile the ocl binaries, it is required to have the latest stable driver from AMD installed.
  20 (fglxr must be installed and initialized)
  21
  22     http://support.amd.com/
  23
  24 The next thing to do is download all the third party libraries listed above and put these files into the *deps/tmp* directory.
  25
  26 The following files are needed inside the *deps/tmp* directory:
  27
  28     ADL_SDK8.zip
  29     R352-developer.zip
  30     gdk_linux_amd64_352_55_release.run
  31     AMD-APP-SDKInstaller-v3.0.130.135-GA-linux64.tar.bz2
  32
  33 # Building oclHashcat
  34 First get a copy of **oclHashcat** repository
  35
  36 ```sh
  37 $ git clone https://github.com/hashcat/oclHashcat.git
  38 ```
  39 Install the dependencies
  40
  41 ```sh
  42 $ cd oclHashcat
  43 $ sudo ./tools/deps.sh
  44 ```
  45
  46 Run "make all"
  47
  48 ```sh
  49 $ make all
  50 ```
  51
  52 Useful tricks:
  53 - build only *Linux* binaries
  54 ```sh
  55 $ make linux
  56 ```
  57 - build only *Windows* binaries
  58 ```sh
  59 $ make windows
  60 ```
  61
  62 =
  63 Enjoy your fresh **oclHashcat** binaries ;)