man3/encrypt.3

   1 .\" Copyright 2000 Nicolás Lichtmaier <nick@debian.org>
   2 .\" Created 2000-07-22 00:52-0300
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   5 .\" This is free documentation; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License as
   7 .\" published by the Free Software Foundation; either version 2 of
   8 .\" the License, or (at your option) any later version.
   9 .\"
  10 .\" The GNU General Public License's references to "object code"
  11 .\" and "executables" are to be interpreted as the output of any
  12 .\" document formatting or typesetting system, including
  13 .\" intermediate and printed output.
  14 .\"
  15 .\" This manual is distributed in the hope that it will be useful,
  16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 .\" GNU General Public License for more details.
  19 .\"
  20 .\" You should have received a copy of the GNU General Public
  21 .\" License along with this manual; if not, see
  22 .\" <http://www.gnu.org/licenses/>.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified 2002-07-23 19:21:35 CEST 2002 Walter Harms
  26 .\" <walter.harms@informatik.uni-oldenburg.de>
  27 .\"
  28 .\" Modified 2003-04-04, aeb
  29 .\"
  30 .TH ENCRYPT 3 2021-03-22 "" "Linux Programmer's Manual"
  31 .SH NAME
  32 encrypt, setkey, encrypt_r, setkey_r \- encrypt 64-bit messages
  33 .SH SYNOPSIS
  34 .nf
  35 .BR "#define _XOPEN_SOURCE" "       /* See feature_test_macros(7) */"
  36 .B #include <unistd.h>
  37 .PP
  38 .BI "void encrypt(char " block "[64], int " edflag );
  39 .PP
  40 .BR "#define _XOPEN_SOURCE" "       /* See feature_test_macros(7) */"
  41 .B #include <stdlib.h>
  42 .PP
  43 .BI "void setkey(const char *" key );
  44 .PP
  45 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  46 .B "#include <crypt.h>"
  47 .PP
  48 .BI "void setkey_r(const char *" key ", struct crypt_data *" data );
  49 .BI "void encrypt_r(char *" block ", int " edflag \
  50 ", struct crypt_data *" data );
  51 .fi
  52 .PP
  53 Each of these requires linking with \fI\-lcrypt\fP.
  54 .SH DESCRIPTION
  55 These functions encrypt and decrypt 64-bit messages.
  56 The
  57 .BR setkey ()
  58 function sets the key used by
  59 .BR encrypt ().
  60 The
  61 .I key
  62 argument used here is an array of 64 bytes, each of which has
  63 numerical value 1 or 0.
  64 The bytes key[n] where n=8*i-1 are ignored,
  65 so that the effective key length is 56 bits.
  66 .PP
  67 The
  68 .BR encrypt ()
  69 function modifies the passed buffer, encoding if
  70 .I edflag
  71 is 0, and decoding if 1 is being passed.
  72 Like the
  73 .I key
  74 argument, also
  75 .I block
  76 is a bit vector representation of the actual value that is encoded.
  77 The result is returned in that same vector.
  78 .PP
  79 These two functions are not reentrant, that is, the key data is
  80 kept in static storage.
  81 The functions
  82 .BR setkey_r ()
  83 and
  84 .BR encrypt_r ()
  85 are the reentrant versions.
  86 They use the following
  87 structure to hold the key data:
  88 .PP
  89 .in +4n
  90 .EX
  91 struct crypt_data {
  92     char keysched[16 * 8];
  93     char sb0[32768];
  94     char sb1[32768];
  95     char sb2[32768];
  96     char sb3[32768];
  97     char crypt_3_buf[14];
  98     char current_salt[2];
  99     long current_saltbits;
 100     int  direction;
 101     int  initialized;
 102 };
 103 .EE
 104 .in
 105 .PP
 106 Before calling
 107 .BR setkey_r ()
 108 set
 109 .I data\->initialized
 110 to zero.
 111 .SH RETURN VALUE
 112 These functions do not return any value.
 113 .SH ERRORS
 114 Set
 115 .I errno
 116 to zero before calling the above functions.
 117 On success,
 118 .I errno
 119 is unchanged.
 120 .TP
 121 .B ENOSYS
 122 The function is not provided.
 123 (For example because of former USA export restrictions.)
 124 .SH VERSIONS
 125 Because they employ the DES block cipher,
 126 which is no longer considered secure,
 127 .BR crypt (),
 128 .BR crypt_r (),
 129 .BR setkey (),
 130 and
 131 .BR setkey_r ()
 132 were removed in glibc 2.28.
 133 Applications should switch to a modern cryptography library, such as
 134 .BR libgcrypt .
 135 .SH ATTRIBUTES
 136 For an explanation of the terms used in this section, see
 137 .BR attributes (7).
 138 .ad l
 139 .nh
 140 .TS
 141 allbox;
 142 lbx lb lb
 143 l l l.
 144 Interface       Attribute       Value
 145 T{
 146 .BR encrypt (),
 147 .BR setkey ()
 148 T}      Thread safety   MT-Unsafe race:crypt
 149 T{
 150 .BR encrypt_r (),
 151 .BR setkey_r ()
 152 T}      Thread safety   MT-Safe
 153 .TE
 154 .hy
 155 .ad
 156 .sp 1
 157 .SH CONFORMING TO
 158 .BR encrypt (),
 159 .BR setkey ():
 160 POSIX.1-2001, POSIX.1-2008, SUS, SVr4.
 161 .PP
 162 The functions
 163 .BR encrypt_r ()
 164 and
 165 .BR setkey_r ()
 166 are GNU extensions.
 167 .SH NOTES
 168 .SS Availability in glibc
 169 See
 170 .BR crypt (3).
 171 .SS Features in glibc
 172 In glibc 2.2, these functions use the DES algorithm.
 173 .SH EXAMPLES
 174 .EX
 175 #define _XOPEN_SOURCE
 176 #include <stdio.h>
 177 #include <stdlib.h>
 178 #include <unistd.h>
 179 #include <crypt.h>
 180
 181 int
 182 main(void)
 183 {
 184     char key[64];
 185     char orig[9] = "eggplant";
 186     char buf[64];
 187     char txt[9];
 188
 189     for (int i = 0; i < 64; i++) {
 190         key[i] = rand() & 1;
 191     }
 192
 193     for (int i = 0; i < 8; i++) {
 194         for (int j = 0; j < 8; j++) {
 195             buf[i * 8 + j] = orig[i] >> j & 1;
 196         }
 197         setkey(key);
 198     }
 199     printf("Before encrypting: %s\en", orig);
 200
 201     encrypt(buf, 0);
 202     for (int i = 0; i < 8; i++) {
 203         for (int j = 0, txt[i] = \(aq\e0\(aq; j < 8; j++) {
 204             txt[i] |= buf[i * 8 + j] << j;
 205         }
 206         txt[8] = \(aq\e0\(aq;
 207     }
 208     printf("After encrypting:  %s\en", txt);
 209
 210     encrypt(buf, 1);
 211     for (int i = 0; i < 8; i++) {
 212         for (int j = 0, txt[i] = \(aq\e0\(aq; j < 8; j++) {
 213             txt[i] |= buf[i * 8 + j] << j;
 214         }
 215         txt[8] = \(aq\e0\(aq;
 216     }
 217     printf("After decrypting:  %s\en", txt);
 218     exit(EXIT_SUCCESS);
 219 }
 220 .EE
 221 .SH SEE ALSO
 222 .BR cbc_crypt (3),
 223 .BR crypt (3),
 224 .BR ecb_crypt (3),
 225 .\" .BR fcrypt (3)