Advanced Configuration Options

The Digital Accessibility Platform (DAP) provides developers with advanced options for configuring custom commands required in order to conduct a Site Evaluation.

The 'Scanning Configuration' option within the 'Create New Evaluation' dialogue provides a freeform input field, which can be used to insert the necessary code or function that is to be executed when triggering an automated site scan.

The following examples illustrates the utilization of a JSON array used to trigger an automated site scan from an environment secured behind a user login. 

Accessing Content Behind a Login

Example JSON:

{

"login": {

"page": "https://www.mydomain.com/login.php",

"post_vars": {

"username": “users name",

"password": “users password",

"anykey": “any value"

}

}

}

JSON vars:

login - the container for variables required to configure an accessibility evaluation on content that exists behind an authorization gate.

page - URL where the authorization request should POST it’s variables.

post_vars - An array of POST variables that includes items like a username and password, but can contain any key/value pairs necessary to authenticate a user.  The array keys should match the ID’s of your your expected inputs and the the values should contain the actual user credentials.

 

Adding Custom Cookies

Example JSON:

{

"cookies": "[{\"domain\": \"mydomain.com\",\"httponly\": \"TRUE\",\"path\": \"\/\",\"secure\": \"TRUE\",\"expiry\": \"0\",\"name\": \"cookie_key_1\",\"value\": \"cookie_value_1\" },{\"domain\": \"some.domain.com\",\"httponly\": \"TRUE\",\"path\": \"\/\",\"secure\": \"TRUE\",\"expiry\": \"0\",\"name\": \"cookie_name_2\",\"value\": \"cookie_value_2\" }]”

}

JSON vars:

cookies - An array of cookies to be set when spidering/scanning a site.  This array can be used to configure any user specific data, stored in a client side cookie, required to  fully and completely analyze content for issues of accessibility. 

The cookie array can be used as workaround to manually configure a scan on a site that is behind a login.  An administrator can log in to the site (using a separate browser session) and copy cookies of the authenticated user into the cookies array, essential bypassing the authentication routine.   

 

Setting the Spider’s Start Page

Example JSON:

{

"start_page": “/somepage.html“

}

JSON vars:

start_page - Page on which the spider should begin looking for pages to analyze.

This element’s value must begin with a forward slash(/

 

Limiting Scans

Example JSON:

{

"ignore": “://subdomain., /subdirectory, https://mydomain.com/logout.php",

"include": “/scan_this_dir_only/"

}

JSON vars:

ignore -  An element who’s value will cause the evaluation system to ignore any URL that match the given string.  Multiple values can be comma separated.  Useful for excluding certain subdomains or subdirectories from analysis.

Typically the ignore field is used to prevent the evaluation system from inadvertently logging out of an authenticated session by setting the logout URL as an ignore string.

include - An element who’s value will cause the evaluation system to ONLY analyze URLs that match the given string.  Multiple values can be comma separated.  Useful for limiting analysis to certain subdomains or subdirectories of a site.

 

note: all configuration data is encrypted and secured in transit and at rest.

For additional support configuring custom site evaluations within DAP, AudioEye supplies its customers with DAP Training and Support (Professional Services), which may be purchased on an ad hoc basis. 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk