doc/MCollective/Security.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   7
   8         <title>Module: MCollective::Security</title>
   9
  10         <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
  11
  12         <script src="../js/jquery.js" type="text/javascript"
  13                 charset="utf-8"></script>
  14         <script src="../js/thickbox-compressed.js" type="text/javascript"
  15                 charset="utf-8"></script>
  16         <script src="../js/quicksearch.js" type="text/javascript"
  17                 charset="utf-8"></script>
  18         <script src="../js/darkfish.js" type="text/javascript"
  19                 charset="utf-8"></script>
  20
  21 </head>
  22 <body class="module">
  23
  24         <div id="metadata">
  25                 <div id="file-metadata">
  26                         <div id="file-list-section" class="section">
  27                                 <h3 class="section-header">In Files</h3>
  28                                 <div class="section-body">
  29                                         <ul>
  30
  31                                                 <li><a href="../lib/mcollective/security_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/security.rb">lib/mcollective/security.rb</a></li>
  33
  34                                                 <li><a href="../lib/mcollective/security/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  35                                                         class="thickbox" title="lib/mcollective/security/base.rb">lib/mcollective/security/base.rb</a></li>
  36
  37                                         </ul>
  38                                 </div>
  39                         </div>
  40
  41
  42                 </div>
  43
  44                 <div id="class-metadata">
  45
  46                         <!-- Parent Class -->
  47
  48
  49                         <!-- Namespace Contents -->
  50
  51                         <div id="namespace-list-section" class="section">
  52                                 <h3 class="section-header">Namespace</h3>
  53                                 <ul class="link-list">
  54
  55                                         <li><span class="type">CLASS</span> <a href="Security/Base.html">MCollective::Security::Base</a></li>
  56
  57                                 </ul>
  58                         </div>
  59
  60
  61                         <!-- Method Quickref -->
  62
  63
  64                         <!-- Included Modules -->
  65
  66                 </div>
  67
  68                 <div id="project-metadata">
  69
  70
  71                         <div id="fileindex-section" class="section project-section">
  72                                 <h3 class="section-header">Files</h3>
  73                                 <ul>
  74
  75                                         <li class="file"><a href="../COPYING.html">COPYING</a></li>
  76
  77                                         <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
  78
  79                                         <li class="file"><a href="../README.html">README</a></li>
  80
  81                                         <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
  82
  83                                         <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  84
  85                                         <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
  86
  87                                         <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
  88
  89                                         <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
  90
  91                                         <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
  92
  93                                         <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
  94
  95                                         <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
  96
  97                                         <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
  98
  99                                         <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 100
 101                                         <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 102
 103                                         <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 104
 105                                         <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 106
 107                                         <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 108
 109                                         <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 110
 111                                         <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 112
 113                                         <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
 114
 115                                 </ul>
 116                         </div>
 117
 118
 119                         <div id="classindex-section" class="section project-section">
 120                                 <h3 class="section-header">Class Index
 121                                         <span class="search-toggle"><img src="../images/find.png"
 122                                                 height="16" width="16" alt="[+]"
 123                                                 title="show/hide quicksearch" /></span></h3>
 124                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 125                                 <fieldset>
 126                                         <legend>Quicksearch</legend>
 127                                         <input type="text" name="quicksearch" value=""
 128                                                 class="quicksearch-field" />
 129                                 </fieldset>
 130                                 </form>
 131
 132                                 <ul class="link-list">
 133
 134                                         <li><a href="../MCollective.html">MCollective</a></li>
 135
 136                                         <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
 137
 138                                         <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
 139
 140                                         <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 141
 142                                         <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 143
 144                                         <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 145
 146                                         <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 147
 148                                         <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 149
 150                                         <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 151
 152                                         <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
 153
 154                                         <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
 155
 156                                         <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
 157
 158                                         <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
 159
 160                                         <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
 161
 162                                         <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
 163
 164                                         <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
 165
 166                                         <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 167
 168                                         <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
 169
 170                                         <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 171
 172                                         <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 173
 174                                         <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 175
 176                                         <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 177
 178                                         <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 179
 180                                         <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 181
 182                                         <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
 183
 184                                         <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 185
 186                                         <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 187
 188                                         <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
 189
 190                                         <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
 191
 192                                         <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 193
 194                                         <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
 195
 196                                         <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 197
 198                                         <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 199
 200                                         <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 201
 202                                         <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 203
 204                                         <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
 205
 206                                         <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
 207
 208                                         <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 209
 210                                         <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 211
 212                                         <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 213
 214                                         <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 215
 216                                         <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
 217
 218                                         <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 219
 220                                         <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 221
 222                                         <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
 223
 224                                         <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 225
 226                                         <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 227
 228                                         <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 229
 230                                         <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 231
 232                                         <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 233
 234                                         <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 235
 236                                         <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 237
 238                                         <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 239
 240                                         <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 241
 242                                         <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
 243
 244                                         <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 245
 246                                         <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 247
 248                                         <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 249
 250                                         <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 251
 252                                         <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 253
 254                                         <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 255
 256                                         <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 257
 258                                         <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 259
 260                                         <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 261
 262                                         <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 263
 264                                         <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 265
 266                                         <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
 267
 268                                         <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
 269
 270                                         <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 271
 272                                         <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
 273
 274                                         <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 275
 276                                         <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
 277
 278                                         <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
 279
 280                                         <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 281
 282                                         <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 283
 284                                         <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
 285
 286                                         <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
 287
 288                                         <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 289
 290                                         <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 291
 292                                         <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 293
 294                                         <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
 295
 296                                         <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
 297
 298                                         <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 299
 300                                         <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 301
 302                                         <li><a href="../Array.html">Array</a></li>
 303
 304                                         <li><a href="../Dir.html">Dir</a></li>
 305
 306                                         <li><a href="../Object.html">Object</a></li>
 307
 308                                         <li><a href="../String.html">String</a></li>
 309
 310                                         <li><a href="../Symbol.html">Symbol</a></li>
 311
 312                                 </ul>
 313                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 314                         </div>
 315
 316
 317                 </div>
 318         </div>
 319
 320         <div id="documentation">
 321                 <h1 class="module">MCollective::Security</h1>
 322
 323                 <div id="description">
 324                         <p>
 325 <a href="Security.html">Security</a> is implimented using a module
 326 structure and installations can configure which module they want to use.
 327 </p>
 328 <p>
 329 <a href="Security.html">Security</a> modules deal with various aspects of
 330 authentication and authorization:
 331 </p>
 332 <ul>
 333 <li>Determines if a filter excludes this host from dealing with a request
 334
 335 </li>
 336 <li>Serialization and Deserialization of messages
 337
 338 </li>
 339 <li>Validation of messages against keys, certificates or whatever the class
 340 choose to impliment
 341
 342 </li>
 343 <li>Encoding and Decoding of messages
 344
 345 </li>
 346 </ul>
 347 <p>
 348 To impliment a new security class using <a href="SSL.html">SSL</a> for
 349 example you would inherit from the base class and only impliment:
 350 </p>
 351 <ul>
 352 <li>decodemsg
 353
 354 </li>
 355 <li>encodereply
 356
 357 </li>
 358 <li>encoderequest
 359
 360 </li>
 361 <li>validrequest?
 362
 363 </li>
 364 </ul>
 365 <p>
 366 Each of these methods should increment various stats counters, see the
 367 default MCollective::Security::Psk module for examples of this
 368 </p>
 369 <p>
 370 Filtering can be extended by providing a new validate_filter? method.
 371 </p>
 372
 373                 </div>
 374
 375                 <!-- Constants -->
 376
 377
 378                 <!-- Attributes -->
 379
 380
 381                 <!-- Methods -->
 382
 383
 384         </div>
 385
 386
 387         <div id="rdoc-debugging-section-dump" class="debugging-section">
 388
 389                 <p>Disabled; run with --debug to generate this.</p>
 390
 391         </div>
 392
 393         <div id="validator-badges">
 394                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 395                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 396                         Rdoc Generator</a> 1.1.6</small>.</p>
 397         </div>
 398
 399 </body>
 400 </html>
 401