[Openvas-commits] r8148 - trunk/doc/website
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Wed Jun 23 14:04:19 CEST 2010
Author: mattm
Date: 2010-06-23 14:04:18 +0200 (Wed, 23 Jun 2010)
New Revision: 8148
Modified:
trunk/doc/website/openvas-cr-28.htm4
Log:
Add missing modify commands.
Modified: trunk/doc/website/openvas-cr-28.htm4
===================================================================
--- trunk/doc/website/openvas-cr-28.htm4 2010-06-23 11:58:45 UTC (rev 8147)
+++ trunk/doc/website/openvas-cr-28.htm4 2010-06-23 12:04:18 UTC (rev 8148)
@@ -129,7 +129,7 @@
<p>
The OpenVAS Management Protocol is intended for use between OpenVAS clients
-and an OpenVAS Manager component.
+and an OpenVAS manager component.
</p>
<p>
@@ -213,7 +213,7 @@
<table id="index">
<tr id="index">
<td id="index"><a href="#authenticate">authenticate</a></td>
- <td id="index">Authenticate with the Manager.</td>
+ <td id="index">Authenticate with the manager.</td>
</tr>
<tr id="index">
<td id="index"><a href="#commands">commands</a></td>
@@ -442,7 +442,7 @@
<h4 id="authenticate">authenticate</h4>
<p>
-The client uses the authenticate command to authenticate with the Manager.
+The client uses the authenticate command to authenticate with the manager.
</p>
<p>
@@ -833,8 +833,8 @@
</p>
<p>
-If the command includes a password, then the Manager creates a password only
-credential, otherwise the Manager creates a key-based credential.
+If the command includes a password, then the manager creates a password only
+credential, otherwise the manager creates a key-based credential.
</p>
<p>
@@ -1004,7 +1004,7 @@
<create_override>
<text>This is actually of little concern.</text>
<nvt>1.3.6.1.4.1.25623.1.0.10330</nvt>
- <new_threat>Low;</new_threat>
+ <new_threat>Low</new_threat>
<result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
</create_override>
</pre>
@@ -2738,11 +2738,277 @@
</help_response>
</pre>
+<h4 id="modify_config">modify_config</h4>
+
+<p>
+The client uses the modify_config command to change an existing config. This
+command must include the ID of an existing config and either a preference,
+an NVT selection or a family selection.
+</p>
+
+<p>
+A preference must include a name.
+If the preference includes an NVT, then the preference is an NVT preference,
+otherwise the preference is a Scanner preference. If the preference includes
+a value then the manager updates the value of the preference, otherwise the
+manager removes the preference.
+</p>
+
+<p>
+An NVT selection must include a family and may include any number of NVTs.
+</p>
+
+<p>
+A family selection may include a "growing" and any number of families. A
+m4_dnl FIX the manager should check if families all have names, instead of just
+m4_dnl skipping them.
+family must include a name and may include an "all" and a "growing".
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+apply the changes to the config and will reply with a response code indicating
+success.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"config_id" is the ID of the config which should be changed.
+</ul>
+</p>
+
+<p>
+Command elements:
+<ul>
+ <li>
+ <preference>
+ <ul>
+ <li><name> is the name of a preference.
+ <li><nvt> is an empty element with an oid attribute.</li>
+m4_dnl FIX other places use <preference><name>name</name>value<preference> style
+m4_dnl FIX b64 for get_config preferences? how will simple clients handle this?
+ <li><value> is the new value of the preference, Base64 encoded.
+ </ul>
+ </li>
+ <li>
+ <family_selection>
+ <ul>
+ <li><growing> is an empty element.</li>
+ <li>
+ <family>
+ <ul>
+ <li><all> is an empty element.</li>
+ <li><growing> is an empty element.</li>
+ <li><name> is the name of an NVT family.</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <nvt_selection>
+ <ul>
+ <li><family> is the name of an NVT family</li>
+ <li><nvt> is an empty element with an oid attribute.</li>
+ </ul>
+ </li>
+</ul>
+</p>
+
+<h5>Example:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ <preference>
+ <nvt oid="1.3.6.1.4.1.25623.1.0.14259"/>
+ <name>UDP port scan</name>
+ <value>yes</value>
+ </preference>
+</modify_config>
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_config_response status="200" status_text="OK" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_config_response status="4xx" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_config_response status="500" status_text="Internal error" />
+</pre>
+
+<h4 id="modify_note">modify_note</h4>
+
+<p>
+The client uses the modify_note command to change an existing note. This
+m4_dnl FIX bit silly to require the text
+command must include the ID of an existing note and the note text.
+This command may include a host list, port, threat, task and result.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+apply the changes to the note and will reply with a response code indicating
+success.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"note_id" is the ID of the note which should be changed.
+</ul>
+</p>
+
+<p>
+Command elements:
+<ul>
+ <li><text> is a human-readable text up to 4000 characters in length.
+ <li><hosts> is a textual list of hosts.
+m4_dnl FIX should be <nvt oid=".."/>?
+ <li><port> is a port.
+ <li><threat> is a threat.
+m4_dnl FIX should be <task id=".."/>?
+ <li><task> is a task ID.
+m4_dnl FIX should be <result id=".."/>?
+ <li><result> is a result ID.
+</ul>
+</p>
+
+<h5>Example:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<modify_note note_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ <text>This issue should be resolved after the upgrade.</text>
+ <result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
+</modify_note>
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_note_response status="200" status_text="OK" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_note_response status="4xx" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_note_response status="500" status_text="Internal error" />
+</pre>
+
+<h4 id="modify_override">modify_override</h4>
+
+<p>
+The client uses the modify_override command to change an existing override.
+m4_dnl FIX bit silly to require the text
+This command must include the ID of an existing override and the override text.
+This command may include a host list, port, new_threat, threat, task and result.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+apply the changes to the override and will reply with a response code indicating
+success.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"override_id" is the ID of the override which should be changed.
+</ul>
+</p>
+
+<p>
+Command elements:
+<ul>
+ <li><text> is a human-readable text up to 4000 characters in length.
+ <li><hosts> is a textual list of hosts.
+m4_dnl FIX should be <nvt oid=".."/>?
+ <li><new_threat> is a threat.
+ <li><port> is a port.
+ <li><threat> is a threat.
+m4_dnl FIX should be <task id=".."/>?
+ <li><task> is a task ID.
+m4_dnl FIX should be <result id=".."/>?
+ <li><result> is a result ID.
+</ul>
+</p>
+
+<h5>Example:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<modify_override override_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ <text>This issue is less important in our setup.</text>
+ <new_threat>Low</result>
+</modify_override>
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_override_response status="200" status_text="OK" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_override_response status="4xx" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<modify_override_response status="500" status_text="Internal error" />
+</pre>
+
<h4 id="modify_report">modify_report</h4>
<p>
-The client uses the modify_report command to modify an existing report
-identified by its unique ID. This can be used to add a comment to a report.
+The client uses the modify_report command to modify an existing report.
+This command must include the ID of an existing report and a comment.
</p>
<p>
@@ -2761,8 +3027,7 @@
<p>
Command elements:
<ul>
- <li><parameter> is the new value for the parameter to change. The
- parameter is given in the "id" attribute.
+ <li><comment> is the new text for the comment.</li>
</ul>
</p>
@@ -2774,7 +3039,7 @@
<pre>
<modify_report report_id="65defe9b-bb28-4e85-9ed7-3f2a57ac8263">
- <parameter id="comment">This is the report where vulnerability XYZ was found on our Webserver.</parameter>
+ <comment>This is the report where vulnerability XYZ was found on our Webserver.</comment>
</modify_report>
</pre>
@@ -2783,31 +3048,25 @@
</p>
<pre>
-<modify_report_response status="200" report_id="65defe9b-bb28-4e85-9ed7-3f2a57ac8263" />
+<modify_report_response status="200" status_text="OK" />
</pre>
<h4 id="modify_task">modify_task</h4>
<p>
The client uses the modify_task command to change an existing task. This
-command must include the ID of an existing task and is expected to include at
-least one parameter and the new value for said parameter.
+m4_dnl FIX "either include" is actually "include one or more of" in manager
+command must include the ID of an existing task and must either include
+a name, a comment, an escalator, a schedule, an rcfile or a file.
</p>
<p>
If there was no error with the command sent by the client, the manager will
apply the changes to the task and will reply with a response code indicating
-success and the ID of the task which was modified.
+success.
</p>
<p>
-As a special case, the command can include any of the create_task
-parameters directly, via the <rcfile>, <name> and
-<comment> elements. The rcfile element is applied first, then name, then
-comment, and then any other parameters.
-</p>
-
-<p>
Command attributes:
<ul>
<li>"task_id" is the ID of the task which should be changed.
@@ -2817,14 +3076,15 @@
<p>
Command elements:
<ul>
- <li><parameter> contains the name of the parameter to change (e.g.
-max_hosts, port_range) in the id attribute and the
-new value for the parameter in question.
- <li><rcfile> is a file describing the task. As of OMP 1.0, this file is a file
-in the openvasrc format. The file must be Base64 encoded.
-m4_dnl FIX Are these lengths required?
+ <li><rcfile> is a file describing the task. As of OMP 1.0, this file is
+in the openvasrc format. The file must be Base64 encoded.
<li><name> is a human-readable identifier up to 100 characters in length.
<li><comment> is a human-readable text up to 4000 characters in length.
+ <li><escalator> is an empty element with an id attribute.
+ <li><schedule> is an empty element with an id attribute.
+ <li><file> is the text of a file, with name and action attributes. The
+ file must be Base64 encoded. Name is the name the manager associates with
+ the file. Action must be either "update" or "remove".</li>
</ul>
</p>
@@ -2836,7 +3096,6 @@
<pre>
<modify_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
- <parameter id="max_hosts">10</parameter>
<comment>Monthly scan of the webserver</comment>
</modify_task>
</pre>
@@ -2846,7 +3105,7 @@
</p>
<pre>
-<modify_task_response status="201" status_text="OK, resource created" task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6" />
+<modify_task_response status="200" status_text="OK" />
</pre>
<p>
@@ -2854,7 +3113,7 @@
</p>
<pre>
-<modify_task_response status="4xx" task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6" />
+<modify_task_response status="4xx" />
</pre>
<p>
@@ -2862,7 +3121,7 @@
</p>
<pre>
-<modify_task_response status="500" status_text="Internal error" task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6" />
+<modify_task_response status="500" status_text="Internal error" />
</pre>
<h4 id="pause_task">pause_task</h4>
More information about the Openvas-commits
mailing list