--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Module: MCollective::Security</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Module</strong></td>
+ <td class="class-name-in-header">MCollective::Security</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/lib/mcollective/security_rb.html">
+ lib/mcollective/security.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/security/base_rb.html">
+ lib/mcollective/security/base.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+<a href="Security.html">Security</a> is implimented using a module
+structure and installations can configure which module they want to use.
+</p>
+<p>
+<a href="Security.html">Security</a> modules deal with various aspects of
+authentication and authorization:
+</p>
+<ul>
+<li>Determines if a filter excludes this host from dealing with a request
+
+</li>
+<li>Serialization and Deserialization of messages
+
+</li>
+<li>Validation of messages against keys, certificates or whatever the class
+choose to impliment
+
+</li>
+<li>Encoding and Decoding of messages
+
+</li>
+</ul>
+<p>
+To impliment a new security class using <a href="SSL.html">SSL</a> for
+example you would inherit from the base class and only impliment:
+</p>
+<ul>
+<li>decodemsg
+
+</li>
+<li>encodereply
+
+</li>
+<li>encoderequest
+
+</li>
+<li>validrequest?
+
+</li>
+</ul>
+<p>
+Each of these methods should increment various stats counters, see the
+default MCollective::Security::Psk module for examples of this
+</p>
+<p>
+Filtering can be extended by providing a new validate_filter? method.
+</p>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+ <div id="class-list">
+ <h3 class="section-bar">Classes and Modules</h3>
+
+ Class <a href="Security/Base.html" class="link">MCollective::Security::Base</a><br />
+
+ </div>
+
+
+
+
+
+
+
+ <!-- if method_list -->
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file
Code Review / packages / precise / mcollective.git / blobdiff