deni-eng-27 / cpanelapicalltracer Goto Github PK

cPanel API Call Tracer

This package contains the cPanel API Call Tracer, which is used to trace cPanel's API1 and API2.  

This allows you to view the input and output from every API call used within the cPanel interface.  This module should NEVER be used on a production server for more than a few seconds as all passwords used in the APIs are passed to it and logged to a file.  Furthermore, it create a possible race condition where two users can attempt to write to the same file, causing the cPanel interface to crash.

To disable it, after it's use, simply move /usr/local/cpanel/Cpanel/CustomEventHandler.pm to another filename.

Version 1.0

INSTALL
-------
Copy Dumper.pm to /usr/local/cpanel/perl/Data
Copy CustomEvenyHandler.pm to /usr/local/cpanel/Cpanel, if you have a previous existing CustomEventHandler in place, you will need to move it out of the way in order to use this module

USAGE
-----
This will output all information relevant to an API call in Data::Dumper format to the error_log.

Please consult the Data::Dumper documentation on CPAN for information on what the various symbols used in the output mean.

$cfgref is the input provided to API calls
$dataref is the output given by API calls

LICENSE
-------
# Copyright (c) 2011, cPanel, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification, are permitted provided
# that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this list of conditions and the
#   following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
#   following disclaimer in the documentation and/or other materials provided with the distribution.
# * Neither the name of the cPanel, Inc. nor the names of its contributors may be used to endorse or promote
#   products derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
# WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.