phproxy source code readme

_____________________________________________________________________

source code version 0.4 - september 7th 2005

latest version: http://www.sourceforge.net/projects/poxy/

copyright 2005 ultimategamer00 (abdullah a.)

contact
_____________________________________________________________________

email: [email protected]
website: http://www.whitefyre.com/poxy/

support
_____________________________________________________________________

http://www.sourceforge.net/projects/poxy/
look for the forums

table of contents
_____________________________________________________________________

1. license
2. what is phproxy?
3. how it works
4. requirements
5. installation
6. configurable script variables
7. available options
8. legal disclaimer
9. changelog, faq, todo, license, bugs, limitations
10. credits

1. license
_____________________________________________________________________

this source code is released under the gpl.

a copy of the license in provided in this package in the file
named license.txt

2. what is phproxy?
_____________________________________________________________________

phproxy is a web http (for now; ftp is not supprted yet) proxy
designed to bypass proxy restrictions through
a web interface very similar to the popular cgiproxy
(http://www.jmarshall.com/tools/cgiproxy/). for example, in my
university, the it department blocks a lot of harmless websites
simply because of their popularity. so i use this porgram to access
those websites. the only thing that phproxy needs is a web server
with php installed (see requirements below).
be aware though, that the sever has to be able to access those
resources to deliver them to you.

3. how it works
_____________________________________________________________________

you simply supply a url to the form and click browse. the script then
accesses that url, and if it has any html contents, it modifies
any urls so that they point back to the script. of course, there is more
to it than this, but if you would like to know more in
detail, view the source code.
comments have yet to be added.

4. requirements
_____________________________________________________________________

- php version >= 4.2.0 with safe_mode turned off

- file_uploads turned on for http file uploads.
- javascript turned on for the browser. setting the flags and
encrypting the supplied url initially requires the use of
javascript.

5. installation
_____________________________________________________________________

simply upload these files to a directory of your liking:

- phproxy.class.php
- index.php
- url_form.inc
- javascript.js
- style.css

all you need to do now is to access index.php and start browsing!

6. configurable script variables

_____________________________________________________________________

the $config is available at the beginning of index.php:

url_var_name: name of the variable the contains the url

to be passed to the script. default: 'q'
flags_var_name*: name of the variables the contains the flags
to be passed to the script. default: 'hl'
get_form_name: name of the get forms in case they were
passed through the proxy.
default: '__script_get_form'
proxy_url_form_name*: name of the form that you supply the url to.
default: 'poxy_url_form'
proxy_settings_form_name*: name of the form the contains the flags.
default: 'poxy_settings_form'
max_file_size: maximum file size that can be downloaded
through the proxy. use -1 for unlimited.
default: -1
* the variables also have to be edited at the beginning of javascript.js

---

these variables are available at the beginning of the phproxy class.

$flags: this array contains the default values for the browsing
options which are explained in section 7.

$allowed_hosts: this array contains entries for the domain names that
the script is allowed to browse. for example, setting
this variable to array('www.yahoo.com') will restrict
the script to browse _only_ www.yahoo.com. if you'd
like the script browse all subdomains within yahoo.com
then instead of www.yahoo.com, set it to
array('.yahoo.com'). the dot in the beginning tells
the script to match all subdomains. to add more
entries, simply seperate them with a comma. example:
array('.yahoo.com', '.fark.com');

$banned_hosts: this is the same as $allowed_hosts. but instead of

defining an allow list, you could simply define
the domain names that you do not wish the script to
browse. this overrides $allowed_hosts. use either one
of them.

7. available options
_____________________________________________________________________

these options are available to you through the web interface.

you can also edit the default values in the class variable $flags.
values can either be 1 (true) or 0 (false).
all values are defaulted to 1.

+-------------------------------------------------------------------+
| option | explanation |
+-------------------------------------------------------------------+
| include form | includes a mini url-form on every html page for |
| | easier browsing. |
| remove scripts | remove all sorts of client-side scripting |
| | (i.e. javascript). removal is not perfect. some |
| | scripts might slip by here and there. |
| accept cookies | accept http cookies |
| show images | show images. you might want to turn this off if |
| | you want to save your server's bandwith. |
| show referer | show referring website in http headers. this |
| | will show the base url for the website you're |
| | currently viewing. because many website disable |
| | hotlinking, this can be quite useful. |
| rotate13 | use rotate13 encoding on the url. * |
| base64 | use base64 encoding on the url. * |
| strip meta | strip meta html tags |
| strip title | strip website title |
| session cookies| store cookies for this current session only |
+-------------------------------------------------------------------+

* only one type of encryption will be used even if both are selected

8. legal disclaimer
_____________________________________________________________________

since this script basically bypasses restrictions that were imposed

on you, using it might be illegal in your country, school, office,
or whatever. even your host might not allow you to run it. use it at
your own risk. i will not be responsible for any damages done or any
harm that might result from using this script.

9. changelog, faq, todo, license, bugs, limitations

_____________________________________________________________________

refer to the accompanying files.

you can infer the limitations and bugs from the todo file.

10. credits
______________________________________________________________________

james marshall (http://www.jmarshall.com/) for his excellent cgiproxy

script which was a high inspiration and guide for me. the html
modification section is based off his script