The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Shadowd-Connector-1.0.0
River stage zero No dependents
/ Shadowd::Connector

NAME

Shadowd::Connector - Shadow Daemon connector base

VERSION

Version 1.0.0

SYNOPSIS

Shadowd::Connector is the base class to connect applications to the Shadow Daemon background server. It is not possible to use this module directly, because there are abstract methods that have to be overwritten.

SUBROUTINES/METHODS

new

Simple constructor for an object oriented interface.

get_client_ip

Abstract method that has to return the IP address of the client.

get_caller

Abstract method that has to return the caller, i.e. the requested resource.

gather_input

Abstract method that has to save the user input in the class attribute _input (hash).

defuse_input

Abstract method that has to remove elements from the first parameter (array) from the user input.

error

Abstract method that has to display a 500 error.

init_config

Initialize the configuration.

get_config

Get values from the configuration file.

get_input

Get the user input that is compiled by gather_input.

remove_ignored

Remove user input that should be ignored from the class attribute _input.

send_input

Send the user input and other data to the background server and return the parsed response.

parse_output

Parse the response of the background server.

sign

Sign the input with a secret key to authenticate requests without having to send the password.

log

Log the message to a file.

escape_key

Escape keys, i.e. single elements of a path.

unescape_key

Unescape keys, i.e. single elements of a path.

split_path

Split a path into keys.

start

Connect the different components of the module to gather input, send it to the server and defuse threats.

AUTHOR

Hendrik Buchwald, <hb at zecure.org>

BUGS

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

It is also possible to report bugs via Github at https://github.com/zecure/shadowd_perl/issues.

SUPPORT

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

    perldoc Shadowd::Connector

You can also look for information at:

LICENSE AND COPYRIGHT

Shadow Daemon -- Web Application Firewall

  Copyright (C) 2014-2015 Hendrik Buchwald C<< <hb at zecure.org> >>

This file is part of Shadow Daemon. Shadow Daemon is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.