source: openpam/trunk/lib/liboath/oath_base32.c @ 770

Last change on this file since 770 was 770, checked in by Dag-Erling Smørgrav, 7 years ago

Fix base{32,64}_decode(). The former handled padding incorrectly; the
latter was derived from the former, and had a couple of copy-paste bugs
in addition to the padding bug.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 5.5 KB
Line 
1/*-
2 * Copyright (c) 2013-2014 Universitetet i Oslo
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote
14 *    products derived from this software without specific prior written
15 *    permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $Id: oath_base32.c 770 2014-03-06 12:35:47Z des $
30 */
31
32#ifdef HAVE_CONFIG_H
33# include "config.h"
34#endif
35
36#include <sys/types.h>
37
38#include <errno.h>
39#include <stdint.h>
40
41#include <security/oath.h>
42
43static const char b32[] =
44    "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
45
46/*
47 * Encode data in RFC 3548 base 32 representation.  The target buffer must
48 * have room for base32_enclen(len) characters and a terminating NUL.
49 */
50int
51base32_enc(const uint8_t *in, size_t ilen, char *out, size_t *olen)
52{
53        uint64_t bits;
54
55        if (*olen <= base32_enclen(ilen))
56                return (-1);
57        *olen = 0;
58        while (ilen >= 5) {
59                bits = 0;
60                bits |= (uint64_t)in[0] << 32;
61                bits |= (uint64_t)in[1] << 24;
62                bits |= (uint64_t)in[2] << 16;
63                bits |= (uint64_t)in[3] << 8;
64                bits |= (uint64_t)in[4];
65                ilen -= 5;
66                in += 5;
67                out[0] = b32[bits >> 35 & 0x1f];
68                out[1] = b32[bits >> 30 & 0x1f];
69                out[2] = b32[bits >> 25 & 0x1f];
70                out[3] = b32[bits >> 20 & 0x1f];
71                out[4] = b32[bits >> 15 & 0x1f];
72                out[5] = b32[bits >> 10 & 0x1f];
73                out[6] = b32[bits >> 5 & 0x1f];
74                out[7] = b32[bits & 0x1f];
75                *olen += 8;
76                out += 8;
77        }
78        if (ilen > 0) {
79                bits = 0;
80                switch (ilen) {
81                case 4:
82                        bits |= (uint64_t)in[3] << 8;
83                case 3:
84                        bits |= (uint64_t)in[2] << 16;
85                case 2:
86                        bits |= (uint64_t)in[1] << 24;
87                case 1:
88                        bits |= (uint64_t)in[0] << 32;
89                }
90                out[0] = b32[bits >> 35 & 0x1f];
91                out[1] = b32[bits >> 30 & 0x1f];
92                out[2] = ilen > 1 ? b32[bits >> 25 & 0x1f] : '=';
93                out[3] = ilen > 1 ? b32[bits >> 20 & 0x1f] : '=';
94                out[4] = ilen > 2 ? b32[bits >> 15 & 0x1f] : '=';
95                out[5] = ilen > 3 ? b32[bits >> 10 & 0x1f] : '=';
96                out[6] = ilen > 3 ? b32[bits >> 5 & 0x1f] : '=';
97                out[7] = '=';
98                *olen += 8;
99                out += 8;
100        }
101        out[0] = '\0';
102        ++*olen;
103        return (0);
104}
105
106/*
107 * Decode data in RFC 2548 base 32 representation, stopping at the
108 * terminating NUL, the first invalid (non-base32, non-whitespace)
109 * character or after len characters, whichever comes first.
110 *
111 * The olen argument is used by the caller to pass the size of the buffer
112 * and by base32_dec() to return the amount of data successfully decoded.
113 * If the buffer is too small, base32_dec() discards the excess data, but
114 * returns the total amount.
115 */
116int
117base32_dec(const char *in, size_t ilen, uint8_t *out, size_t *olen)
118{
119        size_t len;
120        uint64_t bits;
121        int shift;
122
123        for (len = 0, bits = 0, shift = 40; ilen && *in && *in != '='; --ilen, ++in) {
124                if (*in == ' ' || *in == '\t' || *in == '\r' || *in == '\n') {
125                        continue;
126                } else if (*in >= 'A' && *in <= 'Z') {
127                        shift -= 5;
128                        bits |= (uint64_t)(*in - 'A') << shift;
129                } else if (*in >= 'a' && *in <= 'z') {
130                        shift -= 5;
131                        bits |= (uint64_t)(*in - 'a') << shift;
132                } else if (*in >= '2' && *in <= '7') { 
133                        shift -= 5;
134                        bits |= (uint64_t)(*in - '2' + 26) << shift;
135                } else if (*in == '=') {
136                        /* handled below */
137                        break;
138                } else {
139                        goto bad;
140                }
141                if (shift == 0) {
142                        if ((len += 5) <= *olen) {
143                                *out++ = (bits >> 32) & 0xff;
144                                *out++ = (bits >> 24) & 0xff;
145                                *out++ = (bits >> 16) & 0xff;
146                                *out++ = (bits >> 8) & 0xff;
147                                *out++ = bits & 0xff;
148                        }
149                        bits = 0;
150                        shift = 40;
151                }
152        }
153        if (ilen && *in == '=' &&
154            (shift == 30 || shift == 20 || shift == 15 || shift == 5)) {
155                /*
156                 * Padding:
157                 *
158                 * 00            8 AA====== 30
159                 * 00 00        16 AAAA==== 20
160                 * 00 00 00     24 AAAAA=== 15
161                 * 00 00 00 00  32 AAAAAAA= 5
162                 *
163                 * XXX We should check that the last few bits before the
164                 * padding starts are zero.
165                 */
166                switch (shift) {
167                case 5:
168                        if (++len <= *olen)
169                                *out++ = (bits >> 32) & 0xff;
170                        bits <<= 8;
171                case 15:
172                        if (++len <= *olen)
173                                *out++ = (bits >> 32) & 0xff;
174                        bits <<= 8;
175                case 20:
176                        if (++len <= *olen)
177                                *out++ = (bits >> 32) & 0xff;
178                        bits <<= 8;
179                case 30:
180                        if (++len <= *olen)
181                                *out++ = (bits >> 32) & 0xff;
182                        bits <<= 8;
183                        break;
184                default:
185                        goto bad;
186                }
187                /* consume remaining padding and whitespace */
188                for (; ilen && *in; --ilen, ++in) {
189                        if (*in == ' ' || *in == '\t' || *in == '\r' || *in == '\n')
190                                continue;
191                        else if (*in == '=' && shift)
192                                shift -= 5;
193                        else
194                                goto bad;
195                }
196        }
197        if (ilen)
198                goto bad;
199        *olen = len;
200        if (len > *olen)
201                return (-1);
202        return (0);
203bad:
204        *olen = 0;
205        return (-1);
206}
Note: See TracBrowser for help on using the repository browser.