Debian Codegraph @

ext/bcrypt/README.adoc

raw
1 This extension is based on the crypt_browfish 1.3 by
2 by Solar Designer <solar at openwall.com>.
3
4 The source of the original package is available at:
5 https://www.openwall.com/crypt/
6
7 We dropped x86 assembler implementation that comes with the
8 original source, for speed is not our goal, and having an asm
9 mean more support burden.
10
11 The content of the original README follows:
12 -------------------------------------------------------------------
13
14 This is an implementation of a password hashing method, provided via the
15 crypt(3) and a reentrant interface. It is fully compatible with
16 OpenBSD's bcrypt.c for prefix "$2b$", originally by Niels Provos and
17 David Mazieres. (Please refer to the included crypt(3) man page for
18 information on minor compatibility issues for other bcrypt prefixes.)
19
20 I've placed this code in the public domain, with fallback to a
21 permissive license. Please see the comment in crypt_blowfish.c for
22 more information.
23
24 You can use the provided routines in your own packages, or link them
25 into a C library. I've provided hooks for linking into GNU libc, but
26 it shouldn't be too hard to get this into another C library. Note
27 that simply adding this code into your libc is probably not enough to
28 make your system use the new password hashing algorithm. Changes to
29 passwd(1), PAM modules, or whatever else your system uses will likely
30 be needed as well. These are not a part of this package, but see
31 LINKS for a pointer to our tcb suite.
32
33 Instructions on using the routines in one of the two common ways are
34 given below. It is recommended that you test the routines on your
35 system before you start. Type "make check" or "make check_threads"
36 (if you have the POSIX threads library), then "make clean".
37
38
39 1. Using the routines in your programs.
40
41 The available interfaces are in ow-crypt.h, and this is the file you
42 should include. You won't need crypt.h. When linking, add all of the
43 C files and x86.S (you can compile and link it even on a non-x86, it
44 will produce no code in this case).
45
46
47 2. Building the routines into GNU C library.
48
49 For versions 2.13 and 2.14 (and likely other nearby ones), extract the
50 library sources as usual. Apply the patch for glibc 2.14 provided in
51 this package. Enter crypt/ and rename crypt.h to gnu-crypt.h within
52 that directory. Copy the C sources, header, and assembly (x86.S) files
53 from this package in there as well (but be sure you don't overwrite the
54 Makefile). Configure, build, and install the library as usual.
55
56 For versions 2.2 to 2.3.6 (and likely also for some newer ones),
57 extract the library sources and maybe its optional add-ons as usual.
58 Apply the patch for glibc 2.3.6 provided in this package. Enter
59 crypt/ and rename crypt.h to gnu-crypt.h within that directory. Copy
60 the C sources, header, and assembly (x86.S) files from this package in
61 there as well (but be sure you don't overwrite the Makefile).
62 Configure, build, and install the library as usual.
63
64 For versions 2.1 to 2.1.3, extract the library sources and the crypt
65 and linuxthreads add-ons as usual. Apply the patch for glibc 2.1.3
66 provided in this package. Enter crypt/sysdeps/unix/, and rename
67 crypt.h to gnu-crypt.h within that directory. Copy C sources, header,
68 and assembly (x86.S) files from this package in there as well (but be
69 sure you don't overwrite the Makefile). Configure, build, and install
70 the library as usual.
71
72 Programs that want to use the provided interfaces will need to include
73 crypt.h (but not ow-crypt.h directly). By default, prototypes for the
74 new routines aren't defined (but the extra functionality of crypt(3)
75 is indeed available). You need to define _OW_SOURCE to obtain the new
76 routines as well.
77
78 --
79 Solar Designer <solar at openwall.com>
80
81 $Owl: Owl/packages/glibc/crypt_blowfish/README,v 1.10 2014/07/07 15:19:04 solar Exp $
82 -------------------------------------------------------------------