lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-10-26 02:17:35 +03:00
Code Activity

checksrc: update, update local config, fix toctou in examples

Browse Source 
Closes #1719
This commit is contained in:
Viktor Szakats
2025-10-13 13:40:18 +02:00
parent 45d52d16c3
commit 557611f92b
6 changed files with 210 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

243
ci/checksrc.pl
View File

@@ -39,7 +39,7 @@ my $dir=".";
my $wlist=""; my $wlist="";
my @alist; my @alist;
my $windows_os = $^O eq 'MSWin32' || $^O eq 'cygwin' || $^O eq 'msys'; my $windows_os = $^O eq 'MSWin32' || $^O eq 'cygwin' || $^O eq 'msys';
my $verbose; my $verbose = 0;
my %skiplist; my %skiplist;
my %ignore; my %ignore;
@@ -47,10 +47,69 @@ my %ignore_set;
my %ignore_used; my %ignore_used;
my @ignore_line; my @ignore_line;
my %banfunc = (
"gmtime" => 1,
"localtime" => 1,
"gets" => 1,
"strtok" => 1,
"sprintf" => 1,
"snprintf" => 1,
"vsprintf" => 1,
"vsnprintf" => 1,
"aprintf" => 1,
"fprintf" => 1,
"msnprintf" => 1,
"mvsnprintf" => 1,
"printf" => 1,
"vaprintf" => 1,
"vfprintf" => 1,
"vprintf" => 1,
"sscanf" => 1,
"strcat" => 1,
"strerror" => 1,
"strncat" => 1,
"strncpy" => 1,
"strtok_r" => 1,
"strtol" => 1,
"strtoul" => 1,
"_mbscat" => 1,
"_mbsncat" => 1,
"_tcscat" => 1,
"_tcsdup" => 1,
"_tcsncat" => 1,
"_wcscat" => 1,
"_wcsncat" => 1,
"_wcsdup" => 1,
"wcsdup" => 1,
"LoadLibrary" => 1,
"LoadLibraryA" => 1,
"LoadLibraryW" => 1,
"LoadLibraryEx" => 1,
"LoadLibraryExA" => 1,
"LoadLibraryExW" => 1,
"WSASocket" => 1,
"WSASocketA" => 1,
"WSASocketW" => 1,
"_waccess" => 1,
"_access" => 1,
"access" => 1,
"accept" => 1,
"accept4" => 1,
"freeaddrinfo" => 1,
"getaddrinfo" => 1,
"recv" => 1,
"send" => 1,
"socket" => 1,
"socketpair" => 1,
"fclose" => 1,
"fdopen" => 1,
"fopen" => 1,
"open" => 1,
"stat" => 1,
);
my %warnings_extended = ( my %warnings_extended = (
'COPYRIGHTYEAR' => 'copyright year incorrect', 'COPYRIGHTYEAR' => 'copyright year incorrect',
'STRERROR', => 'strerror() detected',
'STRNCPY', => 'strncpy() detected',
'STDERR', => 'stderr detected', 'STDERR', => 'stderr detected',
); );
@@ -73,7 +132,9 @@ my %warnings = (
'EMPTYLINEBRACE' => 'Empty line before the open brace', 'EMPTYLINEBRACE' => 'Empty line before the open brace',
'EQUALSNOSPACE' => 'equals sign without following space', 'EQUALSNOSPACE' => 'equals sign without following space',
'EQUALSNULL' => 'if/while comparison with == NULL', 'EQUALSNULL' => 'if/while comparison with == NULL',
'ERRNOVAR' => 'use of bare errno define',
'EXCLAMATIONSPACE' => 'Whitespace after exclamation mark in expression', 'EXCLAMATIONSPACE' => 'Whitespace after exclamation mark in expression',
'FIXME' => 'FIXME or TODO comment',
'FOPENMODE' => 'fopen needs a macro for the mode string', 'FOPENMODE' => 'fopen needs a macro for the mode string',
'INCLUDEDUP', => 'same file is included again', 'INCLUDEDUP', => 'same file is included again',
'INDENTATION' => 'wrong start column for code', 'INDENTATION' => 'wrong start column for code',
@@ -92,7 +153,6 @@ my %warnings = (
'RETURNNOSPACE' => 'return without space', 'RETURNNOSPACE' => 'return without space',
'SEMINOSPACE' => 'semicolon without following space', 'SEMINOSPACE' => 'semicolon without following space',
'SIZEOFNOPAREN' => 'use of sizeof without parentheses', 'SIZEOFNOPAREN' => 'use of sizeof without parentheses',
'SNPRINTF' => 'use of snprintf',
'SPACEAFTERPAREN' => 'space after open parenthesis', 'SPACEAFTERPAREN' => 'space after open parenthesis',
'SPACEBEFORECLOSE' => 'space before a close parenthesis', 'SPACEBEFORECLOSE' => 'space before a close parenthesis',
'SPACEBEFORECOMMA' => 'space before a comma', 'SPACEBEFORECOMMA' => 'space before a comma',
@@ -140,17 +200,21 @@ sub readlocalfile {
$i++; $i++;
# Lines starting with '#' are considered comments # Lines starting with '#' are considered comments
if (/^\s*(#.*)/) { if(/^\s*(#.*)/) {
next; next;
} }
elsif (/^\s*enable ([A-Z]+)$/) { # Skip empty lines
elsif($_ eq '') {
next;
}
elsif(/^enable ([A-Z]+)$/) {
if(!defined($warnings_extended{$1})) { if(!defined($warnings_extended{$1})) {
print STDERR "invalid warning specified in .checksrc: \"$1\"\n"; print STDERR "invalid warning specified in .checksrc: \"$1\"\n";
next; next;
} }
$warnings{$1} = $warnings_extended{$1}; $warnings{$1} = $warnings_extended{$1};
} }
elsif (/^\s*disable ([A-Z]+)$/) { elsif(/^disable ([A-Z]+)$/) {
if(!defined($warnings{$1})) { if(!defined($warnings{$1})) {
print STDERR "invalid warning specified in .checksrc: \"$1\"\n"; print STDERR "invalid warning specified in .checksrc: \"$1\"\n";
next; next;
@@ -158,8 +222,14 @@ sub readlocalfile {
# Accept-list # Accept-list
push @alist, $1; push @alist, $1;
} }
elsif(/^banfunc ([^ ]*)/) {
$banfunc{$1} = $1;
}
elsif(/^allowfunc ([^ ]*)/) {
undef $banfunc{$1};
}
else { else {
die "Invalid format in $dir/.checksrc on line $i\n"; die "Invalid format in $dir/.checksrc on line $i: $_\n";
} }
} }
close($rcfile); close($rcfile);
@@ -222,31 +292,47 @@ $file = shift @ARGV;
while(defined $file) { while(defined $file) {
if($file =~ /-D(.*)/) { if($file =~ /^-D(.*)/) {
$dir = $1; $dir = $1;
$file = shift @ARGV; $file = shift @ARGV;
next; next;
} }
elsif($file =~ /-W(.*)/) { elsif($file =~ /^-W(.*)/) {
$wlist .= " $1 "; $wlist .= " $1 ";
$file = shift @ARGV; $file = shift @ARGV;
next; next;
} }
elsif($file =~ /-A(.+)/) { elsif($file =~ /^-b(.*)/) {
$banfunc{$1} = $1;
print STDERR "ban use of \"$1\"\n";
$file = shift @ARGV;
next;
}
elsif($file =~ /^-a(.*)/) {
undef $banfunc{$1};
$file = shift @ARGV;
next;
}
elsif($file =~ /^-A(.+)/) {
push @alist, $1; push @alist, $1;
$file = shift @ARGV; $file = shift @ARGV;
next; next;
} }
elsif($file =~ /-i([1-9])/) { elsif($file =~ /^-i([1-9])/) {
$indent = $1 + 0; $indent = $1 + 0;
$file = shift @ARGV; $file = shift @ARGV;
next; next;
} }
elsif($file =~ /-m([0-9]+)/) { elsif($file =~ /^-m([0-9]+)/) {
$max_column = $1 + 0; $max_column = $1 + 0;
$file = shift @ARGV; $file = shift @ARGV;
next; next;
} }
elsif($file =~ /^-v/) {
$verbose = 1;
$file = shift @ARGV;
next;
}
elsif($file =~ /^(-h|--help)/) { elsif($file =~ /^(-h|--help)/) {
undef $file; undef $file;
last; last;
@@ -259,11 +345,14 @@ if(!$file) {
print "checksrc.pl [option] <file1> [file2] ...\n"; print "checksrc.pl [option] <file1> [file2] ...\n";
print " Options:\n"; print " Options:\n";
print " -A[rule] Accept this violation, can be used multiple times\n"; print " -A[rule] Accept this violation, can be used multiple times\n";
print " -a[func] Allow use of this function\n";
print " -b[func] Ban use of this function\n";
print " -D[DIR] Directory to prepend file names\n"; print " -D[DIR] Directory to prepend file names\n";
print " -h Show help output\n"; print " -h Show help output\n";
print " -W[file] Skip the given file - ignore all its flaws\n"; print " -W[file] Skip the given file - ignore all its flaws\n";
print " -i<n> Indent spaces. Default: 2\n"; print " -i<n> Indent spaces. Default: 2\n";
print " -m<n> Maximum line length. Default: 79\n"; print " -m<n> Maximum line length. Default: 79\n";
print " -v Verbose\n";
print "\nDetects and warns for these problems:\n"; print "\nDetects and warns for these problems:\n";
my @allw = keys %warnings; my @allw = keys %warnings;
push @allw, keys %warnings_extended; push @allw, keys %warnings_extended;
@@ -276,6 +365,11 @@ if(!$file) {
} }
} }
print " [*] = disabled by default\n"; print " [*] = disabled by default\n";
print "\nDetects and bans use of these functions:\n";
for my $f (sort keys %banfunc) {
printf (" %-18s\n", $f);
}
exit; exit;
} }
@@ -285,7 +379,7 @@ readlocalfile($file);
do { do {
if("$wlist" !~ / $file /) { if("$wlist" !~ / $file /) {
my $fullname = $file; my $fullname = $file;
$fullname = "$dir/$file" if ($fullname !~ '^\.?\.?/'); $fullname = "$dir/$file" if($fullname !~ '^\.?\.?/');
scanfile($fullname); scanfile($fullname);
} }
$file = shift @ARGV; $file = shift @ARGV;
@@ -400,6 +494,11 @@ sub scanfile {
my $l = ""; my $l = "";
my $prep = 0; my $prep = 0;
my $prevp = 0; my $prevp = 0;
if($verbose) {
printf "Checking file: $file\n";
}
open(my $R, '<', $file) || die "failed to open $file"; open(my $R, '<', $file) || die "failed to open $file";
my $incomment=0; my $incomment=0;
@@ -432,10 +531,10 @@ sub scanfile {
my $count = 0; my $count = 0;
while($l =~ /([\d]{4})/g) { while($l =~ /([\d]{4})/g) {
push @copyright, { push @copyright, {
year => $1, year => $1,
line => $line, line => $line,
col => index($l, $1), col => index($l, $1),
code => $l code => $l
}; };
$count++; $count++;
} }
@@ -451,7 +550,7 @@ sub scanfile {
} }
# detect long lines # detect long lines
if(length($l) > $max_column) { if(length($l) > $max_column && $l !~ / https:\/\//) {
checkwarn("LONGLINE", $line, length($l), $file, $l, checkwarn("LONGLINE", $line, length($l), $file, $l,
"Longer than $max_column columns"); "Longer than $max_column columns");
} }
@@ -478,6 +577,12 @@ sub scanfile {
$line, length($1) + 1, $file, $l, $line, length($1) + 1, $file, $l,
"Missing space end comment end"); "Missing space end comment end");
} }
if($l =~ /(.*)(FIXME|TODO)/) {
checkwarn("FIXME",
$line, length($1), $file, $l,
"Avoid $2 comments. Add to documentation instead");
}
# ------------------------------------------------------------ # ------------------------------------------------------------
# Above this marker, the checks were done on lines *including* # Above this marker, the checks were done on lines *including*
# comments # comments
@@ -713,7 +818,7 @@ sub scanfile {
} }
# check for "return(" without space # check for "return(" without space
if($l =~ /^(.*)return\(/) { if($l =~ /^(.*\W)return\(/) {
if($1 =~ / *\#/) { if($1 =~ / *\#/) {
# this is a #if, treat it differently # this is a #if, treat it differently
} }
@@ -723,6 +828,12 @@ sub scanfile {
} }
} }
# check for "return" with parentheses around just a value/name
if($l =~ /^(.*\W)return \(\w*\);/) {
checkwarn("RETURNPAREN", $line, length($1)+7, $file, $l,
"return with paren");
}
# check for "sizeof" without parenthesis # check for "sizeof" without parenthesis
if(($l =~ /^(.*)sizeof *([ (])/) && ($2 ne "(")) { if(($l =~ /^(.*)sizeof *([ (])/) && ($2 ne "(")) {
if($1 =~ / *\#/) { if($1 =~ / *\#/) {
@@ -800,44 +911,23 @@ sub scanfile {
} }
# scan for use of banned functions # scan for use of banned functions
if($l =~ /^(.*\W) my $bl = $l;
(gmtime|localtime| again:
gets| if((($l =~ /^(.*?\W)(\w+)(\s*\()/x) && $banfunc{$2}) ||
strtok| (($l =~ /^(.*?\()(\w+)(\s*\()/x) && $banfunc{$2})) {
v?sprintf| my $bad = $2;
(str|_mbs|_tcs|_wcs)n?cat| my $prefix = $1;
LoadLibrary(Ex)?(A|W)?| my $suff = $3;
_?w?access)
\s*\(
/x) {
checkwarn("BANNEDFUNC", checkwarn("BANNEDFUNC",
$line, length($1), $file, $ol, $line, length($prefix), $file, $ol,
"use of $2 is banned"); "use of $bad is banned");
} my $search = quotemeta($prefix . $bad . $suff);
if($warnings{"STRERROR"}) { my $replace = $prefix . 'x' x (length($bad) + 1);
# scan for use of banned strerror. This is not a BANNEDFUNC to $l =~ s/$search/$replace/;
# allow for individual enable/disable of this warning. goto again;
if($l =~ /^(.*\W)(strerror)\s*\(/x) {
if($1 !~ /^ *\#/) {
# skip preprocessor lines
checkwarn("STRERROR",
$line, length($1), $file, $ol,
"use of $2 is banned");
}
}
}
if($warnings{"STRNCPY"}) {
# scan for use of banned strncpy. This is not a BANNEDFUNC to
# allow for individual enable/disable of this warning.
if($l =~ /^(.*\W)(strncpy)\s*\(/x) {
if($1 !~ /^ *\#/) {
# skip preprocessor lines
checkwarn("STRNCPY",
$line, length($1), $file, $ol,
"use of $2 is banned");
}
}
} }
$l = $bl; # restore to pre-bannedfunc content
if($warnings{"STDERR"}) { if($warnings{"STDERR"}) {
# scan for use of banned stderr. This is not a BANNEDFUNC to # scan for use of banned stderr. This is not a BANNEDFUNC to
# allow for individual enable/disable of this warning. # allow for individual enable/disable of this warning.
@@ -850,16 +940,10 @@ sub scanfile {
} }
} }
} }
# scan for use of snprintf for curl-internals reasons
if($l =~ /^(.*\W)(v?snprintf)\s*\(/x) {
checkwarn("SNPRINTF",
$line, length($1), $file, $ol,
"use of $2 is banned");
}
# scan for use of non-binary fopen without the macro # scan for use of non-binary fopen without the macro
if($l =~ /^(.*\W)fopen\s*\([^,]*, *\"([^"]*)/) { if($l =~ /^(.*\W)(curlx_fopen|CURLX_FOPEN_LOW)\s*\([^,]*, *\"([^"]*)/) {
my $mode = $2; my $mode = $3;
if($mode !~ /b/) { if($mode !~ /b/) {
checkwarn("FOPENMODE", checkwarn("FOPENMODE",
$line, length($1), $file, $ol, $line, length($1), $file, $ol,
@@ -887,7 +971,6 @@ sub scanfile {
my $diff = $second - $first; my $diff = $second - $first;
checkwarn("INDENTATION", $line, length($1), $file, $ol, checkwarn("INDENTATION", $line, length($1), $file, $ol,
"not indented $indent steps (uses $diff)"); "not indented $indent steps (uses $diff)");
} }
} }
} }
@@ -990,6 +1073,12 @@ sub scanfile {
"space after exclamation mark"); "space after exclamation mark");
} }
if($nostr =~ /(.*)\b(EACCES|EADDRINUSE|EADDRNOTAVAIL|EAFNOSUPPORT|EBADF|ECONNREFUSED|ECONNRESET|EINPROGRESS|EINTR|EINVAL|EISCONN|EMSGSIZE|ENOMEM|ETIMEDOUT|EWOULDBLOCK)\b/) {
checkwarn("ERRNOVAR",
$line, length($1), $file, $ol,
"use of bare errno define $2, use SOCK$2");
}
# check for more than one consecutive space before open brace or # check for more than one consecutive space before open brace or
# question mark. Skip lines containing strings since they make it hard # question mark. Skip lines containing strings since they make it hard
# due to artificially getting multiple spaces # due to artificially getting multiple spaces
@@ -1001,16 +1090,16 @@ sub scanfile {
} }
preproc: preproc:
if($prep) { if($prep) {
# scan for use of banned symbols on a preprocessor line # scan for use of banned symbols on a preprocessor line
if($l =~ /^(^|.*\W) if($l =~ /^(^|.*\W)
(WIN32) (WIN32)
(\W|$) (\W|$)
/x) { /x) {
checkwarn("BANNEDPREPROC", checkwarn("BANNEDPREPROC",
$line, length($1), $file, $ol, $line, length($1), $file, $ol,
"use of $2 is banned from preprocessor lines" . "use of $2 is banned from preprocessor lines" .
(($2 eq "WIN32") ? ", use _WIN32 instead" : "")); (($2 eq "WIN32") ? ", use _WIN32 instead" : ""));
} }
} }
$line++; $line++;
$prevp = $prep; $prevp = $prep;
@@ -1084,5 +1173,7 @@ if($errors || $warnings || $verbose) {
$serrors, $serrors,
$swarnings; $swarnings;
} }
exit 5; # return failure if($errors || $warnings) {
exit 5; # return failure
}
} }

14
ci/checksrc.sh
View File

@@ -7,4 +7,16 @@ set -eu
cd "$(dirname "$0")"/.. cd "$(dirname "$0")"/..
git ls-files "*.[ch]" "*.cc" | xargs -n1 \ git ls-files "*.[ch]" "*.cc" | xargs -n1 \
ci/checksrc.pl -i4 -m79 -AFOPENMODE -ASNPRINTF -ATYPEDEFSTRUCT ci/checksrc.pl -i4 -m79 -AFIXME -AERRNOVAR -AFOPENMODE -ATYPEDEFSTRUCT \
-aaccept \
-afclose \
-afopen \
-afprintf \
-aprintf \
-arecv \
-asend \
-asnprintf \
-asocket \
-asocketpair \
-astrtol \
-avsnprintf

14
example/scp_write.c
View File

@@ -23,6 +23,14 @@
#include <stdio.h> #include <stdio.h>
#ifdef _WIN32
#undef stat
#define stat _stat
#undef fstat
#define fstat _fstat
#define fileno _fileno
#endif
static const char *pubkey = "/home/username/.ssh/id_rsa.pub"; static const char *pubkey = "/home/username/.ssh/id_rsa.pub";
static const char *privkey = "/home/username/.ssh/id_rsa"; static const char *privkey = "/home/username/.ssh/id_rsa";
static const char *username = "username"; static const char *username = "username";
@@ -87,7 +95,11 @@ int main(int argc, char *argv[])
return 1; return 1;
} }
stat(loclfile, &fileinfo); if(fstat(fileno(local), &fileinfo) != 0) {
fprintf(stderr, "error: could not stat file %s\n", loclfile);
fclose(local);
return 1;
}
/* Ultra basic "connect to port 22 on localhost". Your code is /* Ultra basic "connect to port 22 on localhost". Your code is
* responsible for creating the socket establishing the connection * responsible for creating the socket establishing the connection

14
example/scp_write_nonblock.c
View File

@@ -27,6 +27,14 @@
#include <stdio.h> #include <stdio.h>
#include <time.h> /* for time() */ #include <time.h> /* for time() */
#ifdef _WIN32
#undef stat
#define stat _stat
#undef fstat
#define fstat _fstat
#define fileno _fileno
#endif
static const char *pubkey = "/home/username/.ssh/id_rsa.pub"; static const char *pubkey = "/home/username/.ssh/id_rsa.pub";
static const char *privkey = "/home/username/.ssh/id_rsa"; static const char *privkey = "/home/username/.ssh/id_rsa";
static const char *username = "username"; static const char *username = "username";
@@ -132,7 +140,11 @@ int main(int argc, char *argv[])
return 1; return 1;
} }
stat(loclfile, &fileinfo); if(fstat(fileno(local), &fileinfo) != 0) {
fprintf(stderr, "error: could not stat file %s\n", loclfile);
fclose(local);
return 1;
}
/* Ultra basic "connect to port 22 on localhost". Your code is /* Ultra basic "connect to port 22 on localhost". Your code is
* responsible for creating the socket establishing the connection * responsible for creating the socket establishing the connection

1
src/agent.c
View File

@@ -494,6 +494,7 @@ agent_connect_unix(LIBSSH2_AGENT *agent)
"failed creating socket"); "failed creating socket");
s_un.sun_family = AF_UNIX; s_un.sun_family = AF_UNIX;
/* !checksrc! disable BANNEDFUNC 1 */ /* FIXME */
strncpy(s_un.sun_path, path, sizeof(s_un.sun_path)); strncpy(s_un.sun_path, path, sizeof(s_un.sun_path));
s_un.sun_path[sizeof(s_un.sun_path)-1] = 0; /* make sure there's a trailing s_un.sun_path[sizeof(s_un.sun_path)-1] = 0; /* make sure there's a trailing
zero */ zero */

5
vms/man2help.c
View File

@@ -136,10 +136,11 @@ int find_file(char *filename, char *gevonden, int *findex)
if((status & 1) == 1) { if((status & 1) == 1) {
/* !checksrc! disable BANNEDFUNC 1 */ /* FIXME */ /* !checksrc! disable BANNEDFUNC 1 */ /* FIXME */
strcpy(gevonden, strtok(gevonden_file, " ")); strcpy(gevonden,
strtok(gevonden_file, " "));
} }
else { else {
gevonden[0] = 0; gevonden[0] = 0;
} }
return status; return status;