Project import generated by Copybara.

GitOrigin-RevId: 94b8ab38d80d7969aab916d6fcc7c1a9a731bc81
186 files changed
tree: 91d3f2267ff9e3b9414f03729cd0e1e9a16c1a46
  1. docs/
  2. lib/
  3. man/
  4. misc/
  5. po/
  6. python/
  7. src/
  8. tests/
  9. .gitignore
  10. ABOUT-NLS
  11. Android.mk
  12. AUTHORS
  13. autogen.sh
  14. ChangeLog
  15. config.h
  16. configure.ac
  17. COPYING
  18. COPYING.LGPL
  19. FAQ
  20. INSTALL
  21. Makefile.am
  22. MODULE_LICENSE_GPL
  23. NEWS
  24. NOTICE
  25. README
  26. README.md
  27. TODO
README.md

LUKS logo

What the ...?

Cryptsetup is utility used to conveniently setup disk encryption based on DMCrypt kernel module.

These include plain dm-crypt volumes, LUKS volumes, loop-AES and TrueCrypt (including VeraCrypt extension) format.

Project also includes veritysetup utility used to conveniently setup DMVerity block integrity checking kernel module.

LUKS Design

LUKS is the standard for Linux hard disk encryption. By providing a standard on-disk-format, it does not
only facilitate compatibility among distributions, but also provides secure management of multiple user passwords.
In contrast to existing solution, LUKS stores all setup necessary setup information in the partition header,
enabling the user to transport or migrate his data seamlessly.

Last version of the LUKS format specification is available here.

Why LUKS?

  • compatiblity via standardization,
  • secure against low entropy attacks,
  • support for multiple keys,
  • effective passphrase revocation,
  • free.

Project home page.

CVE-2016-4484 (Initrd root shell)

This is problem in intramfs scripts only (these are not part of cryptsetup project), it is neiter bug in cryptsetup nor in LUKS.
Some distributions could add these scripts to distributed package, please check your distro updates for more info.

Frequently asked questions (FAQ)

Download

All release tarballs and release notes are hosted on kernel.org.

The latest cryptsetup version is 1.7.5

Previous versions

Source and API docs

For development version code, please refer to source page, mirror on kernel.org or GitHub.

For libcryptsetup documentation see libcryptsetup API page.

The libcryptsetup API/ABI changes are tracked in compatibility report.

NLS PO files are maintained by TranslationProject.

Help!

Please always read FAQ first. For cryptsetup and LUKS related questions, please use the dm-crypt mailing list, dm-crypt@saout.de.

If you want to subscribe just send an empty mail to dm-crypt-subscribe@saout.de.

You can also browse list archive or read it through web interface.