/ 
FWS-V2-0.008
River stage zero No dependents
/ FWS::V2::Safety

NAME

FWS::V2::Safety - Framework Sites version 2 safe data wrappers

VERSION

Version 0.002

SYNOPSIS

	use FWS::V2;
	
	my $fws = FWS::V2->new();

	#
	# each one of these statements will clean the string up to make it "safe"
	# depending on its context
	#	

	print $fws->safeDir("../../this/could/be/dangrous");
	
        print $fws->safeFile("../../i-am-trying-to-change-dir.ext");
	
        print $fws->safeSQL("this ' or 1=1 or ' is super bad");

DESCRIPTION

FWS version 2 safety methods are used for security when using unknown parameters that could be malicious. Whenever data is passed to another method it should be wrapped in its appropriate safety wrapper under the guidance of each method.

METHODS

safeDir

All directories should be wrapped in this method before being applied. It will remove any context that could change its scope to higher than its given location. When using directories ALWAYS prepend them with $fws->{"fileDir"} or $fws->{"secureFileDir"} to ensure they root path is always in a known location to further prevent any tampering. NEVER use a directory that is not prepended with a known depth!

#
# will return //this/could/be/dangerous
#
print $fws->safeDir("../../this/could/be/dangrous");

#
# will return this/is/fine
#
print $fws->safeDir("this/is/fine");

safeFile

All files should be wrapped in this method before being applied. It will remove any context that could change its scope to a different directory.

#
# will return ....i-am-trying-to-change-dir.ext
#
print $fws->safeFile("../../i-am-trying-to-change-dir.ext");

safeNumber

Make sure a number is a valid number and strip anything that would make it not. The first character in the string has to be a '-' for the number to maintain its negative status.

#
# will return -34663.43
#
print $fws->safeNumber("- $34,663.43");

safeSQL

All fields and dynamic content in SQL statements should be wrapped in this method before being applied. It will add double tics and escape any escapes so you can not break out of a statement and inject anything not intended.

#
# will return this '' or 1=1 or '' is super bad
#
print $fws->safeSQL("this ' or 1=1 or ' is super bad");

safeURL

Switch a string into a safe url by replacing all non 0-9 a-z A-Z with a dash but not start with a dash. For SEO reasons this will also switch any & with the word "and".

        #
        # change the product name into a safe url
        #
        my $productName = 'My super cool product & title';
	my $frindlyURL = $fws->safeURL($productName).'.html';

	#
	# change an name into a safe class name
	#
	my $productAttribute = 'Size: Large';
	my $className = 'productAttribute_'.$fws->safeURL($productAttribute);

AUTHOR

Nate Lewis, <nlewis at gnetworks.com>

BUGS

Please report any bugs or feature requests to bug-fws-v2 at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FWS-V2. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc FWS::V2::Safety

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2012 Nate Lewis.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.