1#!/usr/bin/perl
2# Exercise base{32,64}.
3
4# Copyright (C) 2006-2023 Free Software Foundation, Inc.
5
6# This program 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 3 of the License, or
9# (at your option) any later version.
10
11# This program 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, see <https://www.gnu.org/licenses/>.
18
19use strict;
20
21(my $program_name = $0) =~ s|.*/||;
22
23# Turn off localization of executable's output.
24@ENV{qw(LANGUAGE LANG LC_ALL)} = ('C') x 3;
25
26# Return the encoding of a string of N 'a's.
27sub enc64($)
28{
29  my ($n) = @_;
30  my %remainder = ( 0 => '', 1 => 'YQ==', 2 => 'YWE=' );
31  return 'YWFh' x ($n / 3) . $remainder{$n % 3};
32}
33
34sub enc32($)
35{
36  my ($n) = @_;
37  my %remainder = ( 0 => '', 1 => 'ME======', 2 => 'MFQQ====',
38                    3 => 'MFQWC===', 4 => 'MFQWCYI=');
39  return 'MFQWCYLB' x ($n / 5) . $remainder{$n % 5};
40}
41
42# Function reference to appropriate encoder
43my $enc;
44
45# An encoded string of length 4KB, using 3K "a"s.
46my $a3k;
47my @a3k_nl;
48
49# Return a copy of S, with newlines inserted every WIDTH bytes.
50# Ensure that the result (if not the empty string) is newline-terminated.
51sub wrap($$)
52{
53  my ($s, $width) = @_;
54  $s =~ s/(.{$width})/$1\n/g;
55  substr ($s, -1, 1) ne "\n"
56    and $s .= "\n";
57  return $s;
58}
59
60my @Tests;
61
62sub gen_tests($)
63{
64  my ($prog) = @_;
65  my $try_help = "Try '$prog --help' for more information.\n";
66  @Tests=
67    (
68     ['empty', {IN=>''}, {OUT=>""}],
69     ['inout1', {IN=>'a'x1}, {OUT=>&$enc(1)."\n"}],
70     ['inout2', {IN=>'a'x2}, {OUT=>&$enc(2)."\n"}],
71     ['inout3', {IN=>'a'x3}, {OUT=>&$enc(3)."\n"}],
72     ['inout4', {IN=>'a'x4}, {OUT=>&$enc(4)."\n"}],
73     ['inout5', {IN=>'a'x5}, {OUT=>&$enc(5)."\n"}],
74     ['wrap', '--wrap 0', {IN=>'a'}, {OUT=>&$enc(1)}],
75     ['wrap-zero', '--wrap 08', {IN=>'a'}, {OUT=>&$enc(1)."\n"}],
76     ['wrap5-39', '--wrap=5', {IN=>'a' x 39}, {OUT=>wrap &$enc(39),5}],
77     ['wrap5-40', '--wrap=5', {IN=>'a' x 40}, {OUT=>wrap &$enc(40),5}],
78     ['wrap5-41', '--wrap=5', {IN=>'a' x 41}, {OUT=>wrap &$enc(41),5}],
79     ['wrap5-42', '--wrap=5', {IN=>'a' x 42}, {OUT=>wrap &$enc(42),5}],
80     ['wrap5-43', '--wrap=5', {IN=>'a' x 43}, {OUT=>wrap &$enc(43),5}],
81     ['wrap5-44', '--wrap=5', {IN=>'a' x 44}, {OUT=>wrap &$enc(44),5}],
82     ['wrap5-45', '--wrap=5', {IN=>'a' x 45}, {OUT=>wrap &$enc(45),5}],
83     ['wrap5-46', '--wrap=5', {IN=>'a' x 46}, {OUT=>wrap &$enc(46),5}],
84
85     ['wrap-bad-1', '-w0x0', {IN=>''}, {OUT=>""},
86      {ERR_SUBST => 's/base..:/base..:/'},
87      {ERR => "base..: invalid wrap size: '0x0'\n"}, {EXIT => 1}],
88     ['wrap-bad-2', '-w1k', {IN=>''}, {OUT=>""},
89      {ERR_SUBST => 's/base..:/base..:/'},
90      {ERR => "base..: invalid wrap size: '1k'\n"}, {EXIT => 1}],
91     ['wrap-bad-3', '-w-1', {IN=>''}, {OUT=>""},
92      {ERR_SUBST => 's/base..:/base..:/'},
93      {ERR => "base..: invalid wrap size: '-1'\n"}, {EXIT => 1}],
94
95     ['buf-1',   '--decode', {IN=>&$enc(1)}, {OUT=>'a' x 1}],
96     ['buf-2',   '--decode', {IN=>&$enc(2)}, {OUT=>'a' x 2}],
97     ['buf-3',   '--decode', {IN=>&$enc(3)}, {OUT=>'a' x 3}],
98     ['buf-4',   '--decode', {IN=>&$enc(4)}, {OUT=>'a' x 4}],
99     # 4KB worth of input.
100     ['buf-4k0', '--decode', {IN=>&$enc(3072+0)}, {OUT=>'a' x (3072+0)}],
101     ['buf-4k1', '--decode', {IN=>&$enc(3072+1)}, {OUT=>'a' x (3072+1)}],
102     ['buf-4k2', '--decode', {IN=>&$enc(3072+2)}, {OUT=>'a' x (3072+2)}],
103     ['buf-4k3', '--decode', {IN=>&$enc(3072+3)}, {OUT=>'a' x (3072+3)}],
104     ['buf-4km1','--decode', {IN=>&$enc(3072-1)}, {OUT=>'a' x (3072-1)}],
105     ['buf-4km2','--decode', {IN=>&$enc(3072-2)}, {OUT=>'a' x (3072-2)}],
106     ['buf-4km3','--decode', {IN=>&$enc(3072-3)}, {OUT=>'a' x (3072-3)}],
107     ['buf-4km4','--decode', {IN=>&$enc(3072-4)}, {OUT=>'a' x (3072-4)}],
108
109     # Exercise the case in which the final base-64 byte is
110     # in a buffer all by itself.
111     ['b4k-1',   '--decode', {IN=>$a3k_nl[1]}, {OUT=>'a' x (3072+0)}],
112     ['b4k-2',   '--decode', {IN=>$a3k_nl[2]}, {OUT=>'a' x (3072+0)}],
113     ['b4k-3',   '--decode', {IN=>$a3k_nl[3]}, {OUT=>'a' x (3072+0)}],
114
115     ['ext-op1', 'a b',       {IN=>''}, {EXIT=>1},
116      {ERR => "$prog: extra operand 'b'\n" . $try_help}],
117     # Again, with more option arguments
118     ['ext-op2', '-di --wrap=40 a b',       {IN=>''}, {EXIT=>1},
119      {ERR => "$prog: extra operand 'b'\n" . $try_help}],
120    );
121
122  if ($prog eq "base64")
123    {
124        push @Tests, (
125          ['baddecode', '--decode', {IN=>'a'}, {OUT=>""},
126          {ERR_SUBST => 's/.*: invalid input//'}, {ERR => "\n"}, {EXIT => 1}],
127          ['paddecode2', '--decode', {IN=>'ab'}, {OUT=>"i"}],
128          ['paddecode3', '--decode', {IN=>'Zzz'}, {OUT=>"g<"}],
129          ['baddecode4', '--decode', {IN=>'Zz='}, {OUT=>"g"},
130          {ERR_SUBST => 's/.*: invalid input//'}, {ERR => "\n"}, {EXIT => 1}],
131          ['baddecode5', '--decode', {IN=>'Z==='}, {OUT=>""},
132          {ERR_SUBST => 's/.*: invalid input//'}, {ERR => "\n"}, {EXIT => 1}]
133        );
134    }
135
136  # For each non-failing test, create a --decode test using the
137  # expected output as input.  Also, add tests inserting newlines.
138  my @new;
139  foreach my $t (@Tests)
140  {
141      my $exit_val;
142      my $in;
143      my @out;
144
145      # If the test has a single option of "--decode", then skip it.
146      !ref $t->[1] && $t->[1] eq '--decode'
147      and next;
148
149      foreach my $e (@$t)
150      {
151          ref $e && ref $e eq 'HASH'
152          or next;
153          defined $e->{EXIT}
154          and $exit_val = $e->{EXIT};
155          defined $e->{IN}
156          and $in = $e->{IN};
157          if (defined $e->{OUT})
158          {
159              my $t = $e->{OUT};
160              push @out, $t;
161              my $len = length $t;
162              foreach my $i (0..$len)
163              {
164                  my $u = $t;
165                  substr ($u, $i, 0) = "\n";
166                  push @out, $u;
167                  10 <= $i
168                  and last;
169              }
170          }
171      }
172      $exit_val
173      and next;
174
175      my $i = 0;
176      foreach my $o (@out)
177      {
178          push @new, ["d$i-$t->[0]", '--decode', {IN => $o}, {OUT => $in}];
179          ++$i;
180      }
181  }
182  push @Tests, @new;
183}
184
185my $save_temps = $ENV{DEBUG};
186my $verbose = $ENV{VERBOSE};
187
188my $fail = 0;
189foreach my $prog (qw(base32 base64))
190  {
191    $enc = $prog eq "base32" ? \&enc32 : \&enc64;
192
193    # Construct an encoded string of length 4KB, using 3K "a"s.
194    $a3k = &$enc(3072);
195    @a3k_nl = ();
196    # A few copies, each with different number of newlines at the start.
197    for my $k (0..3)
198      {
199        (my $t = $a3k) =~ s/^/"\n"x $k/e;
200        push @a3k_nl, $t;
201      }
202
203    gen_tests($prog);
204
205    $fail = run_tests ($program_name, $prog, \@Tests, $save_temps, $verbose);
206    if ($fail != 0)
207      {
208        last;
209      }
210  }
211
212exit $fail;
213