|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class defines the interface which must be implemented by all probes
Method Summary | |
void |
addDepends(java.lang.String name)
This method adds an element to the underlying implementations list of depends for this probe. |
void |
addOption(java.lang.String name,
java.lang.String value)
This method adds a key->value pair to the options table for this probe. |
void |
addProvides(java.lang.String name,
java.lang.String descr)
This method adds an element to the underlying implementations list of resources this probe provides. |
void |
addReport(java.lang.String rep)
This method concats the specified string to the end of the existing report string and appends a newline. |
java.util.Vector |
depends()
Return a vector of the KB keys this probe requires to run. |
java.util.Properties |
dumpOptions()
This method provides the probe handling subsystems with a way to get a reference to the Properties objec which stores the configuration options for this probe. |
java.lang.String |
getCopyright()
Get the copyright string for the current probe. |
ProbeException |
getException()
|
java.lang.String |
getFamily()
The getFamily() method should return a string representing what interface this probe implements. |
java.lang.String |
getHelp()
Return the Help String for this probe |
java.lang.String |
getHost()
The getHost() method wraps the current Target's getHost() method to allow the probe to know who it's supposed to poke. |
java.lang.String |
getName()
The getName() method should return a short unique name for the probe to use in descriptions. |
java.lang.String |
getOption(java.lang.String name)
This method returns the value of the specified option key. |
java.util.Vector |
getOptionKeys()
This function returns a Vector of the keys in the Properties table which represents this probe's configuration options |
int |
getProbeId()
Each probe will have a unique ID assigned. |
java.lang.String |
getReport()
This method returns a String which represents the current reportable information in the probe. |
int |
getSeverity()
This method returns the severity (0-3) of the report the probe would like to make. |
Target |
getTarget()
Return this probe's target |
int |
getTimeout()
Get the timeout in milliseconds that this probe should use when running. |
java.lang.String |
getVersion()
Get the version string for this probe. |
boolean |
hasSafe()
This function should return true ONLY if the function probeSafe() is capable of detecting the specified vuln. |
boolean |
isEnabled()
Checks to see if the current probe is enabled. |
boolean |
isReportable()
|
java.lang.Object |
kbGet(java.lang.String key)
The kbGet() method wraps the kbGet() method for the currently set target. |
boolean |
kbHas(java.lang.String key)
This method wraps the underlying Target's kbHas() method to determine if the current Target has the specified key in it's current KB. |
void |
kbPut(java.lang.String key,
java.lang.Object obj)
The kbPut() method wraps the underlying Target kbPut() method to allow probes access to Target KB's regardless of implementaion. |
void |
probe()
Carry out the probe. |
void |
probeSafe()
Carry out the _safe_ version of the probe. |
java.util.Hashtable |
provides()
Return a Hashtable of the KB keys this probe provides sets and their descriptions. |
void |
replaceOptions(java.util.Properties prop)
This method is used by the scan configuration loader to override the default configuration options for the probe. |
void |
setCopyright(java.lang.String crght)
Set the copyright string for this probe which is reported in the Help->about probes. |
void |
setEnabled(boolean bol)
Sets the boolean enabled status of this probe |
void |
setFamily(java.lang.String newFam)
Use the setFamily() method to set the family (more importantly the tab in the UI) for this probe. |
void |
setHelp(java.lang.String help)
Set the String value returened by the getHelp() method (used by the UI |
void |
setName(java.lang.String myname)
Set the name of this probe. |
void |
setProbeId(int x)
Set the probeId of the probe. |
void |
setReport(java.lang.String rep)
This method sets (overwrites) the current report String value. |
void |
setReportable(boolean x)
Set the probe to be reportable, which makes the attacker threads add it's report to the target upon probe completion |
void |
setSeverity(int x)
This method sets the severity of the report which the probe will return to the attacker threads. |
void |
setTarget(Target targ)
Give the probe it's target |
void |
setTimeout(int timeout)
Set the timeout in milliseconds that this probe should use when running. |
void |
setVersion(java.lang.String ver)
Set the version string for this probe. |
Methods inherited from interface java.lang.Runnable |
run |
Method Detail |
public int getProbeId()
public void setProbeId(int x)
x
- int which will be used to uniquely identify each probepublic java.lang.String getFamily()
public void setFamily(java.lang.String newFam)
newFam
- String name of the new probe familypublic java.lang.String getName()
public void setName(java.lang.String myname)
myname
- String representation of the name of this probepublic boolean hasSafe()
public void probe() throws ProbeException
ProbeException
- These exceptions are thrown when failure causes the probe to be unable to determine weather or not the target is vulnerable.public void probeSafe() throws ProbeException
ProbeException
- These exceptions are thrown when failure causes the probe to be unable to determine weather or not the target is vulnerable.public void setTarget(Target targ)
targ
- set the com.securitycentric.metacoretex.lib.Target
object this probe will use to carry out attackspublic Target getTarget()
public boolean isEnabled()
public void setEnabled(boolean bol)
bol
- Set the enabled status of this probepublic java.util.Vector depends()
public java.util.Hashtable provides()
public java.util.Vector getOptionKeys()
public java.util.Properties dumpOptions()
public void replaceOptions(java.util.Properties prop)
prop
- New Properties object for this probe to use.public void addDepends(java.lang.String name)
name
- String representation of the KB key for the value this
probe depends upon.public void addProvides(java.lang.String name, java.lang.String descr)
name
- String representation of the KB key which thisdescr
- String description of the provided KB key
probe provides.public java.lang.String getReport()
public void setReport(java.lang.String rep)
rep
- String of report datapublic void addReport(java.lang.String rep)
rep
- String string to be concated to current report stringpublic void addOption(java.lang.String name, java.lang.String value)
name
- String representation of the Properties key (name)
for this optionvalue
- String representation of the value for this configuration option.public java.lang.String getOption(java.lang.String name)
name
- String representation of the key for the key->value
pair.
public void setVersion(java.lang.String ver)
ver
- String versionpublic java.lang.String getVersion()
public java.lang.Object kbGet(java.lang.String key)
key
- String representation of the key (name) of the
option in the Target KB
public void kbPut(java.lang.String key, java.lang.Object obj)
key
- String key for the Target KBobj
- Object to insert into the KBpublic boolean kbHas(java.lang.String key)
key
- String key to test for in the KB
public java.lang.String getHost()
public int getSeverity()
public boolean isReportable()
public void setReportable(boolean x)
public ProbeException getException()
public void setSeverity(int x)
x
- int representation of the severity (see getSeverity() for definitions)public void setHelp(java.lang.String help)
help
- String help/config informationpublic java.lang.String getHelp()
public void setCopyright(java.lang.String crght)
public java.lang.String getCopyright()
public int getTimeout()
public void setTimeout(int timeout)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |