Files
beef/core/api/server/handler.rb
scotty.b.brown@gmail.com 5c3e6f1575 Adding Apache Licence Header to all files (except VERSION file)
git-svn-id: https://beef.googlecode.com/svn/trunk@1046 b87d56ec-f9c0-11de-8c8a-61c5e9addfc9
2011-07-02 23:08:28 +00:00

78 lines
1.9 KiB
Ruby

#
# Copyright 2011 Wade Alcorn wade@bindshell.net
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
module BeEF
module API
module Server
#
# All modules that extend the Handler API will be called during handler mounting,
# dismounting, managing operations.
#
# You want to use that API if you are developing an extension that requires to create
# a new http handler to receive responses.
#
# Example:
#
# module A
# extend BeEF::API::Server::Handler
# end
#
#
# BeEF Core then calls all the Handler extension modules like this:
#
# BeEF::API::Server::Handler.extended_in_modules.each do |mod|
# ...
# end
#
module Handler
API_PATHS = {
'pre_http_start' => :pre_http_start,
'mount_handlers' => :mount_handlers
}
#
# This method is being called when the BeEF server mounts handlers
#
# See BeEF::Extension::AdminUI::API::Handler as an example.
#
# Example:
#
# module A
# extend BeEF::API::Server::Handler
#
# def mount_handlers(beef_server)
# ...
# end
# end
#
def mount_handlers(beef_server)
#
# Here's an example of how you could use it:
#
# beef_server.mount('/demos/', true, WEBrick::HTTPServlet::FileHandler, "#{$root_dir}/demos/")
#
end
def pre_http_start(http_hook_server)
end
end
end
end
end