Skip to content

Commit 43c3039

Browse files
agentzhagentzh
committed
feature: added the set_base32_alphabet config directive to allow the user to specify the alphabet used for base32 encoding/decoding. thanks Vladislav Manchev for the patch in openresty#20.
1 parent 6d5b48f commit 43c3039

File tree

7 files changed

+757
-59
lines changed

7 files changed

+757
-59
lines changed

‎README.markdown‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Table of Contents
2626
* [set_hashed_upstream](#set_hashed_upstream)
2727
* [set_encode_base32](#set_encode_base32)
2828
* [set_misc_base32_padding](#set_misc_base32_padding)
29+
* [set_base32_alphabet](#set_base32_alphabet)
2930
* [set_decode_base32](#set_decode_base32)
3031
* [set_encode_base64](#set_encode_base64)
3132
* [set_decode_base64](#set_decode_base64)
@@ -503,7 +504,7 @@ Then request `GET /test` will yield the following output
503504

504505
Please note that we're using [echo-nginx-module](https://github.com/openresty/echo-nginx-module)'s [echo directive](https://github.com/openresty/echo-nginx-module#echo) here to output values of nginx variables directly.
505506

506-
RFC forces the `[A-Z2-7]` RFC-3548 compliant encoding, but we're using the "base32hex" encoding (`[0-9a-v]`).
507+
RFC forces the `[A-Z2-7]` RFC-3548 compliant encoding, but we are using the "base32hex" encoding (`[0-9a-v]`) by default. The [set_base32_alphabet](#set_base32_alphabet) directive (first introduced in `v0.28`) allows you to change the alphabet used for encoding/decoding so RFC-3548 compliant encoding is still possible by custom configurations.
507508

508509
By default, the `=` character is used to pad the left-over bytes due to alignment. But the padding behavior can be completely disabled by setting [set_misc_base32_padding](#set_misc_base32_padding) `off`.
509510

@@ -539,6 +540,24 @@ This directive can control whether to pad left-over bytes with the "=" character
539540

540541
[Back to TOC](#table-of-contents)
541542

543+
set_base32_alphabet
544+
-------------------
545+
**syntax:** *set_base32_alphabet <alphabet>*
546+
547+
**default:** *"0123456789abcdefghijklmnopqrstuv"*
548+
549+
**context:** *http, server, server if, location, location if*
550+
551+
**phase:** *no*
552+
553+
This directive controls the alphabet used for encoding/decoding a base32 digest. It accepts a string containing the desired alphabet like "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567" for standard alphabet.
554+
555+
Extended (base32hex) alphabet is used by default.
556+
557+
This directive was first introduced in `v0.28`.
558+
559+
[Back to TOC](#table-of-contents)
560+
542561
set_decode_base32
543562
-----------------
544563
**syntax:** *set_decode_base32 $dst <src>*

‎doc/HttpSetMiscModule.wiki‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ c5h66p35
411411
412412
Please note that we're using [[HttpEchoModule]]'s [[HttpEchoModule#echo|echo directive]] here to output values of nginx variables directly.
413413
414-
RFC forces the <code>[A-Z2-7]</code> RFC-3548 compliant encoding, but we're using the "base32hex" encoding (<code>[0-9a-v]</code>).
414+
RFC forces the <code>[A-Z2-7]</code> RFC-3548 compliant encoding, but we are using the "base32hex" encoding (<code>[0-9a-v]</code>) by default. The [[#set_base32_alphabet|set_base32_alphabet]] directive (first introduced in <code>v0.28</code>) allows you to change the alphabet used for encoding/decoding so RFC-3548 compliant encoding is still possible by custom configurations.
415415
416416
By default, the <code>=</code> character is used to pad the left-over bytes due to alignment. But the padding behavior can be completely disabled by setting [[#set_misc_base32_padding|set_misc_base32_padding]] <code>off</code>.
417417
@@ -441,6 +441,21 @@ This directive can be invoked by [[HttpLuaModule]]'s [[HttpLuaModule#ndk.set_var
441441
442442
This directive can control whether to pad left-over bytes with the "=" character when encoding a base32 digest by the [[#set_encode_base32|set_encode_base32]] directive.
443443
444+
== set_base32_alphabet ==
445+
'''syntax:''' ''set_base32_alphabet <alphabet>''
446+
447+
'''default:''' ''"0123456789abcdefghijklmnopqrstuv"''
448+
449+
'''context:''' ''http, server, server if, location, location if''
450+
451+
'''phase:''' ''no''
452+
453+
This directive controls the alphabet used for encoding/decoding a base32 digest. It accepts a string containing the desired alphabet like "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567" for standard alphabet.
454+
455+
Extended (base32hex) alphabet is used by default.
456+
457+
This directive was first introduced in <code>v0.28</code>.
458+
444459
== set_decode_base32 ==
445460
'''syntax:''' ''set_decode_base32 $dst <src>''
446461

‎src/ngx_http_set_base32.c‎

Lines changed: 14 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515

1616

1717
static void encode_base32(size_t slen, u_char *src, size_t *dlen, u_char *dst,
18-
ngx_flag_t padding);
19-
static int decode_base32(size_t slen, u_char *src, size_t *dlen, u_char *dst);
18+
ngx_flag_t padding, ngx_str_t *alphabet);
19+
static int decode_base32(size_t slen, u_char *src, size_t *dlen, u_char *dst,
20+
u_char *basis32);
2021

2122

2223
ngx_int_t
@@ -42,7 +43,8 @@ ngx_http_set_misc_encode_base32(ngx_http_request_t *r, ngx_str_t *res,
4243

4344
src = v->data; dst = p;
4445

45-
encode_base32(v->len, src, &len, dst, conf->base32_padding);
46+
encode_base32(v->len, src, &len, dst, conf->base32_padding,
47+
&conf->base32_alphabet);
4648

4749
res->data = p;
4850
res->len = len;
@@ -62,6 +64,10 @@ ngx_http_set_misc_decode_base32(ngx_http_request_t *r, ngx_str_t *res,
6264
u_char *src, *dst;
6365
int ret;
6466

67+
ngx_http_set_misc_loc_conf_t *conf;
68+
69+
conf = ngx_http_get_module_loc_conf(r, ngx_http_set_misc_module);
70+
6571
len = base32_decoded_length(v->len);
6672

6773
dd("estimated dst len: %d", (int) len);
@@ -73,7 +79,7 @@ ngx_http_set_misc_decode_base32(ngx_http_request_t *r, ngx_str_t *res,
7379

7480
src = v->data; dst = p;
7581

76-
ret = decode_base32(v->len, src, &len, dst);
82+
ret = decode_base32(v->len, src, &len, dst, conf->basis32);
7783

7884
if (ret == 0 /* OK */) {
7985
res->data = p;
@@ -96,9 +102,9 @@ ngx_http_set_misc_decode_base32(ngx_http_request_t *r, ngx_str_t *res,
96102

97103
static void
98104
encode_base32(size_t slen, u_char *src, size_t *dlen, u_char *dst,
99-
ngx_flag_t padding)
105+
ngx_flag_t padding, ngx_str_t *alphabet)
100106
{
101-
static unsigned char basis32[] = "0123456789abcdefghijklmnopqrstuv";
107+
unsigned char *basis32 = alphabet->data;
102108

103109
size_t len;
104110
u_char *s;
@@ -187,58 +193,9 @@ encode_base32(size_t slen, u_char *src, size_t *dlen, u_char *dst,
187193

188194

189195
static int
190-
decode_base32(size_t slen, u_char *src, size_t *dlen, u_char *dst)
196+
decode_base32(size_t slen, u_char *src, size_t *dlen, u_char *dst,
197+
u_char *basis32)
191198
{
192-
static unsigned char basis32[] = {
193-
/* 0 - 15 */
194-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
195-
196-
/* 16 - 31 */
197-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
198-
199-
/* 32 - 47 */
200-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
201-
202-
/* 48 - 63 */
203-
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 77, 77, 77, 77, 77, 77,
204-
205-
/* 64 - 79 */
206-
77, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
207-
208-
/* 80 - 95 */
209-
25, 26, 27, 28, 29, 30, 31, 77, 77, 77, 77, 77, 77, 77, 77, 77,
210-
211-
/* 96 - 111 */
212-
77, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
213-
214-
/* 112 - 127 */
215-
25, 26, 27, 28, 29, 30, 31, 77, 77, 77, 77, 77, 77, 77, 77, 77,
216-
217-
/* 128 - 143 */
218-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
219-
220-
/* 144 - 159 */
221-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
222-
223-
/* 160 - 175 */
224-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
225-
226-
/* 176 - 191 */
227-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
228-
229-
/* 192 - 207 */
230-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
231-
232-
/* 208 - 223 */
233-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
234-
235-
/* 224 - 239 */
236-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77,
237-
238-
/* 240 - 255 */
239-
77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77
240-
};
241-
242199
size_t len, mod;
243200
u_char *s = src;
244201
u_char *d = dst;

‎src/ngx_http_set_misc_module.c‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,15 @@ static ngx_command_t ngx_http_set_misc_commands[] = {
333333
offsetof(ngx_http_set_misc_loc_conf_t, base32_padding),
334334
NULL
335335
},
336+
{
337+
ngx_string("set_base32_alphabet"),
338+
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_SIF_CONF
339+
|NGX_HTTP_LOC_CONF|NGX_HTTP_LIF_CONF|NGX_CONF_TAKE1,
340+
ngx_conf_set_str_slot,
341+
NGX_HTTP_LOC_CONF_OFFSET,
342+
offsetof(ngx_http_set_misc_loc_conf_t, base32_alphabet),
343+
NULL
344+
},
336345
{
337346
ngx_string("set_encode_base32"),
338347
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_SIF_CONF
@@ -457,6 +466,8 @@ ngx_http_set_misc_create_loc_conf(ngx_conf_t *cf)
457466
}
458467

459468
conf->base32_padding = NGX_CONF_UNSET;
469+
conf->base32_alphabet.data = NULL;
470+
conf->base32_alphabet.len = 0;
460471
conf->current = NGX_CONF_UNSET;
461472

462473
return conf;
@@ -466,13 +477,22 @@ ngx_http_set_misc_create_loc_conf(ngx_conf_t *cf)
466477
char *
467478
ngx_http_set_misc_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
468479
{
480+
ngx_uint_t i;
481+
469482
ngx_http_set_misc_loc_conf_t *prev = parent;
470483
ngx_http_set_misc_loc_conf_t *conf = child;
471484

472485
ngx_conf_merge_value(conf->base32_padding, prev->base32_padding, 1);
473486

487+
ngx_conf_merge_str_value(conf->base32_alphabet, prev->base32_alphabet,
488+
"0123456789abcdefghijklmnopqrstuv");
489+
474490
ngx_conf_merge_value(conf->current, prev->current, NGX_CONF_UNSET);
475491

492+
for (i = 0; i < 32; i++) {
493+
conf->basis32[conf->base32_alphabet.data[i]] = i;
494+
}
495+
476496
return NGX_CONF_OK;
477497
}
478498

‎src/ngx_http_set_misc_module.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
typedef struct {
66
ngx_flag_t base32_padding;
7+
ngx_str_t base32_alphabet;
8+
u_char basis32[256];
79
ngx_int_t current; /* for set_rotate */
810
} ngx_http_set_misc_loc_conf_t;
911

0 commit comments

Comments
 (0)