Documentation/English (British)/developer-chapter3-guidance.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\r
   4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
   5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
   6                 <title>Xestia Scanner Server Documentation - Developer Documentation - 3.1 Guidance</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Xestia Scanner Server</span>\r
  12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
  13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
  14 <a href="developer.html">Developer Documentation</a>\r
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">3.1 Guidance</span>\r
  19 <br><br>\r
  20 When creating a new authentication module to be used in Xestia Scanner Server, the following is required:\r
  21 <br><br>\r
  22 When creating a new authentication module, at the top of the page the following should be inserted:\r
  23 <br><br>\r
  24 <div class="code">\r
  25 package Modules::Auth::(modulename);<br>\r
  26 <br>\r
  27 use strict;<br>\r
  28 use warnings;<br>\r
  29 <br>\r
  30 our $VERSION = "(version)";<br>\r
  31 my ($options, %options);<br>\r
  32 my $database_handle;<br>\r
  33 my $statement_handle;<br>\r
  34 my $error;<br>\r
  35 my $errorext;<br>\r
  36 </div>\r
  37 <br><br>\r
  38 Replace (modulename) with the name of the module like PostgreSQL (which means PostgreSQL database server version 5.x). When specifying the module name it should be the name of the format (PostgreSQL).\r
  39 <br><br>\r
  40 'use strict' and 'use warnings' isn't required but it is generally accepted that Perl scripts and modules should have 'use strict' and 'use warnings' lines written.\r
  41 <br><br>\r
  42 Replace (version) with the internal version number of the module.\r
  43 <br><br>\r
  44 Authentication modules are stored in the Modules/Auth directory. For an example of a written authentication module look at the PostgreSQL.pm file.\r
  45 <br><br>\r
  46 If an authentication error occurs while preforming a authentication operation then the error string from the database handle scalar ($database_handle) should be placed in the $errorext scalar.\r
  47                 </div>\r
  48         </body>\r
  49 </html>\r