blob: 463dc859aa059d6e5f593e6db437e93025974c18 [file] [log] [blame]
Richard Hartmann9472d762010-02-16 20:32:13 +08001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Cryptographic API.
3 *
4 * Deflate algorithm (RFC 1951), implemented here primarily for use
5 * by IPCOMP (RFC 3173 & RFC 2394).
6 *
7 * Copyright (c) 2003 James Morris <jmorris@intercode.com.au>
Richard Hartmann9472d762010-02-16 20:32:13 +08008 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the Free
Richard Hartmann9472d762010-02-16 20:32:13 +080011 * Software Foundation; either version 2 of the License, or (at your option)
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * any later version.
13 *
14 * FIXME: deflate transforms will require up to a total of about 436k of kernel
15 * memory on i386 (390k for compression, the rest for decompression), as the
16 * current zlib kernel code uses a worst case pre-allocation system by default.
17 * This needs to be fixed so that the amount of memory required is properly
18 * related to the winbits and memlevel parameters.
19 *
20 * The default winbits of 11 should suit most packets, and it may be something
21 * to configure on a per-tfm basis in the future.
22 *
23 * Currently, compression history is not maintained between tfm calls, as
24 * it is not needed for IPCOMP and keeps the code simpler. It can be
25 * implemented if someone wants it.
26 */
27#include <linux/init.h>
28#include <linux/module.h>
29#include <linux/crypto.h>
30#include <linux/zlib.h>
31#include <linux/vmalloc.h>
32#include <linux/interrupt.h>
33#include <linux/mm.h>
34#include <linux/net.h>
35#include <linux/slab.h>
36
37#define DEFLATE_DEF_LEVEL Z_DEFAULT_COMPRESSION
38#define DEFLATE_DEF_WINBITS 11
39#define DEFLATE_DEF_MEMLEVEL MAX_MEM_LEVEL
40
41struct deflate_ctx {
42 struct z_stream_s comp_stream;
43 struct z_stream_s decomp_stream;
44};
45
46static int deflate_comp_init(struct deflate_ctx *ctx)
47{
48 int ret = 0;
49 struct z_stream_s *stream = &ctx->comp_stream;
50
51 stream->workspace = vmalloc(zlib_deflate_workspacesize());
Richard Hartmann9472d762010-02-16 20:32:13 +080052 if (!stream->workspace) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 ret = -ENOMEM;
54 goto out;
55 }
56 memset(stream->workspace, 0, zlib_deflate_workspacesize());
57 ret = zlib_deflateInit2(stream, DEFLATE_DEF_LEVEL, Z_DEFLATED,
58 -DEFLATE_DEF_WINBITS, DEFLATE_DEF_MEMLEVEL,
59 Z_DEFAULT_STRATEGY);
60 if (ret != Z_OK) {
61 ret = -EINVAL;
62 goto out_free;
63 }
Richard Hartmann9472d762010-02-16 20:32:13 +080064out:
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 return ret;
66out_free:
67 vfree(stream->workspace);
68 goto out;
69}
70
71static int deflate_decomp_init(struct deflate_ctx *ctx)
72{
73 int ret = 0;
74 struct z_stream_s *stream = &ctx->decomp_stream;
75
Eric Sesterhennbbeb5632006-03-06 21:42:07 +110076 stream->workspace = kzalloc(zlib_inflate_workspacesize(), GFP_KERNEL);
Richard Hartmann9472d762010-02-16 20:32:13 +080077 if (!stream->workspace) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 ret = -ENOMEM;
79 goto out;
80 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 ret = zlib_inflateInit2(stream, -DEFLATE_DEF_WINBITS);
82 if (ret != Z_OK) {
83 ret = -EINVAL;
84 goto out_free;
85 }
86out:
87 return ret;
88out_free:
89 kfree(stream->workspace);
90 goto out;
91}
92
93static void deflate_comp_exit(struct deflate_ctx *ctx)
94{
Artem B. Bityuckiy9ffb7142005-04-16 15:23:58 -070095 zlib_deflateEnd(&ctx->comp_stream);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 vfree(ctx->comp_stream.workspace);
97}
98
99static void deflate_decomp_exit(struct deflate_ctx *ctx)
100{
Artem B. Bityuckiy9ffb7142005-04-16 15:23:58 -0700101 zlib_inflateEnd(&ctx->decomp_stream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 kfree(ctx->decomp_stream.workspace);
103}
104
Herbert Xu6c2bb982006-05-16 22:09:29 +1000105static int deflate_init(struct crypto_tfm *tfm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106{
Herbert Xu6c2bb982006-05-16 22:09:29 +1000107 struct deflate_ctx *ctx = crypto_tfm_ctx(tfm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 int ret;
Richard Hartmann9472d762010-02-16 20:32:13 +0800109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 ret = deflate_comp_init(ctx);
111 if (ret)
112 goto out;
113 ret = deflate_decomp_init(ctx);
114 if (ret)
115 deflate_comp_exit(ctx);
116out:
117 return ret;
118}
119
Herbert Xu6c2bb982006-05-16 22:09:29 +1000120static void deflate_exit(struct crypto_tfm *tfm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
Herbert Xu6c2bb982006-05-16 22:09:29 +1000122 struct deflate_ctx *ctx = crypto_tfm_ctx(tfm);
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 deflate_comp_exit(ctx);
125 deflate_decomp_exit(ctx);
126}
127
Herbert Xu6c2bb982006-05-16 22:09:29 +1000128static int deflate_compress(struct crypto_tfm *tfm, const u8 *src,
129 unsigned int slen, u8 *dst, unsigned int *dlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
131 int ret = 0;
Herbert Xu6c2bb982006-05-16 22:09:29 +1000132 struct deflate_ctx *dctx = crypto_tfm_ctx(tfm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 struct z_stream_s *stream = &dctx->comp_stream;
134
135 ret = zlib_deflateReset(stream);
136 if (ret != Z_OK) {
137 ret = -EINVAL;
138 goto out;
139 }
140
141 stream->next_in = (u8 *)src;
142 stream->avail_in = slen;
143 stream->next_out = (u8 *)dst;
144 stream->avail_out = *dlen;
145
146 ret = zlib_deflate(stream, Z_FINISH);
147 if (ret != Z_STREAM_END) {
148 ret = -EINVAL;
149 goto out;
150 }
151 ret = 0;
152 *dlen = stream->total_out;
153out:
154 return ret;
155}
Richard Hartmann9472d762010-02-16 20:32:13 +0800156
Herbert Xu6c2bb982006-05-16 22:09:29 +1000157static int deflate_decompress(struct crypto_tfm *tfm, const u8 *src,
158 unsigned int slen, u8 *dst, unsigned int *dlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
Richard Hartmann9472d762010-02-16 20:32:13 +0800160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 int ret = 0;
Herbert Xu6c2bb982006-05-16 22:09:29 +1000162 struct deflate_ctx *dctx = crypto_tfm_ctx(tfm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 struct z_stream_s *stream = &dctx->decomp_stream;
164
165 ret = zlib_inflateReset(stream);
166 if (ret != Z_OK) {
167 ret = -EINVAL;
168 goto out;
169 }
170
171 stream->next_in = (u8 *)src;
172 stream->avail_in = slen;
173 stream->next_out = (u8 *)dst;
174 stream->avail_out = *dlen;
175
176 ret = zlib_inflate(stream, Z_SYNC_FLUSH);
177 /*
178 * Work around a bug in zlib, which sometimes wants to taste an extra
179 * byte when being used in the (undocumented) raw deflate mode.
180 * (From USAGI).
181 */
182 if (ret == Z_OK && !stream->avail_in && stream->avail_out) {
183 u8 zerostuff = 0;
184 stream->next_in = &zerostuff;
Richard Hartmann9472d762010-02-16 20:32:13 +0800185 stream->avail_in = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 ret = zlib_inflate(stream, Z_FINISH);
187 }
188 if (ret != Z_STREAM_END) {
189 ret = -EINVAL;
190 goto out;
191 }
192 ret = 0;
193 *dlen = stream->total_out;
194out:
195 return ret;
196}
197
198static struct crypto_alg alg = {
199 .cra_name = "deflate",
200 .cra_flags = CRYPTO_ALG_TYPE_COMPRESS,
201 .cra_ctxsize = sizeof(struct deflate_ctx),
202 .cra_module = THIS_MODULE,
203 .cra_list = LIST_HEAD_INIT(alg.cra_list),
Herbert Xuc7fc0592006-05-24 13:02:26 +1000204 .cra_init = deflate_init,
205 .cra_exit = deflate_exit,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 .cra_u = { .compress = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 .coa_compress = deflate_compress,
208 .coa_decompress = deflate_decompress } }
209};
210
Kamalesh Babulal3af5b902008-04-05 21:00:57 +0800211static int __init deflate_mod_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212{
213 return crypto_register_alg(&alg);
214}
215
Kamalesh Babulal3af5b902008-04-05 21:00:57 +0800216static void __exit deflate_mod_fini(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
218 crypto_unregister_alg(&alg);
219}
220
Kamalesh Babulal3af5b902008-04-05 21:00:57 +0800221module_init(deflate_mod_init);
222module_exit(deflate_mod_fini);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
224MODULE_LICENSE("GPL");
225MODULE_DESCRIPTION("Deflate Compression Algorithm for IPCOMP");
226MODULE_AUTHOR("James Morris <jmorris@intercode.com.au>");
227