1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
#!/bin/env perl
#
# Quick and dirty utility to help assemble the mandated (but otherwise
# useless) API documentation. We get the list of external function
# symbols from fipscanister.o, pair those with the source file names
# (from ./fips/fipssyms.h), and map to the object file name containing
# them.
#
# Requires the "nm" and "find" utilities.
# Execure from the root of the FIPS module source code workarea
use HTML::Entities;
use File::Basename;
$here = dirname($0);
require "$here/api_fns.pm";
$_direction_question = ''; # Set to '?' to show "<-?", "<->?" for uncertain directions
print STDERR "Info: finding FIPS renames and reimplementations of OpenSSL symbols\n";
# Get mapping of old (source code) to new (live as renamed) symbols
foreach $file ("./fips/fipssyms.h") {
open(IN, $file) || die "Error opening $file";
# grab pairs until assembler symbols
my $buf = '';
my $reimplementations = 1; # When 1, we're looking at reimplementations
# (not renames) of OpenSSL functions. They
# still have to be saved to get the API.
while (<IN>) {
$reimplementations = 0 if m|^\s*/\*\sRename\ssymbols\s|;
if ($buf) {
$_ = $buf . $_;
$buf = '';
}
if (s/\\\n$//) {
$buf = $_;
next;
}
if (m/\(/) {
($oldname, $newname) = m/#define\s+(\S+)\(.*\)\s+(\S+)\(.*\)/;
} else {
($oldname, $newname) = m/#define\s+(\S+)\s+(\S+)/;
}
$oldname || next;
if (!$reimplementations) {
$oldname{$newname} = $oldname;
}
$oldimpl{$newname} = $oldname;
last if (/assembler/)
}
close(IN);
# %oldname is the mapping of new function names to old
print "<!-- Total of ", scalar(keys %oldname), " mapped symbols in $file -->\n";
}
print STDERR "Info: finding FIPS symbols in object files\n";
# generate list of external function names in fipscanister.o
$file = "./fips/fipscanister.o";
for (`nm -g --defined-only -p -o $file`) {
chomp;
s/^\S+ T // || next;
m/^fips_/ && next;
$fipssyms{$_}++;
$objname =~ s/\.o$/\.\[o\|c\]/;
$objname{$symname} = $objname;
}
# keys %fipssyms is the list of module functions
print "<!-- Total of ", scalar(keys %fipssyms), " functions in $file -->\n";
# grab filename to symbol name mapping, each line is of the format
# ./fips/sha/fips_sha1_selftest.o:00000000 T FIPS_selftest_sha1
# discard the offset and type ":00000000 T".
for (`find . -name '*.o' \\! -name 'fipscanister.o' -exec nm -g --defined-only -p -o {} \\;`) {
($objname, $symname) = m/^(\S+):\S+\s+T+\s+(\S+)/;
$objname || next;
# $fipssyms{$symname} || next;
$objname =~ s/\.o$/\.\[o\|c\]/;
$objname{$symname} = $objname;
}
# %objname is the mapping of new symbol name to (source/object) file name
print "<!-- Total of ", scalar(keys %objname), " functions found in files -->\n";
print STDERR "Info: finding declarations in header files\n";
# grab filenames in include/openssl, run each of them through
# get_function_declarations_from_file (defined in api_fns.pl)
# and collect the result.
%declarations = ();
while (<include/openssl/*.h ./crypto/cryptlib.h>) {
my %decls = api_data::get_function_declaration_strings_from_file($_);
map { $declarations{$_} = $decls{$_} } keys %decls;
}
# %declarations is the mapping of old symbol name to their declaration
print "<!-- Total of ", scalar(keys %declarations), " declarations found in header files -->\n";
# Add the markers FIPS_text_start and FIPS_text_end
$declarations{FIPS_text_start} = "void *FIPS_text_start()";
$declarations{FIPS_text_end} = "void *FIPS_text_end()";
# Read list of API names obtained from edited "nm -g fipscanister.o"
$spill = 0;
sub printer {
foreach (@_) {
if ($_->{kind} >= 0) {
if ($spill) {
print " " x $indent;
print "kind: ",$_->{kind} ? "function" : "variable","\n";
print " " x $indent;
print "sym: ",$_->{sym},"\n";
print " " x $indent;
print "type: ",$_->{type},"\n";
}
if ($_->{kind}) {
$c = 0;
map {
if ($spill) {
print " " x $indent;
printf "param %d:\n", ++$c;
}
$indent += 2;
printer($_);
my $direction = $_->{direction};
if (!$_direction_question) {
$direction =~ s/<-\? <->\?/<->/;
$direction =~ s/\?//g;
}
print " " x $indent,$direction," ",$_->{sym},"\n";
$indent -= 2;
} @{$_->{params}};
if ($_->{type} !~ m/^\s*void\s*$/) {
print " " x $indent;
print "<- Return\n";
}
}
} else {
if ($spill) {
print " " x $indent;
print "decl: ",$_->{decl},"\n";
}
}
}
}
sub html_printer {
my $print_mode = shift; # 0 = print declaration with symbol in bold,
# call recursively with 1 for each parameter,
# call recursively with 2 for each parameter
# 1 = print declaration with sym grey background,
# call recursivelt with 3 for each parameter
# 2 = just print declaration
my $d = shift; # Parsed declaration
my $s = '';
if ($print_mode == 0) {
$d->{sym} || return $s;
my $h = "<hr><br />\n";
$h .= $d->{sym} . ($d->{symcomment} ? " " . $d->{symcomment} : "");
$h .= " in file " . $d->{objfile} . "<br />\n<br />\n";
$s .= '<b>' . $d->{sym} . '</b>';
if ($d->{kind} == 1) {
$s .= '(';
$s .= join(', ',
map {
html_printer(1,$_);
} @{$d->{params}});
$s .= ')';
}
my $t = $d->{type};
$t =~ s/\?/$s/;
$s = $t;
if ($d->{kind} == 1) {
map {
my $direction = $_->{direction};
if (!$_direction_question) {
$direction =~ s/<-\? <->\?/<->/;
$direction =~ s/\?//g;
}
$s .= "<br />\n";
$s .= encode_entities($direction
. "\xA0" x (9 - length($direction)));
$s .= $_->{sym};
} @{$d->{params}};
}
if ($d->{type} !~ m/^\s*void\s*\?$/) {
$s .= "<br />\n";
$s .= encode_entities('<-'.("\xA0" x 7).'Return');
}
$s = $h . $s;
} elsif ($print_mode == 1) {
$s .= '<span style="background: #c0c0c0">' . $d->{sym} . '</span>';
if ($d->{kind} == 1) {
$s .= '(';
$s .= join(', ',
map {
html_printer(3,$_);
} @{$d->{params}});
$s .= ')';
}
my $t = $d->{type};
$t =~ s/\?/$s/;
$s = $t;
} elsif ($print_mode == 2) {
$s .= $d->{sym};
if ($d->{kind} == 1) {
$s .= '(';
$s .= join(', ',
map {
html_printer(2,$_);
} @{$d->{params}});
$s .= ')';
}
my $t = $d->{type};
$t =~ s/\?/$s/;
$s = $t;
}
return $s;
}
print STDERR "Info: building/updating symbol information database\n";
$d = api_data->new();
if (-s "$here/declarations.dat") {
$d->read_declaration_db("$here/declarations.dat");
} else {
print STDERR "Warning: there was no file '$here/declarations.dat'. A new one will be created\n";
}
for (sort keys %fipssyms) {
$newname = $_;
$namecomment = undef;
if ($oldname{$newname}) {
$oldname = $oldname{$newname};
$objname = $objname{$oldname} ? $objname{$oldname} : $objname{$newname};
$namecomment = "(renames $oldname)";
} else {
$objname =
|