1 // SPDX-License-Identifier: GPL-2.0-or-later 1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* 2 /*
3 * Cryptographic API. 3 * Cryptographic API.
4 * 4 *
5 * Deflate algorithm (RFC 1951), implemented h 5 * Deflate algorithm (RFC 1951), implemented here primarily for use
6 * by IPCOMP (RFC 3173 & RFC 2394). 6 * by IPCOMP (RFC 3173 & RFC 2394).
7 * 7 *
8 * Copyright (c) 2003 James Morris <jmorris@in 8 * Copyright (c) 2003 James Morris <jmorris@intercode.com.au>
9 * 9 *
10 * FIXME: deflate transforms will require up t 10 * FIXME: deflate transforms will require up to a total of about 436k of kernel
11 * memory on i386 (390k for compression, the r 11 * memory on i386 (390k for compression, the rest for decompression), as the
12 * current zlib kernel code uses a worst case 12 * current zlib kernel code uses a worst case pre-allocation system by default.
13 * This needs to be fixed so that the amount o 13 * This needs to be fixed so that the amount of memory required is properly
14 * related to the winbits and memlevel parame 14 * related to the winbits and memlevel parameters.
15 * 15 *
16 * The default winbits of 11 should suit most 16 * The default winbits of 11 should suit most packets, and it may be something
17 * to configure on a per-tfm basis in the futu 17 * to configure on a per-tfm basis in the future.
18 * 18 *
19 * Currently, compression history is not maint 19 * Currently, compression history is not maintained between tfm calls, as
20 * it is not needed for IPCOMP and keeps the c 20 * it is not needed for IPCOMP and keeps the code simpler. It can be
21 * implemented if someone wants it. 21 * implemented if someone wants it.
22 */ 22 */
23 #include <linux/init.h> 23 #include <linux/init.h>
24 #include <linux/module.h> 24 #include <linux/module.h>
25 #include <linux/crypto.h> 25 #include <linux/crypto.h>
26 #include <linux/zlib.h> 26 #include <linux/zlib.h>
27 #include <linux/vmalloc.h> 27 #include <linux/vmalloc.h>
28 #include <linux/interrupt.h> 28 #include <linux/interrupt.h>
29 #include <linux/mm.h> 29 #include <linux/mm.h>
30 #include <linux/net.h> 30 #include <linux/net.h>
31 #include <crypto/internal/scompress.h> 31 #include <crypto/internal/scompress.h>
32 32
33 #define DEFLATE_DEF_LEVEL Z_DEFA 33 #define DEFLATE_DEF_LEVEL Z_DEFAULT_COMPRESSION
34 #define DEFLATE_DEF_WINBITS 11 34 #define DEFLATE_DEF_WINBITS 11
35 #define DEFLATE_DEF_MEMLEVEL MAX_ME 35 #define DEFLATE_DEF_MEMLEVEL MAX_MEM_LEVEL
36 36
37 struct deflate_ctx { 37 struct deflate_ctx {
38 struct z_stream_s comp_stream; 38 struct z_stream_s comp_stream;
39 struct z_stream_s decomp_stream; 39 struct z_stream_s decomp_stream;
40 }; 40 };
41 41
42 static int deflate_comp_init(struct deflate_ct !! 42 static int deflate_comp_init(struct deflate_ctx *ctx, int format)
43 { 43 {
44 int ret = 0; 44 int ret = 0;
45 struct z_stream_s *stream = &ctx->comp 45 struct z_stream_s *stream = &ctx->comp_stream;
46 46
47 stream->workspace = vzalloc(zlib_defla 47 stream->workspace = vzalloc(zlib_deflate_workspacesize(
48 -DEFLATE_D !! 48 MAX_WBITS, MAX_MEM_LEVEL));
49 if (!stream->workspace) { 49 if (!stream->workspace) {
50 ret = -ENOMEM; 50 ret = -ENOMEM;
51 goto out; 51 goto out;
52 } 52 }
53 ret = zlib_deflateInit2(stream, DEFLAT !! 53 if (format)
54 -DEFLATE_DEF_W !! 54 ret = zlib_deflateInit(stream, 3);
55 Z_DEFAULT_STRA !! 55 else
>> 56 ret = zlib_deflateInit2(stream, DEFLATE_DEF_LEVEL, Z_DEFLATED,
>> 57 -DEFLATE_DEF_WINBITS,
>> 58 DEFLATE_DEF_MEMLEVEL,
>> 59 Z_DEFAULT_STRATEGY);
56 if (ret != Z_OK) { 60 if (ret != Z_OK) {
57 ret = -EINVAL; 61 ret = -EINVAL;
58 goto out_free; 62 goto out_free;
59 } 63 }
60 out: 64 out:
61 return ret; 65 return ret;
62 out_free: 66 out_free:
63 vfree(stream->workspace); 67 vfree(stream->workspace);
64 goto out; 68 goto out;
65 } 69 }
66 70
67 static int deflate_decomp_init(struct deflate_ !! 71 static int deflate_decomp_init(struct deflate_ctx *ctx, int format)
68 { 72 {
69 int ret = 0; 73 int ret = 0;
70 struct z_stream_s *stream = &ctx->deco 74 struct z_stream_s *stream = &ctx->decomp_stream;
71 75
72 stream->workspace = vzalloc(zlib_infla 76 stream->workspace = vzalloc(zlib_inflate_workspacesize());
73 if (!stream->workspace) { 77 if (!stream->workspace) {
74 ret = -ENOMEM; 78 ret = -ENOMEM;
75 goto out; 79 goto out;
76 } 80 }
77 ret = zlib_inflateInit2(stream, -DEFLA !! 81 if (format)
>> 82 ret = zlib_inflateInit(stream);
>> 83 else
>> 84 ret = zlib_inflateInit2(stream, -DEFLATE_DEF_WINBITS);
78 if (ret != Z_OK) { 85 if (ret != Z_OK) {
79 ret = -EINVAL; 86 ret = -EINVAL;
80 goto out_free; 87 goto out_free;
81 } 88 }
82 out: 89 out:
83 return ret; 90 return ret;
84 out_free: 91 out_free:
85 vfree(stream->workspace); 92 vfree(stream->workspace);
86 goto out; 93 goto out;
87 } 94 }
88 95
89 static void deflate_comp_exit(struct deflate_c 96 static void deflate_comp_exit(struct deflate_ctx *ctx)
90 { 97 {
91 zlib_deflateEnd(&ctx->comp_stream); 98 zlib_deflateEnd(&ctx->comp_stream);
92 vfree(ctx->comp_stream.workspace); 99 vfree(ctx->comp_stream.workspace);
93 } 100 }
94 101
95 static void deflate_decomp_exit(struct deflate 102 static void deflate_decomp_exit(struct deflate_ctx *ctx)
96 { 103 {
97 zlib_inflateEnd(&ctx->decomp_stream); 104 zlib_inflateEnd(&ctx->decomp_stream);
98 vfree(ctx->decomp_stream.workspace); 105 vfree(ctx->decomp_stream.workspace);
99 } 106 }
100 107
101 static int __deflate_init(void *ctx) !! 108 static int __deflate_init(void *ctx, int format)
102 { 109 {
103 int ret; 110 int ret;
104 111
105 ret = deflate_comp_init(ctx); !! 112 ret = deflate_comp_init(ctx, format);
106 if (ret) 113 if (ret)
107 goto out; 114 goto out;
108 ret = deflate_decomp_init(ctx); !! 115 ret = deflate_decomp_init(ctx, format);
109 if (ret) 116 if (ret)
110 deflate_comp_exit(ctx); 117 deflate_comp_exit(ctx);
111 out: 118 out:
112 return ret; 119 return ret;
113 } 120 }
114 121
115 static void *deflate_alloc_ctx(struct crypto_s !! 122 static void *gen_deflate_alloc_ctx(struct crypto_scomp *tfm, int format)
116 { 123 {
117 struct deflate_ctx *ctx; 124 struct deflate_ctx *ctx;
118 int ret; 125 int ret;
119 126
120 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL 127 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
121 if (!ctx) 128 if (!ctx)
122 return ERR_PTR(-ENOMEM); 129 return ERR_PTR(-ENOMEM);
123 130
124 ret = __deflate_init(ctx); !! 131 ret = __deflate_init(ctx, format);
125 if (ret) { 132 if (ret) {
126 kfree(ctx); 133 kfree(ctx);
127 return ERR_PTR(ret); 134 return ERR_PTR(ret);
128 } 135 }
129 136
130 return ctx; 137 return ctx;
131 } 138 }
132 139
>> 140 static void *deflate_alloc_ctx(struct crypto_scomp *tfm)
>> 141 {
>> 142 return gen_deflate_alloc_ctx(tfm, 0);
>> 143 }
>> 144
>> 145 static void *zlib_deflate_alloc_ctx(struct crypto_scomp *tfm)
>> 146 {
>> 147 return gen_deflate_alloc_ctx(tfm, 1);
>> 148 }
>> 149
133 static int deflate_init(struct crypto_tfm *tfm 150 static int deflate_init(struct crypto_tfm *tfm)
134 { 151 {
135 struct deflate_ctx *ctx = crypto_tfm_c 152 struct deflate_ctx *ctx = crypto_tfm_ctx(tfm);
136 153
137 return __deflate_init(ctx); !! 154 return __deflate_init(ctx, 0);
138 } 155 }
139 156
140 static void __deflate_exit(void *ctx) 157 static void __deflate_exit(void *ctx)
141 { 158 {
142 deflate_comp_exit(ctx); 159 deflate_comp_exit(ctx);
143 deflate_decomp_exit(ctx); 160 deflate_decomp_exit(ctx);
144 } 161 }
145 162
146 static void deflate_free_ctx(struct crypto_sco 163 static void deflate_free_ctx(struct crypto_scomp *tfm, void *ctx)
147 { 164 {
148 __deflate_exit(ctx); 165 __deflate_exit(ctx);
149 kfree_sensitive(ctx); 166 kfree_sensitive(ctx);
150 } 167 }
151 168
152 static void deflate_exit(struct crypto_tfm *tf 169 static void deflate_exit(struct crypto_tfm *tfm)
153 { 170 {
154 struct deflate_ctx *ctx = crypto_tfm_c 171 struct deflate_ctx *ctx = crypto_tfm_ctx(tfm);
155 172
156 __deflate_exit(ctx); 173 __deflate_exit(ctx);
157 } 174 }
158 175
159 static int __deflate_compress(const u8 *src, u 176 static int __deflate_compress(const u8 *src, unsigned int slen,
160 u8 *dst, unsigne 177 u8 *dst, unsigned int *dlen, void *ctx)
161 { 178 {
162 int ret = 0; 179 int ret = 0;
163 struct deflate_ctx *dctx = ctx; 180 struct deflate_ctx *dctx = ctx;
164 struct z_stream_s *stream = &dctx->com 181 struct z_stream_s *stream = &dctx->comp_stream;
165 182
166 ret = zlib_deflateReset(stream); 183 ret = zlib_deflateReset(stream);
167 if (ret != Z_OK) { 184 if (ret != Z_OK) {
168 ret = -EINVAL; 185 ret = -EINVAL;
169 goto out; 186 goto out;
170 } 187 }
171 188
172 stream->next_in = (u8 *)src; 189 stream->next_in = (u8 *)src;
173 stream->avail_in = slen; 190 stream->avail_in = slen;
174 stream->next_out = (u8 *)dst; 191 stream->next_out = (u8 *)dst;
175 stream->avail_out = *dlen; 192 stream->avail_out = *dlen;
176 193
177 ret = zlib_deflate(stream, Z_FINISH); 194 ret = zlib_deflate(stream, Z_FINISH);
178 if (ret != Z_STREAM_END) { 195 if (ret != Z_STREAM_END) {
179 ret = -EINVAL; 196 ret = -EINVAL;
180 goto out; 197 goto out;
181 } 198 }
182 ret = 0; 199 ret = 0;
183 *dlen = stream->total_out; 200 *dlen = stream->total_out;
184 out: 201 out:
185 return ret; 202 return ret;
186 } 203 }
187 204
188 static int deflate_compress(struct crypto_tfm 205 static int deflate_compress(struct crypto_tfm *tfm, const u8 *src,
189 unsigned int slen, 206 unsigned int slen, u8 *dst, unsigned int *dlen)
190 { 207 {
191 struct deflate_ctx *dctx = crypto_tfm_ 208 struct deflate_ctx *dctx = crypto_tfm_ctx(tfm);
192 209
193 return __deflate_compress(src, slen, d 210 return __deflate_compress(src, slen, dst, dlen, dctx);
194 } 211 }
195 212
196 static int deflate_scompress(struct crypto_sco 213 static int deflate_scompress(struct crypto_scomp *tfm, const u8 *src,
197 unsigned int slen 214 unsigned int slen, u8 *dst, unsigned int *dlen,
198 void *ctx) 215 void *ctx)
199 { 216 {
200 return __deflate_compress(src, slen, d 217 return __deflate_compress(src, slen, dst, dlen, ctx);
201 } 218 }
202 219
203 static int __deflate_decompress(const u8 *src, 220 static int __deflate_decompress(const u8 *src, unsigned int slen,
204 u8 *dst, unsig 221 u8 *dst, unsigned int *dlen, void *ctx)
205 { 222 {
206 223
207 int ret = 0; 224 int ret = 0;
208 struct deflate_ctx *dctx = ctx; 225 struct deflate_ctx *dctx = ctx;
209 struct z_stream_s *stream = &dctx->dec 226 struct z_stream_s *stream = &dctx->decomp_stream;
210 227
211 ret = zlib_inflateReset(stream); 228 ret = zlib_inflateReset(stream);
212 if (ret != Z_OK) { 229 if (ret != Z_OK) {
213 ret = -EINVAL; 230 ret = -EINVAL;
214 goto out; 231 goto out;
215 } 232 }
216 233
217 stream->next_in = (u8 *)src; 234 stream->next_in = (u8 *)src;
218 stream->avail_in = slen; 235 stream->avail_in = slen;
219 stream->next_out = (u8 *)dst; 236 stream->next_out = (u8 *)dst;
220 stream->avail_out = *dlen; 237 stream->avail_out = *dlen;
221 238
222 ret = zlib_inflate(stream, Z_SYNC_FLUS 239 ret = zlib_inflate(stream, Z_SYNC_FLUSH);
223 /* 240 /*
224 * Work around a bug in zlib, which so 241 * Work around a bug in zlib, which sometimes wants to taste an extra
225 * byte when being used in the (undocu 242 * byte when being used in the (undocumented) raw deflate mode.
226 * (From USAGI). 243 * (From USAGI).
227 */ 244 */
228 if (ret == Z_OK && !stream->avail_in & 245 if (ret == Z_OK && !stream->avail_in && stream->avail_out) {
229 u8 zerostuff = 0; 246 u8 zerostuff = 0;
230 stream->next_in = &zerostuff; 247 stream->next_in = &zerostuff;
231 stream->avail_in = 1; 248 stream->avail_in = 1;
232 ret = zlib_inflate(stream, Z_F 249 ret = zlib_inflate(stream, Z_FINISH);
233 } 250 }
234 if (ret != Z_STREAM_END) { 251 if (ret != Z_STREAM_END) {
235 ret = -EINVAL; 252 ret = -EINVAL;
236 goto out; 253 goto out;
237 } 254 }
238 ret = 0; 255 ret = 0;
239 *dlen = stream->total_out; 256 *dlen = stream->total_out;
240 out: 257 out:
241 return ret; 258 return ret;
242 } 259 }
243 260
244 static int deflate_decompress(struct crypto_tf 261 static int deflate_decompress(struct crypto_tfm *tfm, const u8 *src,
245 unsigned int sle 262 unsigned int slen, u8 *dst, unsigned int *dlen)
246 { 263 {
247 struct deflate_ctx *dctx = crypto_tfm_ 264 struct deflate_ctx *dctx = crypto_tfm_ctx(tfm);
248 265
249 return __deflate_decompress(src, slen, 266 return __deflate_decompress(src, slen, dst, dlen, dctx);
250 } 267 }
251 268
252 static int deflate_sdecompress(struct crypto_s 269 static int deflate_sdecompress(struct crypto_scomp *tfm, const u8 *src,
253 unsigned int sl 270 unsigned int slen, u8 *dst, unsigned int *dlen,
254 void *ctx) 271 void *ctx)
255 { 272 {
256 return __deflate_decompress(src, slen, 273 return __deflate_decompress(src, slen, dst, dlen, ctx);
257 } 274 }
258 275
259 static struct crypto_alg alg = { 276 static struct crypto_alg alg = {
260 .cra_name = "deflate", 277 .cra_name = "deflate",
261 .cra_driver_name = "deflate-gen 278 .cra_driver_name = "deflate-generic",
262 .cra_flags = CRYPTO_ALG_T 279 .cra_flags = CRYPTO_ALG_TYPE_COMPRESS,
263 .cra_ctxsize = sizeof(struc 280 .cra_ctxsize = sizeof(struct deflate_ctx),
264 .cra_module = THIS_MODULE, 281 .cra_module = THIS_MODULE,
265 .cra_init = deflate_init 282 .cra_init = deflate_init,
266 .cra_exit = deflate_exit 283 .cra_exit = deflate_exit,
267 .cra_u = { .compress 284 .cra_u = { .compress = {
268 .coa_compress = deflate_comp 285 .coa_compress = deflate_compress,
269 .coa_decompress = deflate_deco 286 .coa_decompress = deflate_decompress } }
270 }; 287 };
271 288
272 static struct scomp_alg scomp = { !! 289 static struct scomp_alg scomp[] = { {
273 .alloc_ctx = deflate_allo 290 .alloc_ctx = deflate_alloc_ctx,
274 .free_ctx = deflate_free 291 .free_ctx = deflate_free_ctx,
275 .compress = deflate_scom 292 .compress = deflate_scompress,
276 .decompress = deflate_sdec 293 .decompress = deflate_sdecompress,
277 .base = { 294 .base = {
278 .cra_name = "deflate", 295 .cra_name = "deflate",
279 .cra_driver_name = "deflate-sc 296 .cra_driver_name = "deflate-scomp",
280 .cra_module = THIS_MODULE 297 .cra_module = THIS_MODULE,
281 } 298 }
282 }; !! 299 }, {
>> 300 .alloc_ctx = zlib_deflate_alloc_ctx,
>> 301 .free_ctx = deflate_free_ctx,
>> 302 .compress = deflate_scompress,
>> 303 .decompress = deflate_sdecompress,
>> 304 .base = {
>> 305 .cra_name = "zlib-deflate",
>> 306 .cra_driver_name = "zlib-deflate-scomp",
>> 307 .cra_module = THIS_MODULE,
>> 308 }
>> 309 } };
283 310
284 static int __init deflate_mod_init(void) 311 static int __init deflate_mod_init(void)
285 { 312 {
286 int ret; 313 int ret;
287 314
288 ret = crypto_register_alg(&alg); 315 ret = crypto_register_alg(&alg);
289 if (ret) 316 if (ret)
290 return ret; 317 return ret;
291 318
292 ret = crypto_register_scomp(&scomp); !! 319 ret = crypto_register_scomps(scomp, ARRAY_SIZE(scomp));
293 if (ret) { 320 if (ret) {
294 crypto_unregister_alg(&alg); 321 crypto_unregister_alg(&alg);
295 return ret; 322 return ret;
296 } 323 }
297 324
298 return ret; 325 return ret;
299 } 326 }
300 327
301 static void __exit deflate_mod_fini(void) 328 static void __exit deflate_mod_fini(void)
302 { 329 {
303 crypto_unregister_alg(&alg); 330 crypto_unregister_alg(&alg);
304 crypto_unregister_scomp(&scomp); !! 331 crypto_unregister_scomps(scomp, ARRAY_SIZE(scomp));
305 } 332 }
306 333
307 subsys_initcall(deflate_mod_init); 334 subsys_initcall(deflate_mod_init);
308 module_exit(deflate_mod_fini); 335 module_exit(deflate_mod_fini);
309 336
310 MODULE_LICENSE("GPL"); 337 MODULE_LICENSE("GPL");
311 MODULE_DESCRIPTION("Deflate Compression Algori 338 MODULE_DESCRIPTION("Deflate Compression Algorithm for IPCOMP");
312 MODULE_AUTHOR("James Morris <jmorris@intercode 339 MODULE_AUTHOR("James Morris <jmorris@intercode.com.au>");
313 MODULE_ALIAS_CRYPTO("deflate"); 340 MODULE_ALIAS_CRYPTO("deflate");
314 MODULE_ALIAS_CRYPTO("deflate-generic"); <<
315 341
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.