lib/mcollective/security.rb

   1 module MCollective
   2   # Security is implimented using a module structure and installations
   3   # can configure which module they want to use.
   4   #
   5   # Security modules deal with various aspects of authentication and authorization:
   6   #
   7   # - Determines if a filter excludes this host from dealing with a request
   8   # - Serialization and Deserialization of messages
   9   # - Validation of messages against keys, certificates or whatever the class choose to impliment
  10   # - Encoding and Decoding of messages
  11   #
  12   # To impliment a new security class using SSL for example you would inherit from the base
  13   # class and only impliment:
  14   #
  15   # - decodemsg
  16   # - encodereply
  17   # - encoderequest
  18   # - validrequest?
  19   #
  20   # Each of these methods should increment various stats counters, see the default MCollective::Security::Psk module for examples of this
  21   #
  22   # Filtering can be extended by providing a new validate_filter? method.
  23   module Security
  24     autoload :Base, "mcollective/security/base"
  25   end
  26 end