The Arcive of Official vBulletin Modifications Site.It is not a VB3 engine, just a parsed copy! |
|
Using the vBulletin Input Cleaner
Note: This article assumes that you are familier with PHP, and will introduce you to input filtering using vBulletin Using the vBulletin Input Cleaner Class Introduction Most scripts will require data from a user at some point. When using this data, you should never assume that it is "clean" data. With XSS (Cross-Site Scripting) and SQL exploits being identified in scripts on a daily basis, you should do everything you can to ensure that all data coming from the user has been cleaned ("sanatized"). vBulletin provides us with the vB_Input_Cleaner class to do just this. The vBulletin Input Cleaner class is setup when the page loads, and can be accessed as $vbulletin->input, Data Types When you accept data from the user, you should know what type of data you are expecting to receive. the vBulletin Input Cleaner allows the following types of data to be cleaned:
Cleaning Functions The input cleaner class provides a number of useful functions that we can use to clean our data, depending on what data you wish to clean. Cleaning Superglobal Arrays By Superglobal, I mean $_POST, $_GET, $_REQUEST and so on. These arrays are created automaticly by PHP and contain the user-sent input. They are referenced in the vBulletin Input Cleaner by nice short single letter names. These are:
Example: PHP Code:
So, in the example above, we are telling clean_array_gpc() that we wish to clean the $_POST array, and that $_POST contains 3 variables, 'name', 'age', and 'usepm', and that we wish to clean them as TYPE_NOHTML, TYPE_UINT and TYPE_BOOL respectivly. Once cleaned, the new (clean) variables will be available in the $vbulletin->GPC array. So, to follow on from our previous example, we would use something like: PHP Code:
If you have a single variable that you wish to clean, use the clean_gpc() function. This function allows you to specify a single variable in any of the Superglobal arrays, and it's type. Example: PHP Code:
Cleaning a Single Variable If you wish to clean a single variable that is not in one of the Superglobal arrays, you should use the clean() function. Example: PHP Code:
Cleaning an Array of Variables For times when you wish to clean an array of variables of mixed types, vBulletin provides the clean_array() function. The clean_array() function takes 2 paramaters. The first is the array to be cleaned, and the second is an array of variable names, and their types. This function works exactly the same as clean_array_gpc(), except instead of specifying which Superglobal array to clean, you specify your own array. Conclusion So, to sum up - always run all input from the user through the vBulletin Input Cleaner! As well as being a good coding practice, this will drasticly decrease the chances of someone exploiting your script using an XSS or SQL attack. Good luck using your new found knowledge of the vBulletin Input Cleaner class, and remember: If you get stuck, just ask! Knowledge sharing is what vBulletin.org is all about! (Note: If you want to reproduce this article anywhere, I have no objections, but I do request that you give me credit for writing it, and a PM letting me know would be appreciated ) |
#2
|
|||
|
|||
Another fine article. Good work.
|
#3
|
|||
|
|||
very nice. thanks dude
|
#4
|
||||
|
||||
Thanks Alan, i have been trying to use the cleaners as opposed to $_GET, $_POST, etc... this should help me well.
|
#5
|
|||
|
|||
This is great. One question for a novice hack. How do we know there as something wrong? If I wanted a number and the user input a letter how would I know there was an error?
Do I need to further determine the cleaned variable is a number? Mark |
#6
|
|||
|
|||
You'd use
if(!is_numeric($vbulletin->GPC['age'])) |
#7
|
|||
|
|||
For reference, when checking numbers, if vBulletin doesn't find a number, it will return 0 instead. (when using TYPE_INT or TYPE_UINT)
The types and what it will return if it can't find what you are asking for is below: Code:
TYPE_INT and TYPE_UINT: 0 TYPE_NUM and TYPE_UNUM: 0 (if you give it a value of "3 thousand", it will return 3) TYPE_STR, TYPE_NOTRIM and TYPE_NOHTML: The data represented as a string TYPE_BOOL: If it finds '1', 'true', 'y', 'yes', it will return 1 - anything else, it will return 0 TYPE_ARRAY: An empty array TYPE_FILE: An empty files array with the size property set to '4' (indicates that it isn't a file) TYPE_UNIXTIME: 0 Alan. |
#8
|
|||
|
|||
Thanks for the information. So I'm thinking I need to check the variables even before it posts with javascript or with php.
|
#9
|
|||
|
|||
You can always do:
PHP Code:
|
#10
|
||||
|
||||
how would you go about cleaning $_SESSION arrays? I have been cleaning the vars before placing them into $_SESSION but I wonder if there's some way to clean the $_SESSION afterwards.?
|
|
|
X vBulletin 3.8.12 by vBS Debug Information | |
---|---|
|
|
More Information | |
Template Usage:
Phrase Groups Available:
|
Included Files:
Hooks Called:
|