[Openvas-commits] r8205 - trunk/doc/website

[scm-commit@wald.intevation.org]

Author: mattm
Date: 2010-06-27 18:06:06 +0200 (Sun, 27 Jun 2010)
New Revision: 8205

Modified:
   trunk/doc/website/openvas-cr-28.htm4
Log:
Try describe protocol a bit more.  Add real headings.

Modified: trunk/doc/website/openvas-cr-28.htm4
===================================================================
--- trunk/doc/website/openvas-cr-28.htm4	2010-06-27 15:37:12 UTC (rev 8204)
+++ trunk/doc/website/openvas-cr-28.htm4	2010-06-27 16:06:06 UTC (rev 8205)
@@ -125,7 +125,7 @@
 thus allow for privilege separation.
 </p>
 
-<h4>Design Considerations</h4>
+<h4>Protocol Design</h4>
 
 <p>
 The OpenVAS Management Protocol is intended for use between OpenVAS clients
@@ -163,7 +163,27 @@
 </p>
 
 <p>
-Numerical response codes:<br>
+The OMP communication between a client and the manager takes a simple command
+response form.  The client sends a command, a single XML element, to the
+manager.  The manager responds with a single XML element.
+</p>
+
+<p>
+There is a predefined set of OMP commands, each of which is described
+<a href="#command_summary">below</a>.
+</p>
+
+<p>
+For a client, using OMP centers around creating and manipulating resources.
+The key resource is the task.  A task defines a network vulnerability scan.
+The scan can be performed by running the task, for example with the start_task
+command.  A task is created with the create_task command by combining at least
+two of the other resources: a config and a target.
+</p>
+
+<h5>Numerical response codes</h5>
+
+<p>
 The OpenVAS manager uses numerical response codes to indicate whether a command
 issued by the client could be executed successfully. The response codes are
 very similar to the response codes used by HTTP as specified in <a
@@ -180,17 +200,19 @@
 by this protocol.
 </p>
 
+<h5>Unique ID scheme</h5>
+
 <p>
-Unique ID scheme:<br>
 The protocol uses random UUIDs as described in <a
 href="http://www.ietf.org/rfc/rfc4122.txt">RFC 4122</a>.
 </p>
 
+<h5>Authentication</h5>
+
 <p>
-Authentication:<br>
-The client is expected to send an authentication element at the beginning of
+The client is expected to execute an authentication command at the beginning of
 each connection.
-This element looks like the following:
+This command looks like the following:
 <pre>
 &lt;authentication&gt;
   &lt;credentials&gt;
@@ -205,10 +227,9 @@
 <pre>
 &lt;authentication_response status="400" status_text="Authentication failed" /&gt;
 </pre>
-m4_dnl FIX closed if XML syntax error (after error response)
 </p>
 
-<h4>Summary of Protocol Primitives / Commands</h4>
+<h4 id="command_summary">Summary of Protocol Primitives / Commands</h4>
 
 <table id="index">
 <tr id="index">