blob: d8b372b9cc11025355f71123ad436e7cb99679f3 [file] [log] [blame]
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +03001/* mpicoder.c - Coder for the external representation of MPIs
2 * Copyright (C) 1998, 1999 Free Software Foundation, Inc.
3 *
4 * This file is part of GnuPG.
5 *
6 * GnuPG is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * GnuPG is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19 */
20
David Howellse1045992012-09-24 17:11:27 +010021#include <linux/bitops.h>
Christoph Hellwiga1164a32015-08-28 09:27:15 +020022#include <linux/count_zeros.h>
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +030023#include "mpi-internal.h"
24
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +030025#define MAX_EXTERN_MPI_BITS 16384
26
David Howellse1045992012-09-24 17:11:27 +010027/**
28 * mpi_read_raw_data - Read a raw byte stream as a positive integer
29 * @xbuffer: The data to read
30 * @nbytes: The amount of data to read
31 */
32MPI mpi_read_raw_data(const void *xbuffer, size_t nbytes)
33{
34 const uint8_t *buffer = xbuffer;
35 int i, j;
36 unsigned nbits, nlimbs;
37 mpi_limb_t a;
38 MPI val = NULL;
39
Chen Gang5402b802013-06-12 14:04:40 -070040 while (nbytes > 0 && buffer[0] == 0) {
David Howellse1045992012-09-24 17:11:27 +010041 buffer++;
42 nbytes--;
43 }
44
45 nbits = nbytes * 8;
46 if (nbits > MAX_EXTERN_MPI_BITS) {
47 pr_info("MPI: mpi too large (%u bits)\n", nbits);
48 return NULL;
49 }
50 if (nbytes > 0)
51 nbits -= count_leading_zeros(buffer[0]);
52 else
53 nbits = 0;
54
Andy Shevchenko0d2a1b22013-01-30 11:30:06 +020055 nlimbs = DIV_ROUND_UP(nbytes, BYTES_PER_MPI_LIMB);
David Howellse1045992012-09-24 17:11:27 +010056 val = mpi_alloc(nlimbs);
57 if (!val)
58 return NULL;
59 val->nbits = nbits;
60 val->sign = 0;
61 val->nlimbs = nlimbs;
62
63 if (nbytes > 0) {
64 i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
65 i %= BYTES_PER_MPI_LIMB;
66 for (j = nlimbs; j > 0; j--) {
67 a = 0;
68 for (; i < BYTES_PER_MPI_LIMB; i++) {
69 a <<= 8;
70 a |= *buffer++;
71 }
72 i = 0;
73 val->d[j - 1] = a;
74 }
75 }
76 return val;
77}
78EXPORT_SYMBOL_GPL(mpi_read_raw_data);
79
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +030080MPI mpi_read_from_buffer(const void *xbuffer, unsigned *ret_nread)
81{
82 const uint8_t *buffer = xbuffer;
83 int i, j;
84 unsigned nbits, nbytes, nlimbs, nread = 0;
85 mpi_limb_t a;
Dmitry Kasatkin3cccd152012-01-26 19:13:16 +020086 MPI val = NULL;
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +030087
88 if (*ret_nread < 2)
89 goto leave;
90 nbits = buffer[0] << 8 | buffer[1];
91
92 if (nbits > MAX_EXTERN_MPI_BITS) {
93 pr_info("MPI: mpi too large (%u bits)\n", nbits);
94 goto leave;
95 }
96 buffer += 2;
97 nread = 2;
98
Andy Shevchenko0d2a1b22013-01-30 11:30:06 +020099 nbytes = DIV_ROUND_UP(nbits, 8);
100 nlimbs = DIV_ROUND_UP(nbytes, BYTES_PER_MPI_LIMB);
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300101 val = mpi_alloc(nlimbs);
102 if (!val)
Dmitry Kasatkin3cccd152012-01-26 19:13:16 +0200103 return NULL;
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300104 i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
105 i %= BYTES_PER_MPI_LIMB;
106 val->nbits = nbits;
107 j = val->nlimbs = nlimbs;
108 val->sign = 0;
109 for (; j > 0; j--) {
110 a = 0;
111 for (; i < BYTES_PER_MPI_LIMB; i++) {
112 if (++nread > *ret_nread) {
113 printk
114 ("MPI: mpi larger than buffer nread=%d ret_nread=%d\n",
115 nread, *ret_nread);
116 goto leave;
117 }
118 a <<= 8;
119 a |= *buffer++;
120 }
121 i = 0;
122 val->d[j - 1] = a;
123 }
124
125leave:
126 *ret_nread = nread;
127 return val;
128}
129EXPORT_SYMBOL_GPL(mpi_read_from_buffer);
130
Michal Marek3ee0cb52016-02-17 14:46:59 +0100131static int count_lzeros(MPI a)
132{
133 mpi_limb_t alimb;
134 int i, lzeros = 0;
135
136 for (i = a->nlimbs - 1; i >= 0; i--) {
137 alimb = a->d[i];
138 if (alimb == 0) {
139 lzeros += sizeof(mpi_limb_t);
140 } else {
141 lzeros += count_leading_zeros(alimb) / 8;
142 break;
143 }
144 }
145 return lzeros;
146}
147
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700148/**
149 * mpi_read_buffer() - read MPI to a bufer provided by user (msb first)
150 *
151 * @a: a multi precision integer
152 * @buf: bufer to which the output will be written to. Needs to be at
153 * leaset mpi_get_size(a) long.
154 * @buf_len: size of the buf.
Andrzej Zaborowski9cbe21d2015-11-13 12:01:32 +0100155 * @nbytes: receives the actual length of the data written on success and
156 * the data to-be-written on -EOVERFLOW in case buf_len was too
157 * small.
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700158 * @sign: if not NULL, it will be set to the sign of a.
159 *
160 * Return: 0 on success or error code in case of error
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300161 */
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700162int mpi_read_buffer(MPI a, uint8_t *buf, unsigned buf_len, unsigned *nbytes,
163 int *sign)
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300164{
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700165 uint8_t *p;
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300166 mpi_limb_t alimb;
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700167 unsigned int n = mpi_get_size(a);
Michal Marek3ee0cb52016-02-17 14:46:59 +0100168 int i, lzeros;
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700169
Andrzej Zaborowski9cbe21d2015-11-13 12:01:32 +0100170 if (!buf || !nbytes)
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700171 return -EINVAL;
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300172
173 if (sign)
174 *sign = a->sign;
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700175
Michal Marek3ee0cb52016-02-17 14:46:59 +0100176 lzeros = count_lzeros(a);
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700177
Andrzej Zaborowski9cbe21d2015-11-13 12:01:32 +0100178 if (buf_len < n - lzeros) {
179 *nbytes = n - lzeros;
180 return -EOVERFLOW;
181 }
182
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700183 p = buf;
Tadeusz Struk0f74fbf2015-08-24 07:52:14 -0700184 *nbytes = n - lzeros;
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300185
186 for (i = a->nlimbs - 1; i >= 0; i--) {
187 alimb = a->d[i];
188#if BYTES_PER_MPI_LIMB == 4
189 *p++ = alimb >> 24;
190 *p++ = alimb >> 16;
191 *p++ = alimb >> 8;
192 *p++ = alimb;
193#elif BYTES_PER_MPI_LIMB == 8
194 *p++ = alimb >> 56;
195 *p++ = alimb >> 48;
196 *p++ = alimb >> 40;
197 *p++ = alimb >> 32;
198 *p++ = alimb >> 24;
199 *p++ = alimb >> 16;
200 *p++ = alimb >> 8;
201 *p++ = alimb;
202#else
203#error please implement for this limb size.
204#endif
Tadeusz Struk0f74fbf2015-08-24 07:52:14 -0700205
206 if (lzeros > 0) {
207 if (lzeros >= sizeof(alimb)) {
208 p -= sizeof(alimb);
209 } else {
210 mpi_limb_t *limb1 = (void *)p - sizeof(alimb);
211 mpi_limb_t *limb2 = (void *)p - sizeof(alimb)
212 + lzeros;
213 *limb1 = *limb2;
214 p -= lzeros;
215 }
216 lzeros -= sizeof(alimb);
217 }
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300218 }
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700219 return 0;
220}
221EXPORT_SYMBOL_GPL(mpi_read_buffer);
222
223/*
224 * mpi_get_buffer() - Returns an allocated buffer with the MPI (msb first).
225 * Caller must free the return string.
226 * This function does return a 0 byte buffer with nbytes set to zero if the
227 * value of A is zero.
228 *
229 * @a: a multi precision integer.
230 * @nbytes: receives the length of this buffer.
231 * @sign: if not NULL, it will be set to the sign of the a.
232 *
233 * Return: Pointer to MPI buffer or NULL on error
234 */
235void *mpi_get_buffer(MPI a, unsigned *nbytes, int *sign)
236{
Tadeusz Struk0f74fbf2015-08-24 07:52:14 -0700237 uint8_t *buf;
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700238 unsigned int n;
239 int ret;
240
241 if (!nbytes)
242 return NULL;
243
244 n = mpi_get_size(a);
245
246 if (!n)
247 n++;
248
249 buf = kmalloc(n, GFP_KERNEL);
250
251 if (!buf)
252 return NULL;
253
254 ret = mpi_read_buffer(a, buf, n, nbytes, sign);
255
256 if (ret) {
257 kfree(buf);
258 return NULL;
259 }
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700260 return buf;
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300261}
262EXPORT_SYMBOL_GPL(mpi_get_buffer);
263
264/****************
265 * Use BUFFER to update MPI.
266 */
267int mpi_set_buffer(MPI a, const void *xbuffer, unsigned nbytes, int sign)
268{
269 const uint8_t *buffer = xbuffer, *p;
270 mpi_limb_t alimb;
271 int nlimbs;
272 int i;
273
Andy Shevchenko0d2a1b22013-01-30 11:30:06 +0200274 nlimbs = DIV_ROUND_UP(nbytes, BYTES_PER_MPI_LIMB);
Dmitry Kasatkincdec9cb2011-08-31 14:05:16 +0300275 if (RESIZE_IF_NEEDED(a, nlimbs) < 0)
276 return -ENOMEM;
277 a->sign = sign;
278
279 for (i = 0, p = buffer + nbytes - 1; p >= buffer + BYTES_PER_MPI_LIMB;) {
280#if BYTES_PER_MPI_LIMB == 4
281 alimb = (mpi_limb_t) *p--;
282 alimb |= (mpi_limb_t) *p-- << 8;
283 alimb |= (mpi_limb_t) *p-- << 16;
284 alimb |= (mpi_limb_t) *p-- << 24;
285#elif BYTES_PER_MPI_LIMB == 8
286 alimb = (mpi_limb_t) *p--;
287 alimb |= (mpi_limb_t) *p-- << 8;
288 alimb |= (mpi_limb_t) *p-- << 16;
289 alimb |= (mpi_limb_t) *p-- << 24;
290 alimb |= (mpi_limb_t) *p-- << 32;
291 alimb |= (mpi_limb_t) *p-- << 40;
292 alimb |= (mpi_limb_t) *p-- << 48;
293 alimb |= (mpi_limb_t) *p-- << 56;
294#else
295#error please implement for this limb size.
296#endif
297 a->d[i++] = alimb;
298 }
299 if (p >= buffer) {
300#if BYTES_PER_MPI_LIMB == 4
301 alimb = *p--;
302 if (p >= buffer)
303 alimb |= (mpi_limb_t) *p-- << 8;
304 if (p >= buffer)
305 alimb |= (mpi_limb_t) *p-- << 16;
306 if (p >= buffer)
307 alimb |= (mpi_limb_t) *p-- << 24;
308#elif BYTES_PER_MPI_LIMB == 8
309 alimb = (mpi_limb_t) *p--;
310 if (p >= buffer)
311 alimb |= (mpi_limb_t) *p-- << 8;
312 if (p >= buffer)
313 alimb |= (mpi_limb_t) *p-- << 16;
314 if (p >= buffer)
315 alimb |= (mpi_limb_t) *p-- << 24;
316 if (p >= buffer)
317 alimb |= (mpi_limb_t) *p-- << 32;
318 if (p >= buffer)
319 alimb |= (mpi_limb_t) *p-- << 40;
320 if (p >= buffer)
321 alimb |= (mpi_limb_t) *p-- << 48;
322 if (p >= buffer)
323 alimb |= (mpi_limb_t) *p-- << 56;
324#else
325#error please implement for this limb size.
326#endif
327 a->d[i++] = alimb;
328 }
329 a->nlimbs = i;
330
331 if (i != nlimbs) {
332 pr_emerg("MPI: mpi_set_buffer: Assertion failed (%d != %d)", i,
333 nlimbs);
334 BUG();
335 }
336 return 0;
337}
338EXPORT_SYMBOL_GPL(mpi_set_buffer);
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700339
340/**
341 * mpi_write_to_sgl() - Funnction exports MPI to an sgl (msb first)
342 *
343 * This function works in the same way as the mpi_read_buffer, but it
344 * takes an sgl instead of u8 * buf.
345 *
346 * @a: a multi precision integer
347 * @sgl: scatterlist to write to. Needs to be at least
348 * mpi_get_size(a) long.
349 * @nbytes: in/out param - it has the be set to the maximum number of
350 * bytes that can be written to sgl. This has to be at least
351 * the size of the integer a. On return it receives the actual
Andrzej Zaborowski9cbe21d2015-11-13 12:01:32 +0100352 * length of the data written on success or the data that would
353 * be written if buffer was too small.
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700354 * @sign: if not NULL, it will be set to the sign of a.
355 *
356 * Return: 0 on success or error code in case of error
357 */
358int mpi_write_to_sgl(MPI a, struct scatterlist *sgl, unsigned *nbytes,
359 int *sign)
360{
361 u8 *p, *p2;
362 mpi_limb_t alimb, alimb2;
363 unsigned int n = mpi_get_size(a);
Michal Marek3ee0cb52016-02-17 14:46:59 +0100364 int i, x, y = 0, lzeros, buf_len;
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700365
Andrzej Zaborowski9cbe21d2015-11-13 12:01:32 +0100366 if (!nbytes)
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700367 return -EINVAL;
368
369 if (sign)
370 *sign = a->sign;
371
Michal Marek3ee0cb52016-02-17 14:46:59 +0100372 lzeros = count_lzeros(a);
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700373
Andrzej Zaborowski9cbe21d2015-11-13 12:01:32 +0100374 if (*nbytes < n - lzeros) {
375 *nbytes = n - lzeros;
376 return -EOVERFLOW;
377 }
378
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700379 *nbytes = n - lzeros;
380 buf_len = sgl->length;
381 p2 = sg_virt(sgl);
382
Nicolai Stangef2d13622016-03-22 13:12:35 +0100383 for (i = a->nlimbs - 1 - lzeros / BYTES_PER_MPI_LIMB,
384 lzeros %= BYTES_PER_MPI_LIMB;
385 i >= 0; i--) {
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700386 alimb = a->d[i];
387 p = (u8 *)&alimb2;
388#if BYTES_PER_MPI_LIMB == 4
389 *p++ = alimb >> 24;
390 *p++ = alimb >> 16;
391 *p++ = alimb >> 8;
392 *p++ = alimb;
393#elif BYTES_PER_MPI_LIMB == 8
394 *p++ = alimb >> 56;
395 *p++ = alimb >> 48;
396 *p++ = alimb >> 40;
397 *p++ = alimb >> 32;
398 *p++ = alimb >> 24;
399 *p++ = alimb >> 16;
400 *p++ = alimb >> 8;
401 *p++ = alimb;
402#else
403#error please implement for this limb size.
404#endif
Nicolai Stange654842e2016-03-22 13:12:36 +0100405 if (lzeros) {
Nicolai Stangef2d13622016-03-22 13:12:35 +0100406 mpi_limb_t *limb1 = (void *)p - sizeof(alimb);
407 mpi_limb_t *limb2 = (void *)p - sizeof(alimb)
408 + lzeros;
409 *limb1 = *limb2;
410 p -= lzeros;
411 y = lzeros;
Nicolai Stange654842e2016-03-22 13:12:36 +0100412 lzeros = 0;
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700413 }
414
415 p = p - (sizeof(alimb) - y);
416
417 for (x = 0; x < sizeof(alimb) - y; x++) {
418 if (!buf_len) {
419 sgl = sg_next(sgl);
420 if (!sgl)
421 return -EINVAL;
422 buf_len = sgl->length;
423 p2 = sg_virt(sgl);
424 }
425 *p2++ = *p++;
426 buf_len--;
427 }
428 y = 0;
429 }
430 return 0;
431}
432EXPORT_SYMBOL_GPL(mpi_write_to_sgl);
433
434/*
435 * mpi_read_raw_from_sgl() - Function allocates an MPI and populates it with
436 * data from the sgl
437 *
438 * This function works in the same way as the mpi_read_raw_data, but it
439 * takes an sgl instead of void * buffer. i.e. it allocates
440 * a new MPI and reads the content of the sgl to the MPI.
441 *
442 * @sgl: scatterlist to read from
443 * @len: number of bytes to read
444 *
445 * Return: Pointer to a new MPI or NULL on error
446 */
447MPI mpi_read_raw_from_sgl(struct scatterlist *sgl, unsigned int len)
448{
449 struct scatterlist *sg;
450 int x, i, j, z, lzeros, ents;
451 unsigned int nbits, nlimbs, nbytes;
452 mpi_limb_t a;
453 MPI val = NULL;
454
455 lzeros = 0;
456 ents = sg_nents(sgl);
457
458 for_each_sg(sgl, sg, ents, i) {
459 const u8 *buff = sg_virt(sg);
460 int len = sg->length;
461
Stephan Mueller63349d02015-10-18 12:45:18 +0200462 while (len && !*buff) {
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700463 lzeros++;
Stephan Mueller63349d02015-10-18 12:45:18 +0200464 len--;
465 buff++;
466 }
Tadeusz Struk2d4d1ee2015-10-08 09:26:50 -0700467
468 if (len && *buff)
469 break;
470
471 ents--;
472 lzeros = 0;
473 }
474
475 sgl = sg;
476
477 if (!ents)
478 nbytes = 0;
479 else
480 nbytes = len - lzeros;
481
482 nbits = nbytes * 8;
483 if (nbits > MAX_EXTERN_MPI_BITS) {
484 pr_info("MPI: mpi too large (%u bits)\n", nbits);
485 return NULL;
486 }
487
488 if (nbytes > 0)
489 nbits -= count_leading_zeros(*(u8 *)(sg_virt(sgl) + lzeros));
490 else
491 nbits = 0;
492
493 nlimbs = DIV_ROUND_UP(nbytes, BYTES_PER_MPI_LIMB);
494 val = mpi_alloc(nlimbs);
495 if (!val)
496 return NULL;
497
498 val->nbits = nbits;
499 val->sign = 0;
500 val->nlimbs = nlimbs;
501
502 if (nbytes == 0)
503 return val;
504
505 j = nlimbs - 1;
506 a = 0;
507 z = 0;
508 x = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
509 x %= BYTES_PER_MPI_LIMB;
510
511 for_each_sg(sgl, sg, ents, i) {
512 const u8 *buffer = sg_virt(sg) + lzeros;
513 int len = sg->length - lzeros;
514 int buf_shift = x;
515
516 if (sg_is_last(sg) && (len % BYTES_PER_MPI_LIMB))
517 len += BYTES_PER_MPI_LIMB - (len % BYTES_PER_MPI_LIMB);
518
519 for (; x < len + buf_shift; x++) {
520 a <<= 8;
521 a |= *buffer++;
522 if (((z + x + 1) % BYTES_PER_MPI_LIMB) == 0) {
523 val->d[j--] = a;
524 a = 0;
525 }
526 }
527 z += x;
528 x = 0;
529 lzeros = 0;
530 }
531 return val;
532}
533EXPORT_SYMBOL_GPL(mpi_read_raw_from_sgl);