com.android.tools.lint.checks

Class NetworkSecurityConfigDetector

java.lang.Object

com.android.tools.lint.detector.api.Detector

com.android.tools.lint.detector.api.ResourceXmlDetector

com.android.tools.lint.checks.NetworkSecurityConfigDetector

All Implemented Interfaces:

com.android.tools.lint.detector.api.FileScanner, com.android.tools.lint.detector.api.XmlScanner, com.android.tools.lint.detector.api.XmlScannerConstants

public class NetworkSecurityConfigDetector
extends com.android.tools.lint.detector.api.ResourceXmlDetector

Check which makes sure that a network-security-config descriptor file is valid and logical.

Nested Class Summary

Nested classes/interfaces inherited from class com.android.tools.lint.detector.api.Detector

com.android.tools.lint.detector.api.Detector.BinaryResourceScanner, com.android.tools.lint.detector.api.Detector.ClassScanner, com.android.tools.lint.detector.api.Detector.GradleScanner, com.android.tools.lint.detector.api.Detector.OtherFileScanner, com.android.tools.lint.detector.api.Detector.ResourceFolderScanner, com.android.tools.lint.detector.api.Detector.UastScanner, com.android.tools.lint.detector.api.Detector.XmlScanner

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_DIGEST
static com.android.tools.lint.detector.api.Implementation	IMPLEMENTATION
static com.android.tools.lint.detector.api.Issue	INSECURE_CONFIGURATION Base configuration allows cleartext by default.
static com.android.tools.lint.detector.api.Issue	ISSUE Validate the entire network-security-config descriptor.
static com.android.tools.lint.detector.api.Issue	MISSING_BACKUP_PIN No backup pin specified.
static com.android.tools.lint.detector.api.Issue	PIN_SET_EXPIRY Validate the pin-set expiration attribute and warn if the expiry is in the near future.
static java.util.Set<java.lang.String>	VALID_BASE_TAGS

Fields inherited from interface com.android.tools.lint.detector.api.XmlScannerConstants

ALL

Constructor Summary

Constructors

Constructor and Description
NetworkSecurityConfigDetector() Constructs a new NetworkSecurityConfigDetector

Method Summary

Modifier and Type	Method and Description
boolean	appliesTo(com.android.resources.ResourceFolderType folderType)
void	beforeCheckRootProject(com.android.tools.lint.detector.api.Context context)
static java.util.List<java.lang.String>	getAttributeSpellingSuggestions(java.lang.String errorAttribute, java.lang.String parentTag) For a given misspelled attribute, return the allowed suggestions/corrections.
static java.util.List<java.lang.String>	getSupportedPinDigestAlgorithms() Used by the IDE for quick fixes.
static java.util.List<java.lang.String>	getTagSpellingSuggestions(java.lang.String errorTag, java.lang.String parentTag) For a given misspelled attribute, return the allowed suggestions/corrections.
static boolean	isAttributeSpellingError(java.lang.String errorMessage) For a given error message created by this lint detector, returns whether the error was due to a typo in an attribute name.
static boolean	isTagSpellingError(java.lang.String errorMessage)
void	visitDocument(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Document document)

Methods inherited from class com.android.tools.lint.detector.api.ResourceXmlDetector

run

Methods inherited from class com.android.tools.lint.detector.api.Detector

afterCheckEachProject, afterCheckFile, afterCheckLibraryProject, afterCheckProject, afterCheckRootProject, analyzeCallGraph, applicableAnnotations, applicableSuperClasses, appliesTo, appliesToResourceRefs, beforeCheckEachProject, beforeCheckFile, beforeCheckLibraryProject, beforeCheckProject, checkBinaryResource, checkCall, checkClass, checkClass, checkDslPropertyAssignment, checkDslPropertyAssignment, checkFolder, checkInstruction, checkMethodCall, createPsiVisitor, createUastHandler, fix, getApplicableAsmNodeTypes, getApplicableAttributes, getApplicableCallNames, getApplicableCallOwners, getApplicableConstructorTypes, getApplicableElements, getApplicableFiles, getApplicableMethodNames, getApplicablePsiTypes, getApplicableReferenceNames, getApplicableUastTypes, getCustomVisitor, getSpeed, inheritAnnotation, isApplicableAnnotationUsage, isCallGraphRequired, visitAnnotationUsage, visitAnnotationUsage, visitAttribute, visitBuildScript, visitClass, visitClass, visitConstructor, visitConstructor, visitElement, visitElementAfter, visitMethod, visitMethod, visitMethodCall, visitReference, visitReference, visitResourceReference, visitResourceReference

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.android.tools.lint.detector.api.XmlScanner

getApplicableAttributes, getApplicableElements, visitAttribute, visitElement, visitElementAfter

Methods inherited from interface com.android.tools.lint.detector.api.FileScanner

afterCheckFile, beforeCheckFile

Field Detail

IMPLEMENTATION

public static final com.android.tools.lint.detector.api.Implementation IMPLEMENTATION

ISSUE

public static final com.android.tools.lint.detector.api.Issue ISSUE

Validate the entire network-security-config descriptor.

PIN_SET_EXPIRY

public static final com.android.tools.lint.detector.api.Issue PIN_SET_EXPIRY

Validate the pin-set expiration attribute and warn if the expiry is in the near future.

MISSING_BACKUP_PIN

public static final com.android.tools.lint.detector.api.Issue MISSING_BACKUP_PIN

No backup pin specified.

INSECURE_CONFIGURATION

public static final com.android.tools.lint.detector.api.Issue INSECURE_CONFIGURATION

Base configuration allows cleartext by default.

ATTR_DIGEST

public static final java.lang.String ATTR_DIGEST

See Also:

Constant Field Values

VALID_BASE_TAGS

public static final java.util.Set<java.lang.String> VALID_BASE_TAGS

Constructor Detail

NetworkSecurityConfigDetector

public NetworkSecurityConfigDetector()

Constructs a new NetworkSecurityConfigDetector

Method Detail

appliesTo

public boolean appliesTo(@NonNull
                         com.android.resources.ResourceFolderType folderType)

Specified by:

appliesTo in interface com.android.tools.lint.detector.api.XmlScanner

Overrides:

appliesTo in class com.android.tools.lint.detector.api.ResourceXmlDetector

beforeCheckRootProject

public void beforeCheckRootProject(@NonNull
                                   com.android.tools.lint.detector.api.Context context)

Overrides:

beforeCheckRootProject in class com.android.tools.lint.detector.api.Detector

visitDocument

public void visitDocument(@NonNull
                          com.android.tools.lint.detector.api.XmlContext context,
                          @NonNull
                          org.w3c.dom.Document document)

Specified by:

visitDocument in interface com.android.tools.lint.detector.api.XmlScanner

Overrides:

visitDocument in class com.android.tools.lint.detector.api.Detector

isAttributeSpellingError

public static boolean isAttributeSpellingError(@NonNull
                                               java.lang.String errorMessage)

For a given error message created by this lint detector, returns whether the error was due to a typo in an attribute name. This is primarily for use by IDE quick fixes.

Parameters:

errorMessage - The error message associated with this detector.

Returns:

true if this is a spelling error in an attribute.

getAttributeSpellingSuggestions

@NonNull
public static java.util.List<java.lang.String> getAttributeSpellingSuggestions(@NonNull
                                                                                        java.lang.String errorAttribute,
                                                                                        @NonNull
                                                                                        java.lang.String parentTag)

For a given misspelled attribute, return the allowed suggestions/corrections.

Parameters:

errorAttribute - the misspelled attribute

parentTag - the parent tag used for determining the allowed attributes

Returns:

list of strings containing the suggestions or null if no suggestions

isTagSpellingError

public static boolean isTagSpellingError(@NonNull
                                         java.lang.String errorMessage)

Parameters:

errorMessage - The error message associated with this detector.

Returns:

true if this is a spelling error in the element name.

getTagSpellingSuggestions

@NonNull
public static java.util.List<java.lang.String> getTagSpellingSuggestions(@NonNull
                                                                                  java.lang.String errorTag,
                                                                                  @NonNull
                                                                                  java.lang.String parentTag)

For a given misspelled attribute, return the allowed suggestions/corrections.

Parameters:

errorTag - the misspelled attribute

parentTag - the parent tag used for determining the allowed attributes

Returns:

list of strings containing the suggestions or null if no suggestions

getSupportedPinDigestAlgorithms

public static java.util.List<java.lang.String> getSupportedPinDigestAlgorithms()

Used by the IDE for quick fixes.

Returns:

supported pin digest algorithms