BUILDING 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. Installing
  2. ----------
  3. We strongly recommend that people use the latest official release tarball on
  4. https://www.tarsnap.com/scrypt.html, and build with:
  5. ./configure
  6. make
  7. make install
  8. Official scrypt tarball releases should build and run on any IEEE Std 1003.1
  9. (POSIX) compliant system which
  10. 1. Includes the Software Development Utilities option,
  11. 2. Has OpenSSL available via -lcrypto and #include <openssl/foo>, and
  12. 3. Provides /dev/urandom.
  13. libscrypt-kdf
  14. -------------
  15. To install the development library, run:
  16. ./configure --enable-libscrypt-kdf
  17. make install
  18. Platform-specific notes
  19. -----------------------
  20. - On OS X, the version of OpenSSL included with the operating
  21. system is outdated (0.9.8) and deprecated, and it is recommended
  22. that scrypt be built with an updated version of OpenSSL. On OS X
  23. 10.11 "El Capitan" and higher, OpenSSL was removed entirely. After
  24. installing a newer version of OpenSSL, use
  25. CPPFLAGS="-I /path/to/openssl/headers"
  26. LDFLAGS="-L /path/to/openssl/lib"
  27. to build scrypt.
  28. In particular, if you installed OpenSSL using homebrew, you may
  29. pass the relevant directories directly to ./configure:
  30. ./configure CPPFLAGS="-I/usr/local/opt/openssl/include" LDFLAGS="-L/usr/local/opt/openssl/lib"
  31. Alternatively, you may with to add these lines to your $HOME/.profile file:
  32. export CPPFLAGS="-I/usr/local/opt/openssl/include $CPPFLAGS"
  33. export LDFLAGS="-L/usr/local/opt/openssl/lib $LDFLAGS"
  34. and then close & re-open your terminal window.
  35. Building from git
  36. -----------------
  37. For experimental development from git, build with:
  38. autoreconf -i
  39. ./configure
  40. make
  41. - You must have automake 1.11.2 or higher, and libtool.
  42. - In order to support the `AX_CFLAGS_WARN_ALL` autoconf directive, you will
  43. need to install the autoconf archive. On Debian systems, use the
  44. `autoconf-archive` package; on FreeBSD, use `devel/autoconf-archive`.
  45. - Ignore this message if it appears:
  46. aclocal: warning: couldn't open directory 'm4': No such file or directory