X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=doc%2Fclasses%2FMCollective%2FSecurity.html;fp=doc%2Fclasses%2FMCollective%2FSecurity.html;h=739dccb99baa78f7d448c3bb4d881206be230c0e;hb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;hp=0000000000000000000000000000000000000000;hpb=8a3fe7daeecccf43dd71c59371c5005400d35101;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/classes/MCollective/Security.html b/doc/classes/MCollective/Security.html new file mode 100644 index 0000000..739dccb --- /dev/null +++ b/doc/classes/MCollective/Security.html @@ -0,0 +1,166 @@ + + + + + + Module: MCollective::Security + + + + + + + + + + +
+ + + + + + + + + + +
ModuleMCollective::Security
In: + + lib/mcollective/security.rb + +
+ + lib/mcollective/security/base.rb + +
+
+
+ + +
+ + + +
+ +
+

+Security is implimented using a module +structure and installations can configure which module they want to use. +

+

+Security modules deal with various aspects of +authentication and authorization: +

+
    +
  • Determines if a filter excludes this host from dealing with a request + +
    • +
  • Serialization and Deserialization of messages + +
    • +
  • Validation of messages against keys, certificates or whatever the class +choose to impliment + +
    • +
  • Encoding and Decoding of messages + +
    • +
+

+To impliment a new security class using SSL for +example you would inherit from the base class and only impliment: +

+
    +
  • decodemsg + +
    • +
  • encodereply + +
    • +
  • encoderequest + +
    • +
  • validrequest? + +
    • +
+

+Each of these methods should increment various stats counters, see the +default MCollective::Security::Psk module for examples of this +

+

+Filtering can be extended by providing a new validate_filter? method. +

+ +
+ + +
+ + +
+ + + + +
+ +
+

Classes and Modules

+ + Class MCollective::Security::Base
+ +
+ + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file