MethodSourceSinkDefinition (soot-infoflow 2.10.4 API)

java.lang.Object
- soot.jimple.infoflow.sourcesSinks.definitions.AbstractSourceSinkDefinition
- - soot.jimple.infoflow.sourcesSinks.definitions.MethodSourceSinkDefinition

所有已实现的接口:

IAccessPathBasedSourceSinkDefinition, ISourceSinkDefinition
```
public class MethodSourceSinkDefinition
extends AbstractSourceSinkDefinition
implements IAccessPathBasedSourceSinkDefinition
```
A class to handle all access paths of sources and sinks for a certain method.

作者:

Daniel Magin, Steven Arzt

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`MethodSourceSinkDefinition.CallType` Enumeration containing the different types of method invocations that can be defined as sources or sinks

字段概要

字段
限定符和类型	字段和说明
`protected Set<AccessPathTuple>`	`baseObjects`
`protected MethodSourceSinkDefinition.CallType`	`callType`
`protected SootMethodAndClass`	`method`
`protected Set<AccessPathTuple>[]`	`parameters`
`protected Set<AccessPathTuple>`	`returnValues`

从类继承的字段 soot.jimple.infoflow.sourcesSinks.definitions.AbstractSourceSinkDefinition
category

构造器概要

构造器
构造器和说明
`MethodSourceSinkDefinition(Set<AccessPathTuple> baseObjects, Set<AccessPathTuple>[] parameters, Set<AccessPathTuple> returnValues, MethodSourceSinkDefinition.CallType callType)` Creates a new instance of the `MethodSourceSinkDefinition` class without a method.
`MethodSourceSinkDefinition(SootMethodAndClass am)` Creates a new instance of the `MethodSourceSinkDefinition` class
`MethodSourceSinkDefinition(SootMethodAndClass am, MethodSourceSinkDefinition.CallType callType)` Creates a new instance of the `MethodSourceSinkDefinition` class
`MethodSourceSinkDefinition(SootMethodAndClass am, Set<AccessPathTuple> baseObjects, Set<AccessPathTuple>[] parameters, Set<AccessPathTuple> returnValues, MethodSourceSinkDefinition.CallType callType)` Creates a new instance of the MethodSourceSinkDefinition class
`MethodSourceSinkDefinition(SootMethodAndClass am, Set<AccessPathTuple> baseObjects, Set<AccessPathTuple>[] parameters, Set<AccessPathTuple> returnValues, MethodSourceSinkDefinition.CallType callType, ISourceSinkCategory category)` Creates a new instance of the MethodSourceSinkDefinition class

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addParameterDefinition(int paramIdx, Set<AccessPathTuple> paramDefs)` Adds the given access path tuples to this source/sink definition for the given parameter index
`protected MethodSourceSinkDefinition`	`buildNewDefinition(Set<AccessPathTuple> baseAPTs, Set<AccessPathTuple>[] paramAPTs, Set<AccessPathTuple> returnAPTs)` Factory method for creating a new method-based source/sink definition based on the current one.
`protected MethodSourceSinkDefinition`	`buildNewDefinition(SootMethodAndClass methodAndclass, Set<AccessPathTuple> filteredBaseObjects, Set<AccessPathTuple>[] filteredParameters, Set<AccessPathTuple> filteredReturnValues, MethodSourceSinkDefinition.CallType callType)`
`static MethodSourceSinkDefinition`	`createParameterSource(int index, MethodSourceSinkDefinition.CallType callType)` Creates a source definition that considers a parameter as tainted
`static MethodSourceSinkDefinition`	`createReturnSource(MethodSourceSinkDefinition.CallType callType)` Creates a source definition that considers the return value as tainted
`boolean`	`equals(Object obj)`
`MethodSourceSinkDefinition`	`filter(Collection<AccessPathTuple> accessPaths)` Filters the source/sink definition to only reference the given access paths
`Set<AccessPathTuple>`	`getAllAccessPaths()` Gets all access paths referenced in this source or sink definition, regardless of their respective semantics
`int`	`getBaseObjectCount()` Gets the number of access paths defined as sources or sinks on base objects
`Set<AccessPathTuple>`	`getBaseObjects()` Gets the source and sink definitions for the base object on which a method of this class is invoked
`MethodSourceSinkDefinition`	`getBaseObjectSink()` Gets the shared sink definition that is not associated with any method and taints the base object
`MethodSourceSinkDefinition`	`getBaseObjectSource()` Gets the shared source definition that is not associated with any method and taints the base object
`MethodSourceSinkDefinition.CallType`	`getCallType()` Gets the type of method invocations that are denoted by this source or sink
`SootMethodAndClass`	`getMethod()` Gets the method for which this object defines sources and sinks
`int`	`getParameterCount()` Gets the number of access paths defined as sources or sinks on parameters
`Set<AccessPathTuple>[]`	`getParameters()` Gets the source and sink definitions for parameters of the current method
`int`	`getReturnValueCount()` Gets the number of access paths defined as sources or sinks on return values
`Set<AccessPathTuple>`	`getReturnValues()` Gets the source definitions for the return value of the current method
`MethodSourceSinkDefinition`	`getSinkOnlyDefinition()` Creates a definition which is a subset of this definition that only contains the sinks
`MethodSourceSinkDefinition`	`getSourceOnlyDefinition()` Creates a definition which is a subset of this definition that only contains the sources
`int`	`hashCode()`
`boolean`	`isEmpty()` Checks whether this source/sink definition is empty, i.e., has no concrete access paths
`void`	`merge(ISourceSinkDefinition other)` Merges the source and sink definitions of the given definition object into this definition object
`MethodSourceSinkDefinition`	`simplify()` Checks whether this definition is equivalent to one of the simple predefined ones.
`String`	`toString()`

从类继承的方法 soot.jimple.infoflow.sourcesSinks.definitions.AbstractSourceSinkDefinition
getCategory, setCategory

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 soot.jimple.infoflow.sourcesSinks.definitions.ISourceSinkDefinition
getCategory, setCategory

- 字段详细资料
  - method
```
protected final SootMethodAndClass method
```
  - callType
```
protected final MethodSourceSinkDefinition.CallType callType
```
  - baseObjects
```
protected Set<AccessPathTuple> baseObjects
```
  - parameters
```
protected Set<AccessPathTuple>[] parameters
```
  - returnValues
```
protected Set<AccessPathTuple> returnValues
```
- 构造器详细资料
  - MethodSourceSinkDefinition
```
public MethodSourceSinkDefinition(Set<AccessPathTuple> baseObjects,
                                  Set<AccessPathTuple>[] parameters,
                                  Set<AccessPathTuple> returnValues,
                                  MethodSourceSinkDefinition.CallType callType)
```
    Creates a new instance of the MethodSourceSinkDefinition class without a method. This constructor is intended to be used for sources that arise from UI elements or other programming constructs that are not directly associated with a single method being called.
  - MethodSourceSinkDefinition
```
public MethodSourceSinkDefinition(SootMethodAndClass am)
```
    Creates a new instance of the MethodSourceSinkDefinition class
    
    参数:
    
    am - The method for which this object defines sources and sinks
  - MethodSourceSinkDefinition
```
public MethodSourceSinkDefinition(SootMethodAndClass am,
                                  MethodSourceSinkDefinition.CallType callType)
```
    Creates a new instance of the MethodSourceSinkDefinition class
    
    参数:
    
    am - The method for which this object defines sources and sinks
    
    callType - The type of calls to define as sources or sinks
  - MethodSourceSinkDefinition
```
public MethodSourceSinkDefinition(SootMethodAndClass am,
                                  Set<AccessPathTuple> baseObjects,
                                  Set<AccessPathTuple>[] parameters,
                                  Set<AccessPathTuple> returnValues,
                                  MethodSourceSinkDefinition.CallType callType)
```
    Creates a new instance of the MethodSourceSinkDefinition class
    
    参数:
    
    am - The method for which this object defines sources and sinks
    
    baseObjects - The source and sink definitions for the base object on which a method of this class is invoked
    
    parameters - The source and sink definitions for parameters of the current method
    
    callType - The type of calls to define as sources or sinks
    
    returnValues - The source definitions for the return value of the current method
  - MethodSourceSinkDefinition
```
public MethodSourceSinkDefinition(SootMethodAndClass am,
                                  Set<AccessPathTuple> baseObjects,
                                  Set<AccessPathTuple>[] parameters,
                                  Set<AccessPathTuple> returnValues,
                                  MethodSourceSinkDefinition.CallType callType,
                                  ISourceSinkCategory category)
```
    Creates a new instance of the MethodSourceSinkDefinition class
    
    参数:
    
    am - The method for which this object defines sources and sinks
    
    baseObjects - The source and sink definitions for the base object on which a method of this class is invoked
    
    parameters - The source and sink definitions for parameters of the current method
    
    returnValues - The source definitions for the return value of the current method
    
    callType - The type of calls to define as sources or sinks
    
    category - The category to which this source or sink belongs
- 方法详细资料
  - getMethod
```
public SootMethodAndClass getMethod()
```
    Gets the method for which this object defines sources and sinks
    
    返回:
    
    The method for which this object defines sources and sinks
  - getCallType
```
public MethodSourceSinkDefinition.CallType getCallType()
```
    Gets the type of method invocations that are denoted by this source or sink
    
    返回:
    
    The type of method invocations that are denoted by this source or sink
  - getBaseObjects
```
public Set<AccessPathTuple> getBaseObjects()
```
    Gets the source and sink definitions for the base object on which a method of this class is invoked
    
    返回:
    
    The source and sink definitions for the base object
  - getBaseObjectCount
```
public int getBaseObjectCount()
```
    Gets the number of access paths defined as sources or sinks on base objects
    
    返回:
    
    The number of access paths defined as sources or sinks on base objects
  - getParameters
```
public Set<AccessPathTuple>[] getParameters()
```
    Gets the source and sink definitions for parameters of the current method
    
    返回:
    
    The source and sink definitions for parameters
  - getParameterCount
```
public int getParameterCount()
```
    Gets the number of access paths defined as sources or sinks on parameters
    
    返回:
    
    The number of access paths defined as sources or sinks on parameters
  - getReturnValues
```
public Set<AccessPathTuple> getReturnValues()
```
    Gets the source definitions for the return value of the current method
    
    返回:
    
    The source definitions for the return value
  - getReturnValueCount
```
public int getReturnValueCount()
```
    Gets the number of access paths defined as sources or sinks on return values
    
    返回:
    
    The number of access paths defined as sources or sinks on return values
  - isEmpty
```
public boolean isEmpty()
```
    从接口复制的说明: IAccessPathBasedSourceSinkDefinition
    
    Checks whether this source/sink definition is empty, i.e., has no concrete access paths
    
    指定者:
    
    isEmpty 在接口中 IAccessPathBasedSourceSinkDefinition
    
    指定者:
    
    isEmpty 在接口中 ISourceSinkDefinition
    
    返回:
    
    True if this source/sink definition is empty, i.e., has no concrete access paths, otherwise false
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getSourceOnlyDefinition
```
public MethodSourceSinkDefinition getSourceOnlyDefinition()
```
    从接口复制的说明: IAccessPathBasedSourceSinkDefinition
    
    Creates a definition which is a subset of this definition that only contains the sources
    
    指定者:
    
    getSourceOnlyDefinition 在接口中 IAccessPathBasedSourceSinkDefinition
    
    指定者:
    
    getSourceOnlyDefinition 在接口中 ISourceSinkDefinition
    
    返回:
    
    The source-only subset of this definition
  - getSinkOnlyDefinition
```
public MethodSourceSinkDefinition getSinkOnlyDefinition()
```
    从接口复制的说明: IAccessPathBasedSourceSinkDefinition
    
    Creates a definition which is a subset of this definition that only contains the sinks
    
    指定者:
    
    getSinkOnlyDefinition 在接口中 IAccessPathBasedSourceSinkDefinition
    
    指定者:
    
    getSinkOnlyDefinition 在接口中 ISourceSinkDefinition
    
    返回:
    
    The sink-only subset of this definition
  - buildNewDefinition
```
protected MethodSourceSinkDefinition buildNewDefinition(Set<AccessPathTuple> baseAPTs,
                                                        Set<AccessPathTuple>[] paramAPTs,
                                                        Set<AccessPathTuple> returnAPTs)
```
    Factory method for creating a new method-based source/sink definition based on the current one. This method is used when transforming the current definition. Derived classes can override this method to create instances of the correct class.
    
    参数:
    
    baseAPTs - The access paths rooted in the base object
    
    paramAPTs - The access paths rooted in the method's parameters
    
    returnAPTs - The access paths rooted in the return value
    
    返回:
    
    The new source/sink definition object
  - buildNewDefinition
```
protected MethodSourceSinkDefinition buildNewDefinition(SootMethodAndClass methodAndclass,
                                                        Set<AccessPathTuple> filteredBaseObjects,
                                                        Set<AccessPathTuple>[] filteredParameters,
                                                        Set<AccessPathTuple> filteredReturnValues,
                                                        MethodSourceSinkDefinition.CallType callType)
```
  - merge
```
public void merge(ISourceSinkDefinition other)
```
    从接口复制的说明: ISourceSinkDefinition
    
    Merges the source and sink definitions of the given definition object into this definition object
    
    指定者:
    
    merge 在接口中 ISourceSinkDefinition
    
    参数:
    
    other - The definition object to merge
  - addParameterDefinition
```
public void addParameterDefinition(int paramIdx,
                                   Set<AccessPathTuple> paramDefs)
```
    Adds the given access path tuples to this source/sink definition for the given parameter index
    
    参数:
    
    paramIdx - The parameter index
    
    paramDefs - The access path tuples
  - getBaseObjectSource
```
public MethodSourceSinkDefinition getBaseObjectSource()
```
    Gets the shared source definition that is not associated with any method and taints the base object
    
    返回:
    
    The shared blank source definition that is not associated with any method and taints the base object
  - getBaseObjectSink
```
public MethodSourceSinkDefinition getBaseObjectSink()
```
    Gets the shared sink definition that is not associated with any method and taints the base object
    
    返回:
    
    The shared blank sink definition that is not associated with any method and taints the base object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 AbstractSourceSinkDefinition
  - equals
```
public boolean equals(Object obj)
```
    覆盖:
    
    equals 在类中 AbstractSourceSinkDefinition
  - createParameterSource
```
public static MethodSourceSinkDefinition createParameterSource(int index,
                                                               MethodSourceSinkDefinition.CallType callType)
```
    Creates a source definition that considers a parameter as tainted
    
    参数:
    
    index - The index of the parameter to consider as tainted
    
    callType - The type of call
    
    返回:
    
    The newly created source definition
  - createReturnSource
```
public static MethodSourceSinkDefinition createReturnSource(MethodSourceSinkDefinition.CallType callType)
```
    Creates a source definition that considers the return value as tainted
    
    参数:
    
    callType - The type of call
    
    返回:
    
    The newly created source definition
  - simplify
```
public MethodSourceSinkDefinition simplify()
```
    Checks whether this definition is equivalent to one of the simple predefined ones. If so, it returns the shared predefined object. Otherwise, it returns this object.
    
    返回:
    
    A shared object that is equal to this one if possible, otherwise this object
  - getAllAccessPaths
```
public Set<AccessPathTuple> getAllAccessPaths()
```
    从接口复制的说明: IAccessPathBasedSourceSinkDefinition
    
    Gets all access paths referenced in this source or sink definition, regardless of their respective semantics
    
    指定者:
    
    getAllAccessPaths 在接口中 IAccessPathBasedSourceSinkDefinition
    
    返回:
    
    All access paths referenced in this source or sink definition. The return value can be null if this definition does not reference any access paths.
  - filter
```
public MethodSourceSinkDefinition filter(Collection<AccessPathTuple> accessPaths)
```
    从接口复制的说明: IAccessPathBasedSourceSinkDefinition
    
    Filters the source/sink definition to only reference the given access paths
    
    指定者:
    
    filter 在接口中 IAccessPathBasedSourceSinkDefinition
    
    参数:
    
    accessPaths - The access path to which to limit the scope of this source/sink definition
    
    返回:
    
    A copy of this source/sink definition that only references the given access paths

类 MethodSourceSinkDefinition

嵌套类概要

字段概要

从类继承的字段 soot.jimple.infoflow.sourcesSinks.definitions.AbstractSourceSinkDefinition

构造器概要

方法概要

从类继承的方法 soot.jimple.infoflow.sourcesSinks.definitions.AbstractSourceSinkDefinition

从类继承的方法 java.lang.Object

从接口继承的方法 soot.jimple.infoflow.sourcesSinks.definitions.ISourceSinkDefinition

字段详细资料

method

callType

baseObjects

parameters

returnValues

构造器详细资料

MethodSourceSinkDefinition

MethodSourceSinkDefinition

MethodSourceSinkDefinition

MethodSourceSinkDefinition

MethodSourceSinkDefinition

方法详细资料

getMethod

getCallType

getBaseObjects

getBaseObjectCount

getParameters

getParameterCount

getReturnValues

getReturnValueCount

isEmpty

toString

getSourceOnlyDefinition

getSinkOnlyDefinition

buildNewDefinition

buildNewDefinition

merge

addParameterDefinition

getBaseObjectSource

getBaseObjectSink

hashCode

equals

createParameterSource

createReturnSource

simplify

getAllAccessPaths

filter