doc/MCollective/RPC/Audit.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>Class: MCollective::RPC::Audit</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="class">
  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/rpc/audit_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/rpc/audit.rb">lib/mcollective/rpc/audit.rb</a></li>
  33
  34                                         </ul>
  35                                 </div>
  36                         </div>
  37
  38
  39                 </div>
  40
  41                 <div id="class-metadata">
  42
  43                         <!-- Parent Class -->
  44
  45                         <div id="parent-class-section" class="section">
  46                                 <h3 class="section-header">Parent</h3>
  47
  48                                 <p class="link"><a href="../../Object.html">Object</a></p>
  49
  50                         </div>
  51
  52
  53                         <!-- Namespace Contents -->
  54
  55
  56                         <!-- Method Quickref -->
  57
  58                         <div id="method-list-section" class="section">
  59                                 <h3 class="section-header">Methods</h3>
  60                                 <ul class="link-list">
  61
  62                                         <li><a href="#M000408">::inherited</a></li>
  63
  64                                         <li><a href="#M000409">#audit_request</a></li>
  65
  66                                 </ul>
  67                         </div>
  68
  69
  70                         <!-- Included Modules -->
  71
  72                 </div>
  73
  74                 <div id="project-metadata">
  75
  76
  77                         <div id="fileindex-section" class="section project-section">
  78                                 <h3 class="section-header">Files</h3>
  79                                 <ul>
  80
  81                                         <li class="file"><a href="../../COPYING.html">COPYING</a></li>
  82
  83                                         <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
  84
  85                                         <li class="file"><a href="../../README.html">README</a></li>
  86
  87                                         <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
  88
  89                                         <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  90
  91                                         <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
  92
  93                                         <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
  94
  95                                         <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
  96
  97                                         <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
  98
  99                                         <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
 100
 101                                         <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
 102
 103                                         <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 104
 105                                         <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 106
 107                                         <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 108
 109                                         <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 110
 111                                         <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 112
 113                                         <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 114
 115                                         <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 116
 117                                         <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 118
 119                                         <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
 120
 121                                 </ul>
 122                         </div>
 123
 124
 125                         <div id="classindex-section" class="section project-section">
 126                                 <h3 class="section-header">Class Index
 127                                         <span class="search-toggle"><img src="../../images/find.png"
 128                                                 height="16" width="16" alt="[+]"
 129                                                 title="show/hide quicksearch" /></span></h3>
 130                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 131                                 <fieldset>
 132                                         <legend>Quicksearch</legend>
 133                                         <input type="text" name="quicksearch" value=""
 134                                                 class="quicksearch-field" />
 135                                 </fieldset>
 136                                 </form>
 137
 138                                 <ul class="link-list">
 139
 140                                         <li><a href="../../MCollective.html">MCollective</a></li>
 141
 142                                         <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
 143
 144                                         <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
 145
 146                                         <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 147
 148                                         <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 149
 150                                         <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 151
 152                                         <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 153
 154                                         <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 155
 156                                         <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 157
 158                                         <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
 159
 160                                         <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
 161
 162                                         <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
 163
 164                                         <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
 165
 166                                         <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
 167
 168                                         <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
 169
 170                                         <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
 171
 172                                         <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 173
 174                                         <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
 175
 176                                         <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 177
 178                                         <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 179
 180                                         <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 181
 182                                         <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 183
 184                                         <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 185
 186                                         <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 187
 188                                         <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
 189
 190                                         <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 191
 192                                         <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 193
 194                                         <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
 195
 196                                         <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
 197
 198                                         <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 199
 200                                         <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
 201
 202                                         <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 203
 204                                         <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 205
 206                                         <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 207
 208                                         <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 209
 210                                         <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
 211
 212                                         <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
 213
 214                                         <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 215
 216                                         <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 217
 218                                         <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 219
 220                                         <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 221
 222                                         <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
 223
 224                                         <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 225
 226                                         <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 227
 228                                         <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
 229
 230                                         <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 231
 232                                         <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 233
 234                                         <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 235
 236                                         <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 237
 238                                         <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 239
 240                                         <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 241
 242                                         <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 243
 244                                         <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 245
 246                                         <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 247
 248                                         <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
 249
 250                                         <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 251
 252                                         <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 253
 254                                         <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 255
 256                                         <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 257
 258                                         <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 259
 260                                         <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 261
 262                                         <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 263
 264                                         <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 265
 266                                         <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 267
 268                                         <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 269
 270                                         <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 271
 272                                         <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
 273
 274                                         <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
 275
 276                                         <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 277
 278                                         <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
 279
 280                                         <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 281
 282                                         <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
 283
 284                                         <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
 285
 286                                         <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 287
 288                                         <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 289
 290                                         <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
 291
 292                                         <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
 293
 294                                         <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 295
 296                                         <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 297
 298                                         <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 299
 300                                         <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
 301
 302                                         <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
 303
 304                                         <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 305
 306                                         <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 307
 308                                         <li><a href="../../Array.html">Array</a></li>
 309
 310                                         <li><a href="../../Dir.html">Dir</a></li>
 311
 312                                         <li><a href="../../Object.html">Object</a></li>
 313
 314                                         <li><a href="../../String.html">String</a></li>
 315
 316                                         <li><a href="../../Symbol.html">Symbol</a></li>
 317
 318                                 </ul>
 319                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 320                         </div>
 321
 322
 323                 </div>
 324         </div>
 325
 326         <div id="documentation">
 327                 <h1 class="class">MCollective::RPC::Audit</h1>
 328
 329                 <div id="description">
 330                         <p>
 331 Auditing of requests is done only for SimpleRPC requests, you provide a
 332 plugin in the MCollective::Audit::* namespace which the SimpleRPC framework
 333 calls for each message
 334 </p>
 335 <p>
 336 We provide a simple one that logs to a logfile in the class
 337 MCollective::Audit::Logfile you can create your own:
 338 </p>
 339 <p>
 340 Create a class in plugins/mcollective/audit/<yourplugin>.rb
 341 </p>
 342 <p>
 343 You must inherit from <a href="Audit.html">MCollective::RPC::Audit</a>
 344 which will take care of registering you with the plugin system.
 345 </p>
 346 <p>
 347 Your plugin must provide <a
 348 href="Audit.html#M000409">audit_request</a>(request, connection) the
 349 request parameter will be an instance of <a
 350 href="Request.html">MCollective::RPC::Request</a>
 351 </p>
 352 <p>
 353 To enable auditing you should set:
 354 </p>
 355 <p>
 356 rpcaudit = 1 rpcauditprovider = Logfile
 357 </p>
 358 <p>
 359 in the config file this will enable logging using the
 360 MCollective::Audit::Logile class
 361 </p>
 362 <p>
 363 The <a href="Audit.html">Audit</a> class acts as a base for audit plugins
 364 and takes care of registering them with the plugin manager
 365 </p>
 366
 367                 </div>
 368
 369                 <!-- Constants -->
 370
 371
 372                 <!-- Attributes -->
 373
 374
 375                 <!-- Methods -->
 376
 377                 <div id="public-class-method-details" class="method-section section">
 378                         <h3 class="section-header">Public Class Methods</h3>
 379
 380
 381                         <div id="inherited-method" class="method-detail ">
 382                                 <a name="M000408"></a>
 383
 384                                 <div class="method-heading">
 385
 386                                         <span class="method-name">inherited</span><span
 387                                                 class="method-args">(klass)</span>
 388                                         <span class="method-click-advice">click to toggle source</span>
 389
 390                                 </div>
 391
 392                                 <div class="method-description">
 393
 394                                         <p class="missing-docs">(Not documented)</p>
 395
 396
 397
 398                                         <div class="method-source-code"
 399                                                 id="inherited-source">
 400 <pre>
 401     <span class="ruby-comment cmt"># File lib/mcollective/rpc/audit.rb, line 29</span>
 402 29:       <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
 403 30:         <span class="ruby-constant">PluginManager</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;rpcaudit_plugin&quot;</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>}
 404 31:       <span class="ruby-keyword kw">end</span></pre>
 405                                         </div>
 406
 407                                 </div>
 408
 409
 410                         </div>
 411
 412
 413                 </div>
 414
 415                 <div id="public-instance-method-details" class="method-section section">
 416                         <h3 class="section-header">Public Instance Methods</h3>
 417
 418
 419                         <div id="audit-request-method" class="method-detail ">
 420                                 <a name="M000409"></a>
 421
 422                                 <div class="method-heading">
 423
 424                                         <span class="method-name">audit_request</span><span
 425                                                 class="method-args">(request, connection)</span>
 426                                         <span class="method-click-advice">click to toggle source</span>
 427
 428                                 </div>
 429
 430                                 <div class="method-description">
 431
 432                                         <p class="missing-docs">(Not documented)</p>
 433
 434
 435
 436                                         <div class="method-source-code"
 437                                                 id="audit-request-source">
 438 <pre>
 439     <span class="ruby-comment cmt"># File lib/mcollective/rpc/audit.rb, line 33</span>
 440 33:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">audit_request</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">connection</span>)
 441 34:         <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">&quot;audit_request is not implimented in #{this.class}&quot;</span>)
 442 35:       <span class="ruby-keyword kw">end</span></pre>
 443                                         </div>
 444
 445                                 </div>
 446
 447
 448                         </div>
 449
 450
 451                 </div>
 452
 453
 454         </div>
 455
 456
 457         <div id="rdoc-debugging-section-dump" class="debugging-section">
 458
 459                 <p>Disabled; run with --debug to generate this.</p>
 460
 461         </div>
 462
 463         <div id="validator-badges">
 464                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 465                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 466                         Rdoc Generator</a> 1.1.6</small>.</p>
 467         </div>
 468
 469 </body>
 470 </html>
 471