seckit.form.inc in Security Kit 6
Same filename and directory in other branches
Administrative interface for SecKit settings.
File
includes/seckit.form.incView source
<?php
/**
* @file
* Administrative interface for SecKit settings.
*/
/**
* Forms administration page.
*/
function seckit_admin_form() {
// get default/set options
$options = _seckit_get_options();
// main description
$args['!browserscope'] = l(t('Browserscope'), 'http://www.browserscope.org/?category=security');
$form['seckit_description'] = array(
'#type' => 'item',
'#description' => t('This module provides your website with various options to mitigate risks of common web application vulnerabilities like Cross-site Scripting, Cross-site Request Forgery and Clickjacking. It also has some options to improve your SSL/TLS security and fixes Drupal 6 core Upload module issue leading to an easy exploitation of an old Internet Explorer MIME sniffer HTML injection vulnerability. Note that some security features are not supported by all browsers. You may find this out at !browserscope.', $args),
);
// main fieldset for XSS
$form['seckit_xss'] = array(
'#type' => 'fieldset',
'#title' => t('Cross-site Scripting'),
'#collapsible' => TRUE,
'#tree' => TRUE,
'#description' => t('Configure levels and various techniques of protection from cross-site scripting attacks'),
);
// fieldset for Content Security Policy (CSP)
$args['!wiki'] = l(t('Mozilla Wiki'), 'https://wiki.mozilla.org/Security/CSP');
$description = t('Content Security Policy is a policy framework that allows to specify trustworthy sources of content and to restrict its capabilities. You may read more about it at !wiki.', $args);
$form['seckit_xss']['csp'] = array(
'#type' => 'fieldset',
'#title' => t('Content Security Policy'),
'#collapsible' => TRUE,
'#tree' => TRUE,
'#description' => $description,
);
// CSP enable/disable
$form['seckit_xss']['csp']['checkbox'] = array(
'#type' => 'checkbox',
'#default_value' => $options['seckit_xss']['csp']['checkbox'],
'#title' => t('Send HTTP response header'),
'#return_value' => 1,
'#description' => t('Send Content-Security-Policy (official), X-Content-Security-Policy (supported by Mozilla Firefox and IE10) and X-WebKit-CSP (supported by Google Chrome and Safari) HTTP response headers with the list of Content Security Policy directives.'),
);
// CSP report-only mode
$form['seckit_xss']['csp']['report-only'] = array(
'#type' => 'checkbox',
'#default_value' => $options['seckit_xss']['csp']['report-only'],
'#title' => t('Report Only'),
'#return_value' => 1,
'#description' => t('Use Content Security Policy in report-only mode. In this case, violations of policies will only be reported, not blocked. Use this while configuring policies. Reports are logged to watchdog.'),
);
// CSP description
$items = array(
"'none' - block content from any source",
"'self' - allow content only from your domain",
"'unsafe-inline' - allow specific inline content (note, that it is supported by a subset of directives)",
"'unsafe-eval' - allow a set of string-to-code API which is restricted by default (supported by script-src directive)",
);
$args['!keywords'] = theme('item_list', $items);
$items = array(
'* - load content from any source',
'*.example.com - load content from example.com and all its subdomains',
'example.com:* - load content from example.com via any port. Otherwise, it will use your website default port',
);
$args['!wildcards'] = theme('item_list', $items);
$args['!spec'] = l(t('specification page'), 'http://www.w3.org/TR/CSP/');
$description = t("Set up security policy for different types of content. Don't use www prefix. Keywords are: !keywords Wildcards (*) are allowed: !wildcards More information is available at !spec.", $args);
$form['seckit_xss']['csp']['description'] = array(
'#type' => 'item',
'#title' => t('Directives'),
'#description' => $description,
);
// CSP default-src directive
$form['seckit_xss']['csp']['default-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['default-src'],
'#title' => 'default-src',
'#description' => t("Specify security policy for all types of content, which are not specified further (frame-ancestors excepted). Default is 'self'."),
);
// CSP script-src directive
$form['seckit_xss']['csp']['script-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['script-src'],
'#title' => 'script-src',
'#description' => t('Specify trustworthy sources for <script> elements.'),
);
// CSP object-src directive
$form['seckit_xss']['csp']['object-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['object-src'],
'#title' => 'object-src',
'#description' => t('Specify trustworthy sources for <object>, <embed> and <applet> elements.'),
);
// CSP style-src directive
$form['seckit_xss']['csp']['style-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['style-src'],
'#title' => 'style-src',
'#description' => t('Specify trustworthy sources for stylesheets. Note, that inline stylesheets and style attributes of HTML elements are allowed.'),
);
// CSP img-src directive
$form['seckit_xss']['csp']['img-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['img-src'],
'#title' => 'img-src',
'#description' => t('Specify trustworthy sources for <img> elements.'),
);
// CSP media-src directive
$form['seckit_xss']['csp']['media-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['media-src'],
'#title' => 'media-src',
'#description' => t('Specify trustworthy sources for <audio> and <video> elements.'),
);
// CSP frame-src directive
$form['seckit_xss']['csp']['frame-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['frame-src'],
'#title' => 'frame-src',
'#description' => t('Specify trustworthy sources for <iframe> and <frame> elements.'),
);
// CSP font-src directive
$form['seckit_xss']['csp']['font-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['font-src'],
'#title' => 'font-src',
'#description' => t('Specify trustworthy sources for @font-src CSS loads.'),
);
// CSP connect-src directive
$form['seckit_xss']['csp']['connect-src'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['connect-src'],
'#title' => 'connect-src',
'#description' => t('Specify trustworthy sources for XMLHttpRequest, WebSocket and EventSource connections.'),
);
// CSP report-uri directive
$form['seckit_xss']['csp']['report-uri'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['report-uri'],
'#title' => 'report-uri',
'#description' => t('Specify a URL (relative to the Drupal root) to which user-agents will report CSP violations. Use the default value, unless you have set up an alternative handler for these reports. Defaults to <code>admin/settings/seckit/csp-report</code> which logs the report data in watchdog.'),
);
// CSP policy-uri directive
$form['seckit_xss']['csp']['policy-uri'] = array(
'#type' => 'textfield',
'#maxlength' => 1024,
'#default_value' => $options['seckit_xss']['csp']['policy-uri'],
'#title' => 'policy-uri',
'#description' => t("Specify a URL (relative to the Drupal root) for a file containing the (entire) policy. <strong>All other directives will be omitted</strong> by Security Kit, as <code>policy-uri</code> may only be defined in the <em>absence</em> of other policy definitions in the <code>X-Content-Security-Policy</code> HTTP header. The MIME type for this URI <strong>must</strong> be <code>text/x-content-security-policy</code>, otherwise user-agents will enforce the policy <code>allow 'none'</code> instead."),
);
// fieldset for X-XSS-Protection
$form['seckit_xss']['x_xss'] = array(
'#type' => 'fieldset',
'#title' => t('X-XSS-Protection'),
'#collapsible' => TRUE,
'#tree' => TRUE,
'#description' => t('X-XSS-Protection HTTP response header controls Microsoft Internet Explorer, Google Chrome and Apple Safari internal XSS filters.'),
);
// options for X-XSS-Protection
$x_xss_protection_options = array(
SECKIT_X_XSS_DISABLE => t('Disabled'),
SECKIT_X_XSS_0 => '0',
SECKIT_X_XSS_1 => '1; mode=block',
);
// configure X-XSS-Protection
$link = l(t("IE's XSS filter security flaws in past"), 'http://hackademix.net/2009/11/21/ies-xss-filter-creates-xss-vulnerabilities');
$items = array(
'Disabled - XSS filter will work in default mode. Enabled by default',
'0 - XSS filter will be disabled for a website. It may be useful because of ' . $link,
'1; mode=block - XSS filter will be left enabled, but it will block entire page instead of modifying dangerous content',
);
$args['!values'] = theme('item_list', $items);
$form['seckit_xss']['x_xss']['select'] = array(
'#type' => 'select',
'#title' => t('Configure'),
'#options' => $x_xss_protection_options,
'#default_value' => $options['seckit_xss']['x_xss']['select'],
'#description' => t('!values', $args),
);
// fieldset for IE MIME sniffer security
$args['!msdn'] = l(t('official blog post'), 'http://blogs.msdn.com/ie/archive/2008/07/02/ie8-security-part-v-comprehensive-protection.aspx');
$args['!blog'] = l(t('related blog post'), 'http://p0deje.blogspot.com/2010/05/exploiting-ie-mime-sniffer.html');
$description = t('Files of text/plain MIME type (e.g. txt) can be used to exploit Internet Explorer MIME-sniffer bug. It is recommended to restrict uploading of such files. You may read more about MIME Handling at !msdn and about its exploitation in Drupal at !blog.', $args);
$form['seckit_xss']['ie_mime'] = array(
'#type' => 'fieldset',
'#title' => t('Internet Explorer MIME sniffer'),
'#collapsible' => TRUE,
'#tree' => TRUE,
'#description' => $description,
);
// button for fixing IE MIME sniffer exploit
$form['seckit_xss']['ie_mime']['button'] = array(
'#type' => 'button',
'#prefix' => '<div id="edit-seckit-xss-ie-mime-button-ahah-wrapper">',
'#suffix' => '</div>',
'#ahah' => array(
'path' => 'admin/settings/seckit/mime',
'wrapper' => 'edit-seckit-xss-ie-mime-button-ahah-wrapper',
'effect' => 'fade',
),
);
// set necessary state for the button
$result = _seckit_ie_mime_check();
if ($result == SECKIT_IE_MIME_SECURE) {
$form['seckit_xss']['ie_mime']['button']['#value'] = t('Allow uploading of .txt files');
}
else {
$form['seckit_xss']['ie_mime']['button']['#value'] = t('Restrict uploading of .txt files');
}
// fieldset for X-Content-Type-Options
$args['!link'] = l(t('MSDN article'), 'http://blogs.msdn.com/b/ie/archive/2010/10/26/mime-handling-changes-in-internet-explorer.aspx');
$form['seckit_xss']['x_content_type'] = array(
'#type' => 'fieldset',
'#title' => t('X-Content-Type-Options'),
'#collapsible' => TRUE,
'#tree' => TRUE,
'#description' => t('X-Content-Type-Options HTTP response header prevents browser from upsniffing content and serving files with inappropriate MIME type. More information is available at !link.', $args),
);
// enable/disable X-Content-Type-Options
$form['seckit_xss']['x_content_type']['checkbox'] = array(
'#type' => 'checkbox',
'#title' => t('Send HTTP response header'),
'#default_value' => $options['seckit_xss']['x_content_type']['checkbox'],
'#description' => t('Enable X-Content-Type-Options: nosniff HTTP response header.'),
);
// main fieldset for CSRF
$form['seckit_csrf'] = array(
'#type' => 'fieldset',
'#title' => t('Cross-site Request Forgery'),
'#tree' => TRUE,
'#collapsible' => TRUE,
'#description' => t('Configure levels and various techniques of protection from cross-site request forgery attacks'),
);
// enable/disable Origin
$form['seckit_csrf']['origin'] = array(
'#type' => 'checkbox',
'#title' => t('HTTP Origin'),
'#default_value' => $options['seckit_csrf']['origin'],
'#description' => t('Check Origin HTTP request header.'),
);
// Origin whitelist
$description = t('Comma separated list of trustworthy sources. Do not enter your website URL - it is automatically added. Syntax of the source is: [protocol] :// [host] : [port] . E.g, http://example.com, https://example.com, https://www.example.com, http://www.example.com:8080');
$form['seckit_csrf']['origin_whitelist'] = array(
'#type' => 'textfield',
'#title' => t('Allow requests from'),
'#default_value' => $options['seckit_csrf']['origin_whitelist'],
'#size' => 90,
'#description' => $description,
);
// main fieldset for Clickjacking
$form['seckit_clickjacking'] = array(
'#type' => 'fieldset',
'#title' => t('Clickjacking'),
'#collapsible' => TRUE,
'#tree' => TRUE,
'#description' => t('Configure levels and various techniques of protection from Clickjacking/UI Redressing attacks'),
);
// options for X-Frame-Options
$x_frame_options = array(
SECKIT_X_FRAME_DISABLE => t('Disabled'),
SECKIT_X_FRAME_SAMEORIGIN => 'SameOrigin',
SECKIT_X_FRAME_DENY => 'Deny',
SECKIT_X_FRAME_ALLOW_FROM => 'Allow-From',
);
// configure X-Frame-Options
$items = array(
'Disabled - turn off X-Frame-Options',
'SameOrigin - browser allows all the attempts of framing website within its domain. Enabled by default',
'Deny - browser rejects any attempt of framing website',
'Allow-From - browser allows framing website only from specified source',
);
$args['!values'] = theme('item_list', $items);
$args['!msdn'] = l(t('MSDN article'), 'http://blogs.msdn.com/b/ie/archive/2009/01/27/ie8-security-part-vii-clickjacking-defenses.aspx');
$args['!spec'] = l(t('specification'), 'http://tools.ietf.org/html/draft-ietf-websec-x-frame-options-01');
$description = t("X-Frame-Options HTTP response header controls browser's policy of frame rendering. Possible values: !values You may read more about it at !msdn or !spec.", $args);
$form['seckit_clickjacking']['x_frame'] = array(
'#type' => 'select',
'#title' => t('X-Frame-Options'),
'#options' => $x_frame_options,
'#default_value' => $options['seckit_clickjacking']['x_frame'],
'#description' => $description,
);
// source for "Allow-From" option
$form['seckit_clickjacking']['x_frame_allow_from'] = array(
'#type' => 'textfield',
'#title' => t('Allow-From'),
'#default_value' => $options['seckit_clickjacking']['x_frame_allow_from'],
'#description' => t('URI of source for "X-Frame-Options: Allow-From" value. Example, http://domain.com'),
);
// enable/disable JS + CSS + Noscript protection
$args['!link'] = l(t('sirdarckcat'), 'http://www.sirdarckcat.net/');
$args['%js'] = t('seckit.document_write.js');
$args['%write'] = t('document.write()');
$args['%stop'] = t('stop SecKit protection');
$args['%css'] = t('seckit.no_body.css');
$args['%display'] = t('display: none');
$description = t('Enable protection via JavaScript, CSS and Noscript tag. This is the most efficient Clickjacking prevention technique. If webiste is not being framed, %js starts commenting with %write and stops when reaches %stop. Thus %css, which sets body display to none, is ignored. If particularly this JavaScript file is being blocked (with XSS filter of Internet Explorer 8 or Safari), %css sets %display to body. If JavaScript is disabled within browser, it shows a special message. Credits for this trick go to !link.', $args);
$form['seckit_clickjacking']['js_css_noscript'] = array(
'#type' => 'checkbox',
'#title' => t('Enable JavaScript + CSS + Noscript protection'),
'#return_value' => 1,
'#default_value' => $options['seckit_clickjacking']['js_css_noscript'],
'#description' => $description,
);
// custom text for "disabled JavaScript" message
$form['seckit_clickjacking']['noscript_message'] = array(
'#type' => 'textfield',
'#title' => t('Custom text for disabled JavaScript message'),
'#default_value' => $options['seckit_clickjacking']['noscript_message'],
'#description' => t('This message will be shown to user when JavaScript is disabled or unsupported in his browser. Default is "Sorry, you need to enable JavaScript to visit this website."'),
);
// main fieldset for SSL/TLS
$form['seckit_ssl'] = array(
'#type' => 'fieldset',
'#title' => t('SSL/TLS'),
'#collapsible' => TRUE,
'#tree' => TRUE,
'#description' => t('Configure various techniques to improve security of SSL/TLS'),
);
// enable/disable HTTP Strict Transport Security (HSTS)
$args['!wiki'] = l(t('Wikipedia'), 'http://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security');
$form['seckit_ssl']['hsts'] = array(
'#type' => 'checkbox',
'#title' => t('HTTP Strict Transport Security'),
'#description' => t('Enable Strict-Transport-Security HTTP response header. HTTP Strict Transport Security (HSTS) header is proposed to prevent eavesdropping and man-in-the-middle attacks like SSLStrip, when a single non-HTTPS request is enough for credential theft or hijacking. It forces browser to connect to the server in HTTPS-mode only and automatically convert HTTP links into secure before sending request. !wiki has more information about HSTS', $args),
'#default_value' => $options['seckit_ssl']['hsts'],
'#return_value' => 1,
);
// HSTS max-age directive
$form['seckit_ssl']['hsts_max_age'] = array(
'#type' => 'textfield',
'#title' => t('Max-Age'),
'#description' => t('Specify Max-Age value in seconds. It sets period when user-agent should remember receipt of this header field from this server. Default is 1000.'),
'#default_value' => $options['seckit_ssl']['hsts_max_age'],
);
// STS includeSubDomains directive
$form['seckit_ssl']['hsts_subdomains'] = array(
'#type' => 'checkbox',
'#title' => t('Include Subdomains'),
'#description' => t('Force HTTP Strict Transport Security for all subdomains. If enabled, HSTS policy will be applied for all subdomains, otherwise only for the main domain.'),
'#return_value' => 1,
'#default_value' => $options['seckit_ssl']['hsts_subdomains'],
);
// main fieldset for various
$form['seckit_various'] = array(
'#type' => 'fieldset',
'#title' => t('Various'),
'#collapsible' => TRUE,
'#tree' => TRUE,
'#description' => t('Configure various unsorted security enhancements'),
);
// enable/disable From-Origin
$args['!spec'] = l(t('specification'), 'http://www.w3.org/TR/from-origin/');
$form['seckit_various']['from_origin'] = array(
'#type' => 'checkbox',
'#title' => t('From-Origin'),
'#default_value' => $options['seckit_various']['from_origin'],
'#description' => t('Enable From-Origin HTTP response header. This forces user-agent to retrieve embedded content from your site only to listed destination. More information is available at !spec page.', $args),
);
// From-Origin destination
$items = array(
'same - allow loading of content only from your site. Default value.',
'serialized origin - address of trustworthy destination. For example, http://example.com, https://example.com, https://www.example.com, http://www.example.com:8080',
);
$args['!items'] = theme('item_list', $items);
$form['seckit_various']['from_origin_destination'] = array(
'#type' => 'textfield',
'#title' => t('Allow loading content to'),
'#default_value' => $options['seckit_various']['from_origin_destination'],
'#size' => 90,
'#description' => t('Trustworthy destination. Possible variants are: !items', $args),
);
// validation and submit
$form['#validate'][] = 'seckit_admin_form_validate';
$form['#submit'][] = 'seckit_admin_form_submit';
return system_settings_form($form);
}
/**
* Validates form data.
*/
function seckit_admin_form_validate($form, &$form_state) {
// if From-Origin is enabled, it should be explicitly set
$from_origin_enable = $form_state['values']['seckit_various']['from_origin'];
$from_origin_destination = $form_state['values']['seckit_various']['from_origin_destination'];
if ($from_origin_enable == 1 && !$from_origin_destination) {
form_error($form['seckit_various']['from_origin_destination'], t('You have to set up trustworthy destination for From-Origin HTTP response header. Default is same.'));
}
// if X-Frame-Options is set to Allow-From, it should be explicitly set
$x_frame_value = $form_state['values']['seckit_clickjacking']['x_frame'];
$x_frame_allow_from = $form_state['values']['seckit_clickjacking']['x_frame_allow_from'];
if ($x_frame_value == SECKIT_X_FRAME_ALLOW_FROM && !$x_frame_allow_from) {
form_error($form['seckit_clickjacking']['x_frame_allow_from'], t('You have to set up trustworthy destination for X-Frame-Options: Allow-From HTTP response header.'));
}
// if HTTP Strict Transport Security is enabled, max-age must be specified.
$hsts_enable = $form_state['values']['seckit_ssl']['hsts'];
$hsts_max_age = $form_state['values']['seckit_ssl']['hsts_max_age'];
if ($hsts_enable == 1 && !$hsts_max_age) {
form_error($form['seckit_ssl']['hsts_max_age'], t('You have to set up Max-Age value for HTTP Strict Transport Security. Default is 1000.'));
}
// HSTS max-age should only contain digits.
if (preg_match('/[^0-9]/', $hsts_max_age)) {
form_error($form['seckit_ssl']['hsts_max_age'], t('Only digits are allowed in HTTP Strict Transport Security Max-Age field.'));
}
// if JS + CSS + Noscript Clickjacking protection is enabled,
// custom text for disabled JS must be specified
$js_css_noscript_enable = $form_state['values']['seckit_clickjacking']['js_css_noscript'];
$noscript_message = $form_state['values']['seckit_clickjacking']['noscript_message'];
if ($js_css_noscript_enable == 1 && !$noscript_message) {
form_error($form['seckit_clickjacking']['noscript_message'], t('You have to set up Custom text for disabled JavaScript message when JS + CSS + Noscript protection is enabled.'));
}
}
/**
* Submits form.
*/
function seckit_admin_form_submit($form, &$form_state) {
$from_origin_enable = $form_state['values']['seckit_various']['from_origin'];
$x_content_type_options_enable = $form_state['values']['seckit_xss']['x_content_type']['checkbox'];
$file_system = variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC);
if ($from_origin_enable && $file_system == FILE_DOWNLOADS_PUBLIC) {
$msg = 'From-Origin HTTP response header will not be served for files because of public file system. It is recommended to enable private file system to ensure provided by From-Origin security.';
drupal_set_message($msg, 'warning');
}
if ($x_content_type_options_enable && $file_system == FILE_DOWNLOADS_PUBLIC) {
$msg = 'X-Content-Type-Options HTTP response header will not be served for files because of public file system. It is recommended to enable private file system to ensure provided by X-Content-Type-Options security.';
drupal_set_message($msg, 'warning');
}
}Functions
Name |
Description |
|---|---|
| seckit_admin_form | Forms administration page. |
| seckit_admin_form_submit | Submits form. |
| seckit_admin_form_validate | Validates form data. |