doc/classes/MCollective/Security.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8   <title>Module: MCollective::Security</title>
   9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
  11   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  12   <script type="text/javascript">
  13   // <![CDATA[
  14
  15   function popupCode( url ) {
  16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  17   }
  18
  19   function toggleCode( id ) {
  20     if ( document.getElementById )
  21       elem = document.getElementById( id );
  22     else if ( document.all )
  23       elem = eval( "document.all." + id );
  24     else
  25       return false;
  26
  27     elemStyle = elem.style;
  28
  29     if ( elemStyle.display != "block" ) {
  30       elemStyle.display = "block"
  31     } else {
  32       elemStyle.display = "none"
  33     }
  34
  35     return true;
  36   }
  37
  38   // Make codeblocks hidden by default
  39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  40
  41   // ]]>
  42   </script>
  43
  44 </head>
  45 <body>
  46
  47
  48
  49     <div id="classHeader">
  50         <table class="header-table">
  51         <tr class="top-aligned-row">
  52           <td><strong>Module</strong></td>
  53           <td class="class-name-in-header">MCollective::Security</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/mcollective/security_rb.html">
  59                 lib/mcollective/security.rb
  60                 </a>
  61         <br />
  62                 <a href="../../files/lib/mcollective/security/base_rb.html">
  63                 lib/mcollective/security/base.rb
  64                 </a>
  65         <br />
  66             </td>
  67         </tr>
  68
  69         </table>
  70     </div>
  71   <!-- banner header -->
  72
  73   <div id="bodyContent">
  74
  75
  76
  77   <div id="contextContent">
  78
  79     <div id="description">
  80       <p>
  81 <a href="Security.html">Security</a> is implimented using a module
  82 structure and installations can configure which module they want to use.
  83 </p>
  84 <p>
  85 <a href="Security.html">Security</a> modules deal with various aspects of
  86 authentication and authorization:
  87 </p>
  88 <ul>
  89 <li>Determines if a filter excludes this host from dealing with a request
  90
  91 </li>
  92 <li>Serialization and Deserialization of messages
  93
  94 </li>
  95 <li>Validation of messages against keys, certificates or whatever the class
  96 choose to impliment
  97
  98 </li>
  99 <li>Encoding and Decoding of messages
 100
 101 </li>
 102 </ul>
 103 <p>
 104 To impliment a new security class using <a href="SSL.html">SSL</a> for
 105 example you would inherit from the base class and only impliment:
 106 </p>
 107 <ul>
 108 <li>decodemsg
 109
 110 </li>
 111 <li>encodereply
 112
 113 </li>
 114 <li>encoderequest
 115
 116 </li>
 117 <li>validrequest?
 118
 119 </li>
 120 </ul>
 121 <p>
 122 Each of these methods should increment various stats counters, see the
 123 default MCollective::Security::Psk module for examples of this
 124 </p>
 125 <p>
 126 Filtering can be extended by providing a new validate_filter? method.
 127 </p>
 128
 129     </div>
 130
 131
 132    </div>
 133
 134
 135   </div>
 136
 137
 138     <!-- if includes -->
 139
 140     <div id="section">
 141
 142     <div id="class-list">
 143       <h3 class="section-bar">Classes and Modules</h3>
 144
 145       Class <a href="Security/Base.html" class="link">MCollective::Security::Base</a><br />
 146
 147     </div>
 148
 149
 150
 151
 152
 153
 154
 155     <!-- if method_list -->
 156
 157
 158   </div>
 159
 160
 161 <div id="validator-badges">
 162   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 163 </div>
 164
 165 </body>
 166 </html>