View on
Nate Lewis > FWS-V2 > FWS::V2::Safety



Annotate this POD


New  1
Open  0
View/Report Bugs
Module Version: 1.13091122   Source  


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


Version 1.13091122


    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" );


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.



All directories or directry with file combination should be wrapped in this method before being used. 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!

In addition this also will convert any directory backslashes to forward slashes in case a dos style windows path was tossed into the directory.

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

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

    # using this with files is fine also
    print $fws->safeDir( "c:/this/is/fine/" );


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" );


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' );


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");


Remove anything from a query string that could advocate a cross site scripting attack

    # Do something that could be used for evil
    my $querySting = 'id=<script>alert( 'bo!' )</script>url&this=that';
    $valueHash{html} .= '<a href="' . $fws->safeQuery( $queryString ) . '">Click Me</a>';


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 );


Replace any thing harmful to an JSON node that could cause it to fail. It will escape stuff like quotes and such.

    # make a node safe
    my $sillyNode = 'This "Can not" be in json';
    my $safeSillyNode = $fws->safeJSON( $sillyNode );
    print 'Safe JSON: '.$sillyNode;


Replace any thing harmful to an XML node that could cause it to fail validation. & and < will be converted to &amp; and &lt;

    # make a node safe
    my $sillyNode = '55 is < 66 & 77';
    my $safeSillyNode = $fws->safeXML( $sillyNode );
    print '<silly>' . $safeSillyNode . '</silly>';
    # all in one
    print '<silly>' . $fws->safeXML( '55 is < 66 & 77' ) . '</silly>';


Nate Lewis, <nlewis at>


Please report any bugs or feature requests to bug-fws-v2 at, or through the web interface at I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.


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

    perldoc FWS::V2::Safety

You can also look for information at:


Copyright 2013 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 for more information.

syntax highlighting: