Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
wording: avoid blacklist/whitelist stereotypes
Instead of discussing if there's value or meaning (implied or not) in
the colors, let's use words without the same possibly negative
associations.

Closes #5546
  • Loading branch information
bagder committed Jun 10, 2020
1 parent f54b6c4 commit eab2f95
Show file tree
Hide file tree
Showing 17 changed files with 67 additions and 70 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Expand Up @@ -346,7 +346,7 @@ before_script:
script:
- ./scripts/travis/script.sh || travis_terminate 1

# whitelist branches to avoid testing feature branches twice (as branch and as pull request)
# select branches to avoid testing feature branches twice (as branch and as pull request)
branches:
only:
- master
Expand Down
2 changes: 1 addition & 1 deletion appveyor.yml
Expand Up @@ -285,7 +285,7 @@ test_script:
echo APPVEYOR_API_URL=%APPVEYOR_API_URL% &&
bash.exe -e -l -c "cd /c/projects/curl/tests && ./runtests.pl -a -b$(($(echo '%APPVEYOR_API_URL%' | cut -d'/' -f3 | cut -d':' -f2)+1)) -p !flaky %DISABLED_TESTS%" )

# whitelist branches to avoid testing feature branches twice (as branch and as pull request)
# select branches to avoid testing feature branches twice (as branch and as pull request)
branches:
only:
- master
Expand Down
4 changes: 2 additions & 2 deletions docs/CHECKSRC.md
Expand Up @@ -9,7 +9,7 @@ check that it adheres to our [Source Code Style guide](CODE_STYLE.md).

## Command line options

`-W[file]` whitelists that file and excludes it from being checked. Helpful
`-W[file]` skip that file and excludes it from being checked. Helpful
when, for example, one of the files is generated.

`-D[dir]` directory name to prepend to file names when accessing them.
Expand Down Expand Up @@ -158,5 +158,5 @@ instances are ignored and nothing extra.
This is a method we've transitioned away from. Use inline ignores as far as
possible.

Make a `checksrc.whitelist` file in the directory of the source code with the
Make a `checksrc.skip` file in the directory of the source code with the
false positive, and include the full offending line into this file.
2 changes: 1 addition & 1 deletion docs/SSL-PROBLEMS.md
Expand Up @@ -78,7 +78,7 @@
depending on the OS or build configuration. The --ssl-no-revoke option was
introduced in 7.44.0 to disable revocation checking but currently is only
supported for Schannel (the native Windows SSL library), with an exception
in the case of Windows' Untrusted Publishers blacklist which it seems can't
in the case of Windows' Untrusted Publishers block list which it seems can't
be bypassed. This option may have broader support to accommodate other SSL
backends in the future.

Expand Down
20 changes: 10 additions & 10 deletions docs/libcurl/opts/CURLMOPT_PIPELINING_SERVER_BL.3
Expand Up @@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
Expand All @@ -22,7 +22,7 @@
.\"
.TH CURLMOPT_PIPELINING_SERVER_BL 3 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
.SH NAME
CURLMOPT_PIPELINING_SERVER_BL \- pipelining server blacklist
CURLMOPT_PIPELINING_SERVER_BL \- pipelining server block list
.SH SYNOPSIS
#include <curl/curl.h>

Expand All @@ -31,28 +31,28 @@ CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING_SERVER_BL, char *
No function since pipelining was removed in 7.62.0.

Pass a \fBservers\fP array of char *, ending with a NULL entry. This is a list
of server types prefixes (in the Server: HTTP header) that are blacklisted
from pipelining, i.e server types that are known to not support HTTP
of server types prefixes (in the Server: HTTP header) that are blocked from
pipelining, i.e server types that are known to not support HTTP
pipelining. The array is copied by libcurl.

Note that the comparison matches if the Server: header begins with the string
in the blacklist, i.e "Server: Ninja 1.2.3" and "Server: Ninja 1.4.0" can
both be blacklisted by having "Ninja" in the backlist.
in the block list, i.e "Server: Ninja 1.2.3" and "Server: Ninja 1.4.0" can
both be blocked by having "Ninja" in the list.

Pass a NULL pointer to clear the blacklist.
Pass a NULL pointer to clear the block list.
.SH DEFAULT
The default value is NULL, which means that there is no blacklist.
The default value is NULL, which means that there is no block list.
.SH PROTOCOLS
.SH EXAMPLE
.nf
server_blacklist[] =
char *server_block_list[] =
{
"Microsoft-IIS/6.0",
"nginx/0.8.54",
NULL
};

curl_multi_setopt(m, CURLMOPT_PIPELINING_SERVER_BL, server_blacklist);
curl_multi_setopt(m, CURLMOPT_PIPELINING_SERVER_BL, server_block_list);
.fi
.SH AVAILABILITY
Added in 7.30.0
Expand Down
14 changes: 7 additions & 7 deletions docs/libcurl/opts/CURLMOPT_PIPELINING_SITE_BL.3
Expand Up @@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
Expand All @@ -22,7 +22,7 @@
.\"
.TH CURLMOPT_PIPELINING_SITE_BL 3 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
.SH NAME
CURLMOPT_PIPELINING_SITE_BL \- pipelining host blacklist
CURLMOPT_PIPELINING_SITE_BL \- pipelining host block list
.SH SYNOPSIS
#include <curl/curl.h>

Expand All @@ -31,24 +31,24 @@ CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING_SITE_BL, char **h
No function since pipelining was removed in 7.62.0.

Pass a \fBhosts\fP array of char *, ending with a NULL entry. This is a list
of sites that are blacklisted from pipelining, i.e sites that are known to not
of sites that are blocked from pipelining, i.e sites that are known to not
support HTTP pipelining. The array is copied by libcurl.

Pass a NULL pointer to clear the blacklist.
Pass a NULL pointer to clear the block list.
.SH DEFAULT
The default value is NULL, which means that there is no blacklist.
The default value is NULL, which means that there is no block list.
.SH PROTOCOLS
HTTP(S)
.SH EXAMPLE
.nf
site_blacklist[] =
char *site_block_list[] =
{
"www.haxx.se",
"www.example.com:1234",
NULL
};

curl_multi_setopt(m, CURLMOPT_PIPELINING_SITE_BL, site_blacklist);
curl_multi_setopt(m, CURLMOPT_PIPELINING_SITE_BL, site_block_list);
.fi
.SH AVAILABILITY
Added in 7.30.0
Expand Down
4 changes: 2 additions & 2 deletions docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3
Expand Up @@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
Expand Down Expand Up @@ -65,7 +65,7 @@ additional \fIsetsockopt(2)\fP calls can of course be done on the socket at
the user's discretion. A \fICURL_SOCKET_BAD\fP return value from the callback
function will signal an unrecoverable error to libcurl and it will return
\fICURLE_COULDNT_CONNECT\fP from the function that triggered this callback.
This return code can be used for IP address blacklisting.
This return code can be used for IP address block listing.

If you want to pass in a socket with an already established connection, pass
the socket back with this callback and then use
Expand Down
2 changes: 1 addition & 1 deletion docs/libcurl/opts/CURLOPT_PROXY_SSL_OPTIONS.3
Expand Up @@ -42,7 +42,7 @@ supported for DarwinSSL, NSS and OpenSSL.
Tells libcurl to disable certificate revocation checks for those SSL backends
where such behavior is present. This option is only supported for Schannel
(the native Windows SSL library), with an exception in the case of Windows'
Untrusted Publishers blacklist which it seems can't be bypassed. (Added in
Untrusted Publishers block list which it seems can't be bypassed. (Added in
7.44.0)
.IP CURLSSLOPT_NO_PARTIALCHAIN
Tells libcurl to not accept "partial" certificate chains, which it otherwise
Expand Down
2 changes: 1 addition & 1 deletion docs/libcurl/opts/CURLOPT_SSL_OPTIONS.3
Expand Up @@ -42,7 +42,7 @@ supported for DarwinSSL, NSS and OpenSSL.
Tells libcurl to disable certificate revocation checks for those SSL backends
where such behavior is present. This option is only supported for Schannel
(the native Windows SSL library), with an exception in the case of Windows'
Untrusted Publishers blacklist which it seems can't be bypassed. (Added in
Untrusted Publishers block list which it seems can't be bypassed. (Added in
7.44.0)
.IP CURLSSLOPT_NO_PARTIALCHAIN
Tells libcurl to not accept "partial" certificate chains, which it otherwise
Expand Down
6 changes: 2 additions & 4 deletions include/curl/multi.h
Expand Up @@ -377,12 +377,10 @@ typedef enum {
will not be considered for pipelining */
CURLOPT(CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, CURLOPTTYPE_OFF_T, 10),

/* a list of site names(+port) that are blacklisted from
pipelining */
/* a list of site names(+port) that are blocked from pipelining */
CURLOPT(CURLMOPT_PIPELINING_SITE_BL, CURLOPTTYPE_OBJECTPOINT, 11),

/* a list of server types that are blacklisted from
pipelining */
/* a list of server types that are blocked from pipelining */
CURLOPT(CURLMOPT_PIPELINING_SERVER_BL, CURLOPTTYPE_OBJECTPOINT, 12),

/* maximum number of open connections in total */
Expand Down
18 changes: 9 additions & 9 deletions lib/checksrc.pl
Expand Up @@ -31,14 +31,14 @@
my $swarnings = 0;
my $errors = 0;
my $serrors = 0;
my $suppressed; # whitelisted problems
my $suppressed; # skipped problems
my $file;
my $dir=".";
my $wlist="";
my @alist;
my $windows_os = $^O eq 'MSWin32' || $^O eq 'cygwin' || $^O eq 'msys';
my $verbose;
my %whitelist;
my %skiplist;

my %ignore;
my %ignore_set;
Expand Down Expand Up @@ -84,12 +84,12 @@
'TYPEDEFSTRUCT' => 'typedefed struct',
);

sub readwhitelist {
open(W, "<$dir/checksrc.whitelist") or return;
sub readskiplist {
open(W, "<$dir/checksrc.skip") or return;
my @all=<W>;
for(@all) {
$windows_os ? $_ =~ s/\r?\n$// : chomp;
$whitelist{$_}=1;
$skiplist{$_}=1;
}
close(W);
}
Expand Down Expand Up @@ -142,8 +142,8 @@ sub checkwarn {
# print STDERR "Dev! there's no description for $name!\n";
#}

# checksrc.whitelist
if($whitelist{$line}) {
# checksrc.skip
if($skiplist{$line}) {
$nowarn = 1;
}
# !checksrc! controlled
Expand Down Expand Up @@ -228,7 +228,7 @@ sub checkwarn {
print " -A[rule] Accept this violation, can be used multiple times\n";
print " -D[DIR] Directory to prepend file names\n";
print " -h Show help output\n";
print " -W[file] Whitelist 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 " -m<n> Maximum line length. Default: 79\n";
print "\nDetects and warns for these problems:\n";
Expand All @@ -238,7 +238,7 @@ sub checkwarn {
exit;
}

readwhitelist();
readskiplist();
readlocalfile();

do {
Expand Down
5 changes: 2 additions & 3 deletions lib/http.c
Expand Up @@ -3698,9 +3698,8 @@ CURLcode Curl_http_readwrite_headers(struct Curl_easy *data,
else if(conn->httpversion == 20 ||
(k->upgr101 == UPGR101_REQUESTED && k->httpcode == 101)) {
DEBUGF(infof(data, "HTTP/2 found, allow multiplexing\n"));

/* HTTP/2 cannot blacklist multiplexing since it is a core
functionality of the protocol */
/* HTTP/2 cannot avoid multiplexing since it is a core functionality
of the protocol */
conn->bundle->multiuse = BUNDLE_MULTIPLEX;
}
else if(conn->httpversion >= 11 &&
Expand Down
8 changes: 4 additions & 4 deletions scripts/copyright.pl
Expand Up @@ -28,7 +28,7 @@
#

# regexes of files to not scan
my @whitelist=(
my @skiplist=(
'^tests\/data\/test(\d+)$', # test case data
'^docs\/cmdline-opts\/[a-z]+(.*)\.d$', # curl.1 pieces
'(\/|^)[A-Z0-9_.-]+$', # all uppercase file name, possibly with dot and dash
Expand Down Expand Up @@ -168,10 +168,10 @@ sub checkfile {
for my $f (@all) {
chomp $f;
my $skipped = 0;
for my $skip (@whitelist) {
for my $skip (@skiplist) {
#print "$f matches $skip ?\n";
if($f =~ /$skip/) {
$whitelisted++;
$skiplisted++;
$skipped = 1;
#print "$f: SKIPPED ($skip)\n";
last;
Expand All @@ -186,6 +186,6 @@ sub checkfile {

print STDERR "$missing files have no copyright\n" if($missing);
print STDERR "$wrong files have wrong copyright year\n" if ($wrong);
print STDERR "$whitelisted files are whitelisted\n" if ($whitelisted);
print STDERR "$skiplisted files are skipped\n" if ($skiplisted);

exit 1 if($missing || $wrong);
2 changes: 1 addition & 1 deletion tests/data/test1550
Expand Up @@ -20,7 +20,7 @@ lib1550
</tool>

<name>
verify setting pipeling blacklisting options
verify setting pipeling blocklisting options
</name>
<command>
http://%HOSTIP:%NOLISTENPORT/1550
Expand Down
4 changes: 2 additions & 2 deletions tests/data/test1901
Expand Up @@ -40,13 +40,13 @@ http
lib1900
</tool>
<name>
HTTP GET using pipelining, blacklisted site
HTTP GET using pipelining, blocklisted site
</name>
<command>
http://%HOSTIP:%HTTPPIPEPORT/ log/urls1901.txt
</command>
<file name="log/urls1901.txt">
blacklist_site 127.0.0.1:%HTTPPIPEPORT
blocklist_site 127.0.0.1:%HTTPPIPEPORT
0 1k.txt
1000 100k.txt
0 1k.txt
Expand Down

0 comments on commit eab2f95

Please sign in to comment.