From Fedora Project Wiki
(add link to review ticket)
(add hint in SCOPE, more verbose info on COMPATIBILITY, minor clean up)
Line 44: Line 44:
  
 
* Other developers:
 
* Other developers:
** Add <code>#include &lt;crypt.h&gt;</code> if it was missing before.  <code>&lt;unistd.h></code> no longer provides a declaration of the <code>crypt</code> function.
+
** Add <code>#include &lt;crypt.h&gt;</code> if it was missing before (e.g. detecting it is present by configure or conditionalizing on _XOPEN_CRYPT being defined by <code>&lt;unistd.h></code>).  <code>&lt;unistd.h></code> no longer provides a declaration of the <code>crypt</code> function.
** Optionally, add <code>BuildRequires: libxcrypt-devel</code> (which will eventually be needed some after the Fedora 28 release).
+
** Optionally, add <code>BuildRequires: libxcrypt-devel</code> (which will eventually be needed some time after the Fedora 28 release).
 
** Test their applications using one of the following interfaces for unexpected changes in functionality:
 
** Test their applications using one of the following interfaces for unexpected changes in functionality:
 
*** crypt()
 
*** crypt()
Line 59: Line 59:
 
* Policies and guidelines: N/A (not needed for this Change)
 
* Policies and guidelines: N/A (not needed for this Change)
 
* Trademark approval: N/A (not needed for this Change)
 
* Trademark approval: N/A (not needed for this Change)
 +
  
 
== Upgrade/compatibility impact ==
 
== Upgrade/compatibility impact ==
  
libxcrypt is fully binary compatible with software linked against glibc's libcrypt and does not require any rebuilds. However, the converse is not true: programs linked against libxcrypt will not work with glibc's libcrypt.  Also, programs that use certain legacy APIs supplied by glibc's libcrypt (encrypt, encrypt_r, setkey, setkey_r, and fcrypt) cannot be compiled against libxcrypt.
+
On Linux-based systems, by default libxcrypt will be binary backward compatible with the libcrypt.so.1 shipped as part of the GNU C Library. This means that all existing binary executables linked against glibc's libcrypt should work unmodified with this library's libcrypt.so.1. We have taken pains to provide exactly the same "symbol versions" as were used by glibc on various CPU architectures, and to account for the variety of ways in which the Openwall extensions were patched into glibc's libcrypt by some Linux distributions.
 +
 
 +
However, the converse is not true: programs linked against the libcrypt.so.1 built by libxcrypt will not work with glibc's libcrypt.  Also, programs that use certain legacy APIs supplied by glibc's libcrypt (encrypt, encrypt_r, setkey, setkey_r, and fcrypt) cannot be compiled against libxcrypt.
  
  
Line 70: Line 73:
 
* Change your user password and check if you can login with the new one.
 
* Change your user password and check if you can login with the new one.
 
* Check if all packages built against libcrypt are working as expected.  You can get a list of those packages with the following command:  <code>sudo dnf repoquery --whatrequires 'libcrypt.so*' | sed -e 's!-[0-9]\+.*$!!g' | sort -u</code>
 
* Check if all packages built against libcrypt are working as expected.  You can get a list of those packages with the following command:  <code>sudo dnf repoquery --whatrequires 'libcrypt.so*' | sed -e 's!-[0-9]\+.*$!!g' | sort -u</code>
 +
  
 
== User Experience ==
 
== User Experience ==
Line 87: Line 91:
 
* Blocks release? No
 
* Blocks release? No
 
* Blocks product? None
 
* Blocks product? None
 +
  
 
== Documentation ==
 
== Documentation ==

Revision as of 13:07, 25 January 2018

Replace glibc's libcrypt with libxcrypt

Summary

There are plans to remove libcrypt from glibc, so we should have a replacement.


Owner


Current status


Detailed Description

Since there has been some discussion in the last time about removing libcrypt from glibc in some time and splitting it out into a separate project which can evolve quicker, Zack Weinberg and I put some work into libxcrypt to make it a basically suitable replacement.

It comes with a set of extended interfaces pioneered by Openwall Linux, crypt_rn, crypt_ra, crypt_gensalt, crypt_gensalt_rn, and crypt_gensalt_ra.

The crypt and gensalt functions are supporting all (except for Crypt16, which was used on Ultrix and Tru64, only) widely used password hashing algorithms, which before were specific to just some operating system's implementations of libcrypt.


Benefit to Fedora

With libxcrypt the following benefits are expected:

  • new hashing algorithms are easiely integratable
  • faster development cycle compared to glibc's libcrypt
  • support for all hashing algorithms ever introduced to the crypt function


Scope

  • Proposal owners:
    • Apply needed packaging changes to glibc
    • Review, import and build libxcrypt for Fedora 28 (review ticket: #1532794)
  • Other developers:
    • Add #include <crypt.h> if it was missing before (e.g. detecting it is present by configure or conditionalizing on _XOPEN_CRYPT being defined by <unistd.h>). <unistd.h> no longer provides a declaration of the crypt function.
    • Optionally, add BuildRequires: libxcrypt-devel (which will eventually be needed some time after the Fedora 28 release).
    • Test their applications using one of the following interfaces for unexpected changes in functionality:
      • crypt()
      • crypt_r()
      • encrypt()
      • encrypt_r()
      • fcrypt()
      • setkey()
      • setkey_r()
  • Release engineering: #7160 none expected
  • Policies and guidelines: N/A (not needed for this Change)
  • Trademark approval: N/A (not needed for this Change)


Upgrade/compatibility impact

On Linux-based systems, by default libxcrypt will be binary backward compatible with the libcrypt.so.1 shipped as part of the GNU C Library. This means that all existing binary executables linked against glibc's libcrypt should work unmodified with this library's libcrypt.so.1. We have taken pains to provide exactly the same "symbol versions" as were used by glibc on various CPU architectures, and to account for the variety of ways in which the Openwall extensions were patched into glibc's libcrypt by some Linux distributions.

However, the converse is not true: programs linked against the libcrypt.so.1 built by libxcrypt will not work with glibc's libcrypt. Also, programs that use certain legacy APIs supplied by glibc's libcrypt (encrypt, encrypt_r, setkey, setkey_r, and fcrypt) cannot be compiled against libxcrypt.


How To Test

  • Logout of your current user session and check if you can login again.
  • Change your user password and check if you can login with the new one.
  • Check if all packages built against libcrypt are working as expected. You can get a list of those packages with the following command: sudo dnf repoquery --whatrequires 'libcrypt.so*' | sed -e 's!-[0-9]\+.*$!!g' | sort -u


User Experience

No noticable changes for end-users. Software developers can use some new functionality.


Dependencies

None, except for glibc (and the needed changes there).


Contingency Plan

  • Contingency mechanism: Revert changes and restore glibc's libcrypt (and rebuild binaries which link against libxcrypt-only symbols)
  • Contingency deadline: Completion deadline (testable)
  • Blocks release? No
  • Blocks product? None


Documentation

tba.


Release Notes

tba.