summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3/encrypt.3
blob: b60f6a1533043c37fc3813cb77a4e16be0c38203 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
'\" t
.\" Copyright 2000 Nicolás Lichtmaier <nick@debian.org>
.\" Created 2000-07-22 00:52-0300
.\"
.\" SPDX-License-Identifier: GPL-2.0-or-later
.\"
.\" Modified 2002-07-23 19:21:35 CEST 2002 Walter Harms
.\" <walter.harms@informatik.uni-oldenburg.de>
.\"
.\" Modified 2003-04-04, aeb
.\"
.TH encrypt 3 2024-05-02 "Linux man-pages 6.8"
.SH NAME
encrypt, setkey, encrypt_r, setkey_r \- encrypt 64-bit messages
.SH LIBRARY
Password hashing library
.RI ( libcrypt ", " \-lcrypt )
.SH SYNOPSIS
.nf
.BR "#define _XOPEN_SOURCE" "       /* See feature_test_macros(7) */"
.B #include <unistd.h>
.P
.BI "[[deprecated]] void encrypt(char " block "[64], int " edflag );
.P
.BR "#define _XOPEN_SOURCE" "       /* See feature_test_macros(7) */"
.B #include <stdlib.h>
.P
.BI "[[deprecated]] void setkey(const char *" key );
.P
.BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
.B #include <crypt.h>
.P
.BI "[[deprecated]] void setkey_r(const char *" key ", struct crypt_data *" data );
.BI "[[deprecated]] void encrypt_r(char *" block ", int " edflag ,
.BI "                              struct crypt_data *" data );
.fi
.SH DESCRIPTION
These functions encrypt and decrypt 64-bit messages.
The
.BR setkey ()
function sets the key used by
.BR encrypt ().
The
.I key
argument used here is an array of 64 bytes, each of which has
numerical value 1 or 0.
The bytes key[n] where n=8*i-1 are ignored,
so that the effective key length is 56 bits.
.P
The
.BR encrypt ()
function modifies the passed buffer, encoding if
.I edflag
is 0, and decoding if 1 is being passed.
Like the
.I key
argument, also
.I block
is a bit vector representation of the actual value that is encoded.
The result is returned in that same vector.
.P
These two functions are not reentrant, that is, the key data is
kept in static storage.
The functions
.BR setkey_r ()
and
.BR encrypt_r ()
are the reentrant versions.
They use the following
structure to hold the key data:
.P
.in +4n
.EX
struct crypt_data {
    char keysched[16 * 8];
    char sb0[32768];
    char sb1[32768];
    char sb2[32768];
    char sb3[32768];
    char crypt_3_buf[14];
    char current_salt[2];
    long current_saltbits;
    int  direction;
    int  initialized;
};
.EE
.in
.P
Before calling
.BR setkey_r ()
set
.I data\->initialized
to zero.
.SH RETURN VALUE
These functions do not return any value.
.SH ERRORS
Set
.I errno
to zero before calling the above functions.
On success,
.I errno
is unchanged.
.TP
.B ENOSYS
The function is not provided.
(For example because of former USA export restrictions.)
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lbx lb lb
l l l.
Interface	Attribute	Value
T{
.na
.nh
.BR encrypt (),
.BR setkey ()
T}	Thread safety	MT-Unsafe race:crypt
T{
.na
.nh
.BR encrypt_r (),
.BR setkey_r ()
T}	Thread safety	MT-Safe
.TE
.SH STANDARDS
.TP
.BR encrypt ()
.TQ
.BR setkey ()
POSIX.1-2008.
.TP
.BR encrypt_r ()
.TQ
.BR setkey_r ()
None.
.SH HISTORY
Removed in glibc 2.28.
.P
Because they employ the DES block cipher,
which is no longer considered secure,
these functions were removed from glibc.
Applications should switch to a modern cryptography library, such as
.BR libgcrypt .
.TP
.BR encrypt ()
.TQ
.BR setkey ()
POSIX.1-2001, SUS, SVr4.
.SS Availability in glibc
See
.BR crypt (3).
.SS Features in glibc
In glibc 2.2, these functions use the DES algorithm.
.SH EXAMPLES
.\" SRC BEGIN (encrypt.c)
.EX
#define _XOPEN_SOURCE
#include <crypt.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
\&
int
main(void)
{
    char key[64];
    char orig[9] = "eggplant";
    char buf[64];
    char txt[9];
\&
    for (size_t i = 0; i < 64; i++) {
        key[i] = rand() & 1;
    }
\&
    for (size_t i = 0; i < 8; i++) {
        for (size_t j = 0; j < 8; j++) {
            buf[i * 8 + j] = orig[i] >> j & 1;
        }
        setkey(key);
    }
    printf("Before encrypting: %s\en", orig);
\&
    encrypt(buf, 0);
    for (size_t i = 0; i < 8; i++) {
        for (size_t j = 0, txt[i] = \[aq]\e0\[aq]; j < 8; j++) {
            txt[i] |= buf[i * 8 + j] << j;
        }
        txt[8] = \[aq]\e0\[aq];
    }
    printf("After encrypting:  %s\en", txt);
\&
    encrypt(buf, 1);
    for (size_t i = 0; i < 8; i++) {
        for (size_t j = 0, txt[i] = \[aq]\e0\[aq]; j < 8; j++) {
            txt[i] |= buf[i * 8 + j] << j;
        }
        txt[8] = \[aq]\e0\[aq];
    }
    printf("After decrypting:  %s\en", txt);
    exit(EXIT_SUCCESS);
}
.EE
.\" SRC END
.SH SEE ALSO
.BR cbc_crypt (3),
.BR crypt (3),
.BR ecb_crypt (3)
.\" .BR fcrypt (3)