~ubuntu-branches/ubuntu/karmic/openvas-server/karmic

« back to all changes in this revision

Viewing changes to doc/ntp/plugin_prefs.txt

  • Committer: Bazaar Package Importer
  • Author(s): Javier Fernandez-Sanguino Pen~a
  • Date: 2009-01-02 01:38:47 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20090102013847-74xy2uo1e3hovqjo
Tags: 2.0.0-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#
2
 
# Plugins preferences
3
 
#
4
 
# written by Renaud Deraison <deraison@cvs.nessus.org>
5
 
#
6
 
# Revisions :   
7
 
#               19/04/01 : added types 'password' and 'file'
8
 
#               03/01/99 : clearly stated that a client may
9
 
#                          not take these preferences in account
10
 
#               09/03/98 : first public release
11
 
#
12
 
 
13
 
 
14
 
A client MAY not take this paper in consideration and may silently
15
 
ignore this specification, but I don't recommand it -- try to have
16
 
as many features as possible.
17
 
 
18
 
 
19
 
The plugins preferences idea comes from Thomas B. Bigalke <bigalke@bigfoot.de>
20
 
 
21
 
 
22
 
  Some 'advanced' plugins will need their own preferences (ie : BruteForce
23
 
attack plugins will need the path to a wordlist).
24
 
 
25
 
This paper assumes that you are familiar with the NTP/1.0 and NTP/1.1 protocols.
26
 
 
27
 
 
28
 
The preferences of the plugins are sent by the server in the 
29
 
PREFERENCES message, among the preferences of the server, and have the 
30
 
following format :
31
 
 
32
 
Plugin Name[preference_type]:name <|> default value
33
 
 
34
 
 
35
 
Where :
36
 
 
37
 
o 'Plugin name' is the name of the plugin which needs the preferences
38
 
o 'preference_type' is the type of the widget used by the preference
39
 
o 'name' is the name of the preference
40
 
o 'default_value' is the default value of the preference.
41
 
 
42
 
 
43
 
+ preference_type :
44
 
 
45
 
preference_type is one of the following string :
46
 
"checkbox" : means that the plugin will have two values : 'yes'
47
 
             or no. The client should show this preference by
48
 
             a checkbox.
49
 
             
50
 
"entry"    : means that the preference will have an infinity of values,
51
 
             since it will be shown by the client as a text entry.
52
 
 
53
 
"password" : same as entry, but instructs the client to _not_ show
54
 
             the text typed by the user (and eventually to cipher it
55
 
             if storing it on disk)
56
 
             
57
 
"radio"    : means that the preference will have a restricted set of
58
 
             values, shown by the client as a set of radio buttons.
59
 
             If selected, the 'default_value' string will have the
60
 
             following format : 'value1;value2;value3...;valueN', and
61
 
             the client will select the first value by default
62
 
             
63
 
 
64
 
"file"     : means that there is an attached file in the rest of the
65
 
             message. The value returned by the client must be the 
66
 
             name of a file, as described the in the ATTACHED_FILE
67
 
             message.
68
 
             
69
 
             
70
 
+ default values :
71
 
 
72
 
Depends on the value of 'preference_type' :
73
 
 
74
 
       
75
 
         --------------------++----------------------
76
 
         preference_type     ||        default_value
77
 
         ====================||======================
78
 
                             ||
79
 
          checkbox           ||       'yes' or 'no'
80
 
         ____________________||______________________
81
 
                             ||
82
 
           entry|password    ||         anything
83
 
         ____________________||______________________
84
 
                             ||
85
 
           radio             ||   value1;value2;....
86
 
                             ||
87
 
         --------------------||----------------------
88
 
                             ||
89
 
           file              ||        <none>
90
 
         ____________________||______________________
91
 
         
92
 
        
93
 
        
94
 
comments : mailto:deraison@cvs.nessus.org