io.spring.nohttp.checkstyle.check.NoHttpCheck Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.spring.nohttp.checkstyle.check;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.ExternalResourceHolder;
import com.puppycrawl.tools.checkstyle.api.FileText;
import io.spring.nohttp.*;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
*
* NoHttpCheck verifies that your build has no http:// URLs but ignores URLs that cannot
* be https://.
*
*
*
* NOTE: If you are using Gradle, see nohttp-gradle project.
*
*
*
* While many checkstyle configurations only impact your source and resources, it is
* important that no http checks are performed on all the files within your repository.
* For example, you will want to ensure that you validate your build files like pom.xml
* and build.gradle.
*
*
* Configurations
*
* Example configurations can be found below:
*
*
* This configuration allows externalizing the allowlist.
*
*
* <?xml version="1.0"?>
* <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
* "https://www.puppycrawl.com/dtds/configuration_1_3.dtd">
* <module name="Checker">
*
* <!-- Configure checker to use UTF-8 encoding -->
* <property name="charset" value="UTF-8"/>
* <!-- Configure checker to run on files with all extensions -->
* <property name="fileExtensions" value=""/>
*
* <module name="io.spring.nohttp.checkstyle.check.NoHttpCheck">
* </module>
* </module>
*
*
* allowlistFileName
*
*
* If you find the need to exclude additional URL patterns, you can do so by including.
*
*
*
* <module name="io.spring.nohttp.checkstyle.check.NoHttpCheck">
* <!-- the file name to load for white listing. If an empty String nothing is used -->
* <property name="allowlistFileName" value="config/nohttp/allowlist.lines"/>
* </module>
*
*
*
* It is important to note that you use checkstyle properties to load the file as well.
* If you want to make the property optional, you can specify a default of empty String
* in which case the additional allowlist is ignored.
*
*
*
* <module name="io.spring.nohttp.checkstyle.check.NoHttpCheck">
* <!-- the file name to load for white listing. If an empty String nothing is used -->
* <property name="allowlistFileName" value="${nohttp.checkstyle.allowlistFileName}" default=""/>
* </module>
*
*
* allowlist
*
* This configuration property allows embedding the allowlist into the checkstyle
* configuration. The example below allowlists both http://example.com and
* http://example.org
*
*
* <module name="io.spring.nohttp.checkstyle.check.NoHttpCheck">
* <!-- the allowlist. Make sure to use for newlines -->
* <property name="allowlist" value="^\Qhttp://example.com\E$
* ^\Qhttp://example.org\E$" default=""/>
* </module>
*
*
* @author Rob Winch
*/
public class NoHttpCheck extends AbstractFileSetCheck implements ExternalResourceHolder {
private HttpMatcher matcher;
private String allowlistFileName = "";
private String allowlist = "";
public void setAllowlistFileName(String allowlistFileName) {
if (allowlistFileName == null) {
throw new IllegalArgumentException("allowlistFileName cannot be null");
}
this.allowlistFileName = allowlistFileName;
}
/**
* Sets the allowlist to use
* @param allowlist the allowlist to use
* @since 0.0.3
*/
public void setAllowlist(String allowlist) {
if (allowlist == null) {
throw new IllegalArgumentException("allowlist cannot be null");
}
this.allowlist = allowlist;
}
/**
* Sets the allow list file name
* @param allowlistFileName
* @deprecated Use {@link #setAllowlistFileName(String)} instead
*/
@Deprecated
public void setWhitelistFileName(String allowlistFileName) {
setAllowlistFileName(allowlistFileName);
}
/**
* Sets the allow list to use
* @param allowlist the allowlist to use
* @deprecated use {@link #setAllowlist(String)}
*/
@Deprecated
public void setWhitelist(String allowlist) {
setWhitelistFileName(allowlist);
}
private boolean isAllowlistFileSet() {
return !this.allowlistFileName.isEmpty();
}
private boolean isAllowlistSet() {
return !this.allowlist.isEmpty();
}
private InputStream createAllowlistInputStream() {
File allowlistFile = new File(this.allowlistFileName);
try {
return new FileInputStream(allowlistFile);
} catch (FileNotFoundException e) {
throw new IllegalStateException("Could not load file '" + allowlistFile +"'", e);
}
}
@Override
protected void finishLocalSetup() throws CheckstyleException {
RegexHttpMatcher matcher = new RegexHttpMatcher(RegexPredicate.createDefaultUrlAllowlist());
if (isAllowlistFileSet()) {
InputStream inputStream = createAllowlistInputStream();
matcher.addHttpAllow(RegexPredicate.createAllowlistFromPatterns(inputStream));
}
if (isAllowlistSet()) {
InputStream inputStream = new ByteArrayInputStream(this.allowlist.getBytes());
matcher.addHttpAllow(RegexPredicate.createAllowlistFromPatterns(inputStream));
}
this.matcher = matcher;
}
@Override
protected void processFiltered(File file, FileText fileText)
throws CheckstyleException {
int lineNum = 0;
for (int index = 0; index < fileText.size(); index++) {
final String line = fileText.get(index);
lineNum++;
List results = this.matcher.findHttp(line);
for(HttpMatchResult result : results) {
log(lineNum, result.getStart() + 1, "nohttp", result.getHttp());
}
}
}
@Override
public Set getExternalResourceLocations() {
Set result = new HashSet<>();
if (isAllowlistFileSet()) {
result.add(this.allowlistFileName);
}
return result;
}
}