com.neurosys.cluzo.domain

Interface SecurityAdapter<T>

All Known Subinterfaces:

SecurityContext<T>

All Known Implementing Classes:

CodeSnifferSecurityAdapter, CookieSanitizerSecurityAdapter, DefaultSecurityContext, RedundantFileExtSecurityAdapter, WhiteBlackExpressionSecurityAdapter, XSSAntiSamySecurityAdapter, XSSESAPIURLSecurityAdapter, XSSPersistSecurityAdapter, XSSUrlParamSecurityAdapter

public interface SecurityAdapter<T>

Handles a Security Check or Sanitization process. The adapter can work on an agreed type of format of data for its Input and Output.

A SecurityAdapter must define a default constructor so that it can be created and auto-generated by factories etc.

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static String	REGEX_PROP_FILE Default properties bundled with library.

Method Summary

Modifier and Type	Method and Description
Data<T>	sanitize(Data<T> data) Sanitize content, from malicious to harmless.
void	validate(Data<T> input) Check if the input is safe or not When used in a chained or a SecurityContext with other SecurityAdapters then the Adapters throwing a OperationNotSupportedException will be ignored.

Field Detail

REGEX_PROP_FILE

static final String REGEX_PROP_FILE

Default properties bundled with library. One may override them in implementing API's

See Also:

Constant Field Values

Method Detail

validate

void validate(Data<T> input)
       throws SecurityException,
              OperationNotSupportedException,
              IOException

Check if the input is safe or not
When used in a chained or a SecurityContext with other SecurityAdapters then the Adapters throwing a OperationNotSupportedException will be ignored.

Parameters:

input - as Data

Throws:

IllegalArgumentException - if the input is not readable or understandable

SecurityException - is its is not safe. This is to provide additional details about the failure that te return param cannot.

IOException - for any type of setup, reading, infra related issue with files/configs

OperationNotSupportedException

sanitize

Data<T> sanitize(Data<T> data)
          throws Exception,
                 OperationNotSupportedException

Sanitize content, from malicious to harmless. An adapter may or may not choose to support a Sanitization method. In the event it does not support it, it should throw a OperationNotSupportedException. When used in a chained or a SecurityContext with other SecurityAdapters then the Adapters throwing a OperationNotSupportedException will be ignored. Any other exception will be thrown if there is an issue in the executionof the sanitization process.

Parameters:

input -

Returns:

Throws:

Exception, - OperationNotSupportedException

Exception

OperationNotSupportedException