com.sun.webkit.network.PublicSuffixes Maven / Gradle / Ivy
/*
* Copyright (c) 2011, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.webkit.network;
import com.sun.javafx.logging.PlatformLogger;
import com.sun.javafx.logging.PlatformLogger.Level;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.IDN;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
/**
* A collection of static utility methods dealing with "public suffixes".
*/
final class PublicSuffixes {
private static final PlatformLogger logger =
PlatformLogger.getLogger(PublicSuffixes.class.getName());
/**
* Public suffix list rule types.
*/
private enum Rule {
SIMPLE_RULE,
WILDCARD_RULE,
EXCEPTION_RULE,
}
/**
* The mapping from top-level domain names to public suffix list rules.
*/
private static final Map rulesCache = new ConcurrentHashMap<>();
/**
* The public suffix list file.
*/
@SuppressWarnings("removal")
private static final File pslFile = AccessController.doPrivileged((PrivilegedAction)
() -> new File(System.getProperty("java.home"), "lib/security/public_suffix_list.dat"));
/*
* Determines whether the public suffix list file is available.
*/
@SuppressWarnings("removal")
private static final boolean pslFileExists = AccessController.doPrivileged(
(PrivilegedAction) () -> {
if (!pslFile.exists()) {
logger.warning("Resource not found: " +
"lib/security/public_suffix_list.dat");
return false;
}
return true;
});
/**
* The private default constructor. Ensures non-instantiability.
*/
private PublicSuffixes() {
throw new AssertionError();
}
/**
* Returns whether the public suffix list file is available.
*/
static boolean pslFileExists() {
return pslFileExists;
}
/**
* Determines if a domain is a public suffix.
*/
static boolean isPublicSuffix(String domain) {
if (domain.length() == 0) {
return false;
}
if (!pslFileExists()) {
return false;
}
Rules rules = Rules.getRules(domain);
return rules == null ? false : rules.match(domain);
}
private static class Rules {
private final Map rules = new HashMap<>();
private Rules(InputStream is) throws IOException {
InputStreamReader isr = new InputStreamReader(is, "UTF-8");
BufferedReader reader = new BufferedReader(isr);
String line;
int type = reader.read();
while (type != -1 && (line = reader.readLine()) != null) {
Rule rule;
if (line.startsWith("!")) {
line = line.substring(1);
rule = Rule.EXCEPTION_RULE;
} else if (line.startsWith("*.")) {
line = line.substring(2);
rule = Rule.WILDCARD_RULE;
} else {
rule = Rule.SIMPLE_RULE;
}
try {
line = IDN.toASCII(line, IDN.ALLOW_UNASSIGNED);
} catch (Exception ex) {
logger.warning(String.format("Error parsing rule: [%s]", line), ex);
continue;
}
rules.put(line, rule);
type = reader.read();
}
if (logger.isLoggable(Level.FINEST)) {
logger.finest("rules: {0}", toLogString(rules));
}
}
static Rules getRules(String domain) {
String tld = getTopLevelDomain(domain);
if (tld.isEmpty()) {
return null;
}
return rulesCache.computeIfAbsent(tld, k -> createRules(tld));
}
private static String getTopLevelDomain(String domain) {
domain = IDN.toUnicode(domain, IDN.ALLOW_UNASSIGNED);
int n = domain.lastIndexOf('.');
if (n == -1) {
return domain;
}
return domain.substring(n + 1);
}
private static Rules createRules(String tld) {
try (InputStream pubSuffixStream = getPubSuffixStream()) {
if (pubSuffixStream == null) {
return null;
}
ZipInputStream zis = new ZipInputStream(pubSuffixStream);
ZipEntry ze = zis.getNextEntry();
while (ze != null) {
if (ze.getName().equals(tld)) {
return new Rules(zis);
} else {
ze = zis.getNextEntry();
}
}
} catch (IOException ex) {
logger.warning("Unexpected error", ex);
}
return null;
}
private static InputStream getPubSuffixStream() {
@SuppressWarnings("removal")
InputStream is = AccessController.doPrivileged(
(PrivilegedAction) () -> {
try {
return new FileInputStream(pslFile);
} catch (FileNotFoundException ex) {
logger.warning("Resource not found: " +
"lib/security/public_suffix_list.dat");
return null;
}
}
);
return is;
}
boolean match(String domain) {
Rule rule = rules.get(domain);
if (rule == Rule.EXCEPTION_RULE) {
return false;
} else if (rule == Rule.SIMPLE_RULE || rule == Rule.WILDCARD_RULE) {
return true;
} else {
int pos = domain.indexOf('.') + 1;
if (pos == 0) {
pos = domain.length();
}
String parent = domain.substring(pos);
return rules.get(parent) == Rule.WILDCARD_RULE;
}
}
}
/**
* Converts a map of rules to a string suitable for displaying
* in the log.
*/
private static String toLogString(Map rules) {
if (rules.isEmpty()) {
return "{}";
}
StringBuilder sb = new StringBuilder();
for (Map.Entry entry : rules.entrySet()) {
sb.append(String.format("%n "));
sb.append(entry.getKey());
sb.append(": ");
sb.append(entry.getValue());
}
return sb.toString();
}
}