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
|
#!/usr/bin/env perl
#
# Copyright 2006, Jeff Morriss <jeff.morriss[AT]ulticom.com>
#
# A simple tool to check source code for function calls that should not
# be called by Wireshark code.
#
# $Id$
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
use strict;
# APIs that MUST NOT be used in Wireshark
my @prohibitedAPIs=
(
# Memory-unsafe APIs
# Use something that won't overwrite the end of your buffer instead
# of these:
'gets',
'sprintf',
'vsprintf',
'strcpy',
'strncpy',
'strcat',
'strncat',
'cftime',
'ascftime',
### non-portable APIs
# use glib (g_*) versions instead of these:
'ntohl',
'ntohs',
'htonl',
'htons',
# use ep_ or se_ functions instead of these:
'malloc',
'free',
# Locale-unsafe APIs
# These may have unexpected behaviors in some locales (e.g.,
# "I" isn't always the upper-case form of "i", and "i" isn't
# always the lower-case form of "I").
'strcasecmp',
'strncasecmp',
'g_strcasecmp',
'g_strncasecmp',
# Use the eth_* version of these:
# (Necessary because on Windows we use UTF8 for throughout the code
# so we must tweak that to UTF16 before operating on the file. Code
# using these functions will work unless the file/path name contains
# non-ASCII chars.)
'open',
'rename',
'mkdir',
'stat',
'unlink',
'remove',
'fopen',
'freopen'
);
# APIs that SHOULD NOT be used in Wireshark (any more)
my @deprecatedAPIs=
(
# Wireshark should not write to stdout (?)
# (Of course tshark should!)
'printf',
'perror',
# Use PROTO_ITEM_SET_HIDDEN instead of these:
'proto_tree_add_item_hidden',
'proto_tree_add_bytes_hidden',
'proto_tree_add_time_hidden',
'proto_tree_add_ipxnet_hidden',
'proto_tree_add_ipv4_hidden',
'proto_tree_add_ipv6_hidden',
'proto_tree_add_ether_hidden',
'proto_tree_add_guid_hidden',
'proto_tree_add_oid_hidden',
'proto_tree_add_string_hidden',
'proto_tree_add_boolean_hidden',
'proto_tree_add_float_hidden',
'proto_tree_add_double_hidden',
'proto_tree_add_uint_hidden',
'proto_tree_add_int_hidden',
);
# Given a list of APIs and the contents of a file, see if the API appears
# in the file. If so, push the API onto the provided list.
sub findAPIinList($$$)
{
my ($apiList, $fileContentsRef, $foundAPIsRef)=@_;
for my $api (@{$apiList})
{
if ($$fileContentsRef =~ m/\W$api\W*\(/)
{
push @{$foundAPIsRef},$api;
}
}
}
# The below Regexp are based on those from:
# http://aspn.activestate.com/ASPN/Cookbook/Rx/Recipe/59811
# They are in the public domain.
# 1. A complicated regex which matches C-style comments.
my $CComment = qr{/\*[^*]*\*+([^/*][^*]*\*+)*/};
# 1.a A regex that matches C++-style comments.
#my $CppComment = qr{//(.*?)\n};
# 2. A regex which matches double-quoted strings.
my $DoubleQuotedStr = qr{(?:\"(?:\\.|[^\"\\])*\")};
# 3. A regex which matches single-quoted strings.
my $SingleQuotedStr = qr{(?:\'(?:\\.|[^\'\\])*\')};
# 4. Now combine 1 through 3 to produce a regex which
# matches _either_ double or single quoted strings
# OR comments. We surround the comment-matching
# regex in capturing parenthesis to store the contents
# of the comment in $1.
# my $commentAndStringRegex = qr{(?:$DoubleQuotedStr|$SingleQuotedStr)|($CComment)|($CppComment)};
# 4. Wireshark is strictly a C program so don't take out C++ style comments
# since they shouldn't be there anyway...
my $commentAndStringRegex = qr{(?:$DoubleQuotedStr|$SingleQuotedStr)|($CComment)};
#
# MAIN
#
my $errorCount = 0;
while ($_ = $ARGV[0])
{
shift;
my $filename = $_;
my @foundProhibitedAPIs = ();
my @foundDeprecatedAPIs = ();
die "No such file: \"$filename\"" if (! -e $filename);
# delete leading './'
$filename =~ s@^\./@@;
# Read in the file (ouch, but it's easier that way)
my $fileContents = `cat $filename`;
if ($fileContents =~ m{[\x80-\xFF]})
{
print "Error: found non-ASCII characters in " .$filename."\n";
$errorCount++;
}
if ($fileContents =~ m{%ll})
{
# use G_GINT64_MODIFIER instead of ll
print "Error: found %ll in " .$filename."\n";
$errorCount++;
}
# Remove all the C-comments and strings
$fileContents =~ s {$commentAndStringRegex} []g;
if ($fileContents =~ m{//})
{
print "Error: Found C++ style comments in " .$filename."\n";
$errorCount++;
}
findAPIinList(\@prohibitedAPIs, \$fileContents, \@foundProhibitedAPIs);
# the use of "prohibited" APIs is an error, increment the error count
$errorCount += @foundProhibitedAPIs;
findAPIinList(\@deprecatedAPIs, \$fileContents, \@foundDeprecatedAPIs);
# (the use of deprecated APIs is bad but not an error)
print "Error: Found prohibited APIs in ".$filename.": ".join(',', @foundProhibitedAPIs)."\n" if @foundProhibitedAPIs;
print "Warning: Found deprecated APIs in ".$filename.": ".join(',', @foundDeprecatedAPIs)."\n" if @foundDeprecatedAPIs;
}
exit($errorCount);
|
