Merge pull request #337 from browserup/allowlist-blocklist

Rename: Whitelist-> Allowlist,  BlackList -> BlockList

Author: ericbeland

README.md

@@ -65,7 +65,7 @@ For more information on the features available in the REST API, see [the REST AP
 
 The proxy is programmatically controlled via a REST interface or by being embedded directly inside Java-based programs and unit tests. It captures performance data in the [HAR format](http://groups.google.com/group/http-archive-specification). In addition it can actually control HTTP traffic, such as:
 
- - blacklisting and whitelisting certain URL patterns
+ - blocklisting and allowlisting certain URL patterns
  - simulating various bandwidth and latency
  - remapping DNS lookups
  - flushing DNS caching
@@ -107,12 +107,12 @@ Creates a new proxy to run requests off of | POST | */proxy* | <p>*port* - Integ
 Starts a new page on the existing HAR. *[port]* in request path it is port where your proxy was started | PUT | */proxy/[port]/har/pageRef* |<p>*pageRef* - The string name of the first page ref that should be used in the HAR. Optional, default to "Page N" where N is the next page number.</p><p>*pageTitle* - The title of new HAR page. Optional, default to `pageRef`.</p>
 Shuts down the proxy and closes the port. *[port]* in request path it is port where your proxy was started | DELETE | */proxy/[port]* ||
 Returns the JSON/HAR content representing all the HTTP traffic passed through the proxy (provided you have already created the HAR with [this method](#harcreate)) | GET | */proxy/[port]/har* ||
-Displays whitelisted items | GET | */proxy/[port]/whitelist* ||
-Sets a list of URL patterns to whitelist | PUT | */proxy/[port]/whitelist* |<p>*regex* - A comma separated list of regular expressions.</p><p>*status* - The HTTP status code to return for URLs that do not match the whitelist.</p>|
-Clears all URL patterns from the whitelist  | DELETE | */proxy/[port]/whitelist* ||
-Displays blacklisted items | GET | */proxy/[port]/blacklist* ||
-Set a URL to blacklist | PUT | */proxy/[port]/blacklist* |<p>*regex* - The blacklist regular expression.</p><p>*status* - The HTTP status code to return for URLs that are blacklisted.</p><p>*method* - The regular expression for matching HTTP method (GET, POST, PUT, etc). Optional, by default processing all HTTP method.</p>|
-Clears all URL patterns from the blacklist | DELETE | */proxy/[port]/blacklist* ||
+Displays allowlisted items | GET | */proxy/[port]/allowlist* ||
+Sets a list of URL patterns to allowlist | PUT | */proxy/[port]/allowlist* |<p>*regex* - A comma separated list of regular expressions.</p><p>*status* - The HTTP status code to return for URLs that do not match the allowlist.</p>|
+Clears all URL patterns from the allowlist  | DELETE | */proxy/[port]/allowlist* ||
+Displays blocklisted items | GET | */proxy/[port]/blocklist* ||
+Set a URL to blocklist | PUT | */proxy/[port]/blocklist* |<p>*regex* - The blocklist regular expression.</p><p>*status* - The HTTP status code to return for URLs that are blocklisted.</p><p>*method* - The regular expression for matching HTTP method (GET, POST, PUT, etc). Optional, by default processing all HTTP method.</p>|
+Clears all URL patterns from the blocklist | DELETE | */proxy/[port]/blocklist* ||
 Limit the bandwidth through the proxy on the *[port]* | PUT | */proxy/[port]/limit* |<p>*downstreamKbps* - Sets the downstream bandwidth limit in kbps. Optional.</p><p>*upstreamKbps* - Sets the upstream bandwidth limit kbps. Optional, by default unlimited.</p><p>*downstreamMaxKB* - Specifies how many kilobytes in total the client is allowed to download through the proxy. Optional, by default unlimited.</p><p>*upstreamMaxKB* - Specifies how many kilobytes in total the client is allowed to upload through the proxy. Optional, by default unlimited.</p><p>*latency* - Add the given latency to each HTTP request. Optional, by default all requests are invoked without latency.</p><p>*enable* - A boolean that enable bandwidth limiter. Optional, by default to "false", but setting any of the properties above will implicitly enable throttling</p><p>*payloadPercentage* - Specifying what percentage of data sent is payload, e.g. use this to take into account overhead due to tcp/ip. Optional.</p><p>*maxBitsPerSecond* - The max bits per seconds you want this instance of StreamManager to respect. Optional.</p>
 Displays the amount of data remaining to be uploaded/downloaded until the limit is reached | GET | */proxy/[port]/limit* ||
 Set and override HTTP Request headers | POST | */proxy/[port]/headers* | Payload data should be **JSON** encoded set of headers. Where key is a header name (such as "User-Agent") and  value is a value of HTTP header to setup (such as "BrowserUp-Agent"). Example: `{"User-Agent": "BrowserUp-Agent"}`|

browserup-proxy-core/src/main/java/com/browserup/bup/BrowserUpProxy.java

@@ -8,7 +8,7 @@
 import com.browserup.bup.filters.RequestFilter;
 import com.browserup.bup.filters.ResponseFilter;
 import com.browserup.bup.mitm.TrustSource;
-import com.browserup.bup.proxy.BlacklistEntry;
+import com.browserup.bup.proxy.BlocklistEntry;
 import com.browserup.bup.proxy.CaptureType;
 import com.browserup.bup.proxy.auth.AuthType;
 import com.browserup.bup.proxy.dns.AdvancedHostResolver;
@@ -406,105 +406,105 @@ default Har getHar() {
     void clearRewriteRules();
 
     /**
-     * Adds a URL-matching regular expression to the blacklist. Requests that match a blacklisted URL will return the specified HTTP
-     * statusCode for all HTTP methods. If there are existing patterns on the blacklist, the urlPattern will be evaluated last,
-     * after the URL is checked against all other blacklist entries.
+     * Adds a URL-matching regular expression to the blocklist. Requests that match a blocklisted URL will return the specified HTTP
+     * statusCode for all HTTP methods. If there are existing patterns on the blocklist, the urlPattern will be evaluated last,
+     * after the URL is checked against all other blocklist entries.
      * The urlPattern matches the full URL of the request, including scheme, host, and port, path, and query parameters
-     * for both HTTP and HTTPS requests. For example, to blacklist both HTTP and HTTPS requests to www.google.com,
+     * for both HTTP and HTTPS requests. For example, to blocklist both HTTP and HTTPS requests to www.google.com,
      * use a urlPattern of "https?://www\\.google\\.com/.*".
      *
-     * @param urlPattern URL-matching regular expression to blacklist
+     * @param urlPattern URL-matching regular expression to blocklist
      * @param statusCode HTTP status code to return
      */
-    void blacklistRequests(String urlPattern, int statusCode);
+    void blocklistRequests(String urlPattern, int statusCode);
 
     /**
-     * Adds a URL-matching regular expression to the blacklist. Requests that match a blacklisted URL will return the specified HTTP
+     * Adds a URL-matching regular expression to the blocklist. Requests that match a blocklisted URL will return the specified HTTP
      * statusCode only when the request's HTTP method (GET, POST, PUT, etc.) matches the specified httpMethodPattern regular expression.
-     * If there are existing patterns on the blacklist, the urlPattern will be evaluated last, after the URL is checked against all
-     * other blacklist entries.
-     * See {@link #blacklistRequests(String, int)} for details on the URL the urlPattern will match.
+     * If there are existing patterns on the blocklist, the urlPattern will be evaluated last, after the URL is checked against all
+     * other blocklist entries.
+     * See {@link #blocklistRequests(String, int)} for details on the URL the urlPattern will match.
      *
-     * @param urlPattern URL-matching regular expression to blacklist
+     * @param urlPattern URL-matching regular expression to blocklist
      * @param statusCode HTTP status code to return
      * @param httpMethodPattern regular expression matching a request's HTTP method
      */
-    void blacklistRequests(String urlPattern, int statusCode, String httpMethodPattern);
+    void blocklistRequests(String urlPattern, int statusCode, String httpMethodPattern);
 
     /**
-     * Replaces any existing blacklist with the specified blacklist. URLs will be evaluated against the blacklist in the order
+     * Replaces any existing blocklist with the specified blocklist. URLs will be evaluated against the blocklist in the order
      * specified by the Collection's iterator.
      *
-     * @param blacklist new blacklist entries
+     * @param blocklist new blocklist entries
      */
-    void setBlacklist(Collection<BlacklistEntry> blacklist);
+    void setBlocklist(Collection<BlocklistEntry> blocklist);
 
     /**
-     * Returns all blacklist entries currently in effect. Iterating over the returned Collection is guaranteed to return
-     * blacklist entries in the order in which URLs are actually evaluated against the blacklist.
+     * Returns all blocklist entries currently in effect. Iterating over the returned Collection is guaranteed to return
+     * blocklist entries in the order in which URLs are actually evaluated against the blocklist.
      *
-     * @return blacklist entries, or an empty collection if none exist
+     * @return blocklist entries, or an empty collection if none exist
      */
-    Collection<BlacklistEntry> getBlacklist();
+    Collection<BlocklistEntry> getBlocklist();
 
     /**
-     * Clears any existing blacklist.
+     * Clears any existing blocklist.
      */
-    void clearBlacklist();
+    void clearBlocklist();
 
     /**
-     * Whitelists URLs matching the specified regular expression patterns. Replaces any existing whitelist.
+     * Allowlists URLs matching the specified regular expression patterns. Replaces any existing allowlist.
      * The urlPattern matches the full URL of the request, including scheme, host, and port, path, and query parameters
-     * for both HTTP and HTTPS requests. For example, to whitelist both HTTP and HTTPS requests to www.google.com, use a urlPattern
+     * for both HTTP and HTTPS requests. For example, to allowlist both HTTP and HTTPS requests to www.google.com, use a urlPattern
      * of "https?://www\\.google\\.com/.*".
-     * <b>Note:</b> All HTTP CONNECT requests are automatically whitelisted and cannot be short-circuited using the
-     * whitelist response code.
+     * <b>Note:</b> All HTTP CONNECT requests are automatically allowlisted and cannot be short-circuited using the
+     * allowlist response code.
      *
-     * @param urlPatterns URL-matching regular expressions to whitelist; null or an empty collection will enable an empty whitelist
+     * @param urlPatterns URL-matching regular expressions to allowlist; null or an empty collection will enable an empty allowlist
      * @param statusCode HTTP status code to return to clients when a URL matches a pattern
      */
-    void whitelistRequests(Collection<String> urlPatterns, int statusCode);
+    void allowlistRequests(Collection<String> urlPatterns, int statusCode);
 
     /**
-     * Adds a URL-matching regular expression to an existing whitelist.
+     * Adds a URL-matching regular expression to an existing allowlist.
      *
-     * @param urlPattern URL-matching regular expressions to whitelist
-     * @throws java.lang.IllegalStateException if the whitelist is not enabled
+     * @param urlPattern URL-matching regular expressions to allowlist
+     * @throws java.lang.IllegalStateException if the allowlist is not enabled
      */
-    void addWhitelistPattern(String urlPattern);
+    void addAllowlistPattern(String urlPattern);
 
     /**
-     * Enables the whitelist, but with no matching URLs. All requests will generated the specified HTTP statusCode.
+     * Enables the allowlist, but with no matching URLs. All requests will generated the specified HTTP statusCode.
      *
      * @param statusCode HTTP status code to return to clients on all requests
      */
-    void enableEmptyWhitelist(int statusCode);
+    void enableEmptyAllowlist(int statusCode);
 
     /**
-     * Clears any existing whitelist and disables whitelisting.
+     * Clears any existing allowlist and disables allowlisting.
      */
-    void disableWhitelist();
+    void disableAllowlist();
 
     /**
-     * Returns the URL-matching regular expressions currently in effect. If the whitelist is disabled, this method always returns an empty collection.
-     * If the whitelist is enabled but empty, this method return an empty collection.
+     * Returns the URL-matching regular expressions currently in effect. If the allowlist is disabled, this method always returns an empty collection.
+     * If the allowlist is enabled but empty, this method return an empty collection.
      *
-     * @return whitelist currently in effect, or an empty collection if the whitelist is disabled or empty
+     * @return allowlist currently in effect, or an empty collection if the allowlist is disabled or empty
      */
-    Collection<String> getWhitelistUrls();
+    Collection<String> getAllowlistUrls();
 
     /**
-     * Returns the status code returned for all URLs that do not match the whitelist. If the whitelist is not currently enabled, returns -1.
+     * Returns the status code returned for all URLs that do not match the allowlist. If the allowlist is not currently enabled, returns -1.
      *
-     * @return HTTP status code returned for non-whitelisted URLs, or -1 if the whitelist is disabled.
+     * @return HTTP status code returned for non-allowlisted URLs, or -1 if the allowlist is disabled.
      */
-    int getWhitelistStatusCode();
+    int getAllowlistStatusCode();
 
     /**
-     * Returns true if the whitelist is enabled, otherwise false.
-     * @return is WhitelistEnabled
+     * Returns true if the allowlist is enabled, otherwise false.
+     * @return is AllowlistEnabled
      */
-    boolean isWhitelistEnabled();
+    boolean isAllowlistEnabled();
 
     /**
      * Adds the specified HTTP headers to every request. Replaces any existing additional headers with the specified headers.