xdr: Add an export for the helper function write_bytes_to_xdr_buf()
[linux-2.6.git] / net / sunrpc / auth_gss / gss_krb5_crypto.c
1 /*
2  *  linux/net/sunrpc/gss_krb5_crypto.c
3  *
4  *  Copyright (c) 2000-2008 The Regents of the University of Michigan.
5  *  All rights reserved.
6  *
7  *  Andy Adamson   <andros@umich.edu>
8  *  Bruce Fields   <bfields@umich.edu>
9  */
10
11 /*
12  * Copyright (C) 1998 by the FundsXpress, INC.
13  *
14  * All rights reserved.
15  *
16  * Export of this software from the United States of America may require
17  * a specific license from the United States Government.  It is the
18  * responsibility of any person or organization contemplating export to
19  * obtain such a license before exporting.
20  *
21  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
22  * distribute this software and its documentation for any purpose and
23  * without fee is hereby granted, provided that the above copyright
24  * notice appear in all copies and that both that copyright notice and
25  * this permission notice appear in supporting documentation, and that
26  * the name of FundsXpress. not be used in advertising or publicity pertaining
27  * to distribution of the software without specific, written prior
28  * permission.  FundsXpress makes no representations about the suitability of
29  * this software for any purpose.  It is provided "as is" without express
30  * or implied warranty.
31  *
32  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
33  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
34  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
35  */
36
37 #include <linux/err.h>
38 #include <linux/types.h>
39 #include <linux/mm.h>
40 #include <linux/scatterlist.h>
41 #include <linux/crypto.h>
42 #include <linux/highmem.h>
43 #include <linux/pagemap.h>
44 #include <linux/sunrpc/gss_krb5.h>
45 #include <linux/sunrpc/xdr.h>
46
47 #ifdef RPC_DEBUG
48 # define RPCDBG_FACILITY        RPCDBG_AUTH
49 #endif
50
51 u32
52 krb5_encrypt(
53         struct crypto_blkcipher *tfm,
54         void * iv,
55         void * in,
56         void * out,
57         int length)
58 {
59         u32 ret = -EINVAL;
60         struct scatterlist sg[1];
61         u8 local_iv[GSS_KRB5_MAX_BLOCKSIZE] = {0};
62         struct blkcipher_desc desc = { .tfm = tfm, .info = local_iv };
63
64         if (length % crypto_blkcipher_blocksize(tfm) != 0)
65                 goto out;
66
67         if (crypto_blkcipher_ivsize(tfm) > GSS_KRB5_MAX_BLOCKSIZE) {
68                 dprintk("RPC:       gss_k5encrypt: tfm iv size too large %d\n",
69                         crypto_blkcipher_ivsize(tfm));
70                 goto out;
71         }
72
73         if (iv)
74                 memcpy(local_iv, iv, crypto_blkcipher_ivsize(tfm));
75
76         memcpy(out, in, length);
77         sg_init_one(sg, out, length);
78
79         ret = crypto_blkcipher_encrypt_iv(&desc, sg, sg, length);
80 out:
81         dprintk("RPC:       krb5_encrypt returns %d\n", ret);
82         return ret;
83 }
84
85 u32
86 krb5_decrypt(
87      struct crypto_blkcipher *tfm,
88      void * iv,
89      void * in,
90      void * out,
91      int length)
92 {
93         u32 ret = -EINVAL;
94         struct scatterlist sg[1];
95         u8 local_iv[GSS_KRB5_MAX_BLOCKSIZE] = {0};
96         struct blkcipher_desc desc = { .tfm = tfm, .info = local_iv };
97
98         if (length % crypto_blkcipher_blocksize(tfm) != 0)
99                 goto out;
100
101         if (crypto_blkcipher_ivsize(tfm) > GSS_KRB5_MAX_BLOCKSIZE) {
102                 dprintk("RPC:       gss_k5decrypt: tfm iv size too large %d\n",
103                         crypto_blkcipher_ivsize(tfm));
104                 goto out;
105         }
106         if (iv)
107                 memcpy(local_iv,iv, crypto_blkcipher_ivsize(tfm));
108
109         memcpy(out, in, length);
110         sg_init_one(sg, out, length);
111
112         ret = crypto_blkcipher_decrypt_iv(&desc, sg, sg, length);
113 out:
114         dprintk("RPC:       gss_k5decrypt returns %d\n",ret);
115         return ret;
116 }
117
118 static int
119 checksummer(struct scatterlist *sg, void *data)
120 {
121         struct hash_desc *desc = data;
122
123         return crypto_hash_update(desc, sg, sg->length);
124 }
125
126 /*
127  * checksum the plaintext data and hdrlen bytes of the token header
128  * The checksum is performed over the first 8 bytes of the
129  * gss token header and then over the data body
130  */
131 u32
132 make_checksum(struct krb5_ctx *kctx, char *header, int hdrlen,
133               struct xdr_buf *body, int body_offset, u8 *cksumkey,
134               struct xdr_netobj *cksumout)
135 {
136         struct hash_desc                desc;
137         struct scatterlist              sg[1];
138         int err;
139         u8 checksumdata[GSS_KRB5_MAX_CKSUM_LEN];
140         unsigned int checksumlen;
141
142         if (cksumout->len < kctx->gk5e->cksumlength) {
143                 dprintk("%s: checksum buffer length, %u, too small for %s\n",
144                         __func__, cksumout->len, kctx->gk5e->name);
145                 return GSS_S_FAILURE;
146         }
147
148         desc.tfm = crypto_alloc_hash(kctx->gk5e->cksum_name, 0, CRYPTO_ALG_ASYNC);
149         if (IS_ERR(desc.tfm))
150                 return GSS_S_FAILURE;
151         desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
152
153         checksumlen = crypto_hash_digestsize(desc.tfm);
154
155         if (cksumkey != NULL) {
156                 err = crypto_hash_setkey(desc.tfm, cksumkey,
157                                          kctx->gk5e->keylength);
158                 if (err)
159                         goto out;
160         }
161
162         err = crypto_hash_init(&desc);
163         if (err)
164                 goto out;
165         sg_init_one(sg, header, hdrlen);
166         err = crypto_hash_update(&desc, sg, hdrlen);
167         if (err)
168                 goto out;
169         err = xdr_process_buf(body, body_offset, body->len - body_offset,
170                               checksummer, &desc);
171         if (err)
172                 goto out;
173         err = crypto_hash_final(&desc, checksumdata);
174         if (err)
175                 goto out;
176
177         switch (kctx->gk5e->ctype) {
178         case CKSUMTYPE_RSA_MD5:
179                 err = kctx->gk5e->encrypt(kctx->seq, NULL, checksumdata,
180                                           checksumdata, checksumlen);
181                 if (err)
182                         goto out;
183                 memcpy(cksumout->data,
184                        checksumdata + checksumlen - kctx->gk5e->cksumlength,
185                        kctx->gk5e->cksumlength);
186                 break;
187         case CKSUMTYPE_HMAC_SHA1_DES3:
188                 memcpy(cksumout->data, checksumdata, kctx->gk5e->cksumlength);
189                 break;
190         default:
191                 BUG();
192                 break;
193         }
194         cksumout->len = kctx->gk5e->cksumlength;
195 out:
196         crypto_free_hash(desc.tfm);
197         return err ? GSS_S_FAILURE : 0;
198 }
199
200 struct encryptor_desc {
201         u8 iv[GSS_KRB5_MAX_BLOCKSIZE];
202         struct blkcipher_desc desc;
203         int pos;
204         struct xdr_buf *outbuf;
205         struct page **pages;
206         struct scatterlist infrags[4];
207         struct scatterlist outfrags[4];
208         int fragno;
209         int fraglen;
210 };
211
212 static int
213 encryptor(struct scatterlist *sg, void *data)
214 {
215         struct encryptor_desc *desc = data;
216         struct xdr_buf *outbuf = desc->outbuf;
217         struct page *in_page;
218         int thislen = desc->fraglen + sg->length;
219         int fraglen, ret;
220         int page_pos;
221
222         /* Worst case is 4 fragments: head, end of page 1, start
223          * of page 2, tail.  Anything more is a bug. */
224         BUG_ON(desc->fragno > 3);
225
226         page_pos = desc->pos - outbuf->head[0].iov_len;
227         if (page_pos >= 0 && page_pos < outbuf->page_len) {
228                 /* pages are not in place: */
229                 int i = (page_pos + outbuf->page_base) >> PAGE_CACHE_SHIFT;
230                 in_page = desc->pages[i];
231         } else {
232                 in_page = sg_page(sg);
233         }
234         sg_set_page(&desc->infrags[desc->fragno], in_page, sg->length,
235                     sg->offset);
236         sg_set_page(&desc->outfrags[desc->fragno], sg_page(sg), sg->length,
237                     sg->offset);
238         desc->fragno++;
239         desc->fraglen += sg->length;
240         desc->pos += sg->length;
241
242         fraglen = thislen & (crypto_blkcipher_blocksize(desc->desc.tfm) - 1);
243         thislen -= fraglen;
244
245         if (thislen == 0)
246                 return 0;
247
248         sg_mark_end(&desc->infrags[desc->fragno - 1]);
249         sg_mark_end(&desc->outfrags[desc->fragno - 1]);
250
251         ret = crypto_blkcipher_encrypt_iv(&desc->desc, desc->outfrags,
252                                           desc->infrags, thislen);
253         if (ret)
254                 return ret;
255
256         sg_init_table(desc->infrags, 4);
257         sg_init_table(desc->outfrags, 4);
258
259         if (fraglen) {
260                 sg_set_page(&desc->outfrags[0], sg_page(sg), fraglen,
261                                 sg->offset + sg->length - fraglen);
262                 desc->infrags[0] = desc->outfrags[0];
263                 sg_assign_page(&desc->infrags[0], in_page);
264                 desc->fragno = 1;
265                 desc->fraglen = fraglen;
266         } else {
267                 desc->fragno = 0;
268                 desc->fraglen = 0;
269         }
270         return 0;
271 }
272
273 int
274 gss_encrypt_xdr_buf(struct crypto_blkcipher *tfm, struct xdr_buf *buf,
275                     int offset, struct page **pages)
276 {
277         int ret;
278         struct encryptor_desc desc;
279
280         BUG_ON((buf->len - offset) % crypto_blkcipher_blocksize(tfm) != 0);
281
282         memset(desc.iv, 0, sizeof(desc.iv));
283         desc.desc.tfm = tfm;
284         desc.desc.info = desc.iv;
285         desc.desc.flags = 0;
286         desc.pos = offset;
287         desc.outbuf = buf;
288         desc.pages = pages;
289         desc.fragno = 0;
290         desc.fraglen = 0;
291
292         sg_init_table(desc.infrags, 4);
293         sg_init_table(desc.outfrags, 4);
294
295         ret = xdr_process_buf(buf, offset, buf->len - offset, encryptor, &desc);
296         return ret;
297 }
298
299 struct decryptor_desc {
300         u8 iv[GSS_KRB5_MAX_BLOCKSIZE];
301         struct blkcipher_desc desc;
302         struct scatterlist frags[4];
303         int fragno;
304         int fraglen;
305 };
306
307 static int
308 decryptor(struct scatterlist *sg, void *data)
309 {
310         struct decryptor_desc *desc = data;
311         int thislen = desc->fraglen + sg->length;
312         int fraglen, ret;
313
314         /* Worst case is 4 fragments: head, end of page 1, start
315          * of page 2, tail.  Anything more is a bug. */
316         BUG_ON(desc->fragno > 3);
317         sg_set_page(&desc->frags[desc->fragno], sg_page(sg), sg->length,
318                     sg->offset);
319         desc->fragno++;
320         desc->fraglen += sg->length;
321
322         fraglen = thislen & (crypto_blkcipher_blocksize(desc->desc.tfm) - 1);
323         thislen -= fraglen;
324
325         if (thislen == 0)
326                 return 0;
327
328         sg_mark_end(&desc->frags[desc->fragno - 1]);
329
330         ret = crypto_blkcipher_decrypt_iv(&desc->desc, desc->frags,
331                                           desc->frags, thislen);
332         if (ret)
333                 return ret;
334
335         sg_init_table(desc->frags, 4);
336
337         if (fraglen) {
338                 sg_set_page(&desc->frags[0], sg_page(sg), fraglen,
339                                 sg->offset + sg->length - fraglen);
340                 desc->fragno = 1;
341                 desc->fraglen = fraglen;
342         } else {
343                 desc->fragno = 0;
344                 desc->fraglen = 0;
345         }
346         return 0;
347 }
348
349 int
350 gss_decrypt_xdr_buf(struct crypto_blkcipher *tfm, struct xdr_buf *buf,
351                     int offset)
352 {
353         struct decryptor_desc desc;
354
355         /* XXXJBF: */
356         BUG_ON((buf->len - offset) % crypto_blkcipher_blocksize(tfm) != 0);
357
358         memset(desc.iv, 0, sizeof(desc.iv));
359         desc.desc.tfm = tfm;
360         desc.desc.info = desc.iv;
361         desc.desc.flags = 0;
362         desc.fragno = 0;
363         desc.fraglen = 0;
364
365         sg_init_table(desc.frags, 4);
366
367         return xdr_process_buf(buf, offset, buf->len - offset, decryptor, &desc);
368 }
369
370 /*
371  * This function makes the assumption that it was ultimately called
372  * from gss_wrap().
373  *
374  * The client auth_gss code moves any existing tail data into a
375  * separate page before calling gss_wrap.
376  * The server svcauth_gss code ensures that both the head and the
377  * tail have slack space of RPC_MAX_AUTH_SIZE before calling gss_wrap.
378  *
379  * Even with that guarantee, this function may be called more than
380  * once in the processing of gss_wrap().  The best we can do is
381  * verify at compile-time (see GSS_KRB5_SLACK_CHECK) that the
382  * largest expected shift will fit within RPC_MAX_AUTH_SIZE.
383  * At run-time we can verify that a single invocation of this
384  * function doesn't attempt to use more the RPC_MAX_AUTH_SIZE.
385  */
386
387 int
388 xdr_extend_head(struct xdr_buf *buf, unsigned int base, unsigned int shiftlen)
389 {
390         u8 *p;
391
392         if (shiftlen == 0)
393                 return 0;
394
395         BUILD_BUG_ON(GSS_KRB5_MAX_SLACK_NEEDED > RPC_MAX_AUTH_SIZE);
396         BUG_ON(shiftlen > RPC_MAX_AUTH_SIZE);
397
398         p = buf->head[0].iov_base + base;
399
400         memmove(p + shiftlen, p, buf->head[0].iov_len - base);
401
402         buf->head[0].iov_len += shiftlen;
403         buf->len += shiftlen;
404
405         return 0;
406 }