Difference between revisions of "Extension:SimpleSecurity2.1.php"

From Organic Design wiki
m
(done - now to debug it)
Line 8: Line 8:
 
# Handle moves (since they don't use $action)
 
# Handle moves (since they don't use $action)
 
$securityAction = $action == 'submit' ? 'edit' : strtolower($action);
 
$securityAction = $action == 'submit' ? 'edit' : strtolower($action);
if ($title=='Special:Movepage' && $action=='submit') {
+
if ($title == 'Special:Movepage' && $action == 'submit') {
 
$securityAction = 'move';
 
$securityAction = 'move';
 
$t = $wgRequest->getText('wpOldTitle',$wgRequest->getVal('target'));
 
$t = $wgRequest->getText('wpOldTitle',$wgRequest->getVal('target'));
Line 27: Line 27:
 
$t = "Image:$image";
 
$t = "Image:$image";
 
} else $file = '';
 
} else $file = '';
 +
 +
# Hook1: Asseses security after raw content fetched from database and clears if not readable
 +
# - also fills the global $securityItems cache with info to append to the rendered article
 +
$securityAfterFetchIndex = count($wgHooks['ArticleAfterFetchContent']);
 +
$wgHooks['ArticleAfterFetchContent'][] = 'securityAfterFetch';
 +
function securityAfterFetch(&$this,&$text) {
 +
global $wgUser,$wgTitle,$securityAction,$securityItems,$securityAfterFetchIndex;
 +
 +
# Set up a new local parser object to process security items independently of main rendering process
 +
# - both Security and :Security items are processed and remembered
 +
$parser = new Parser;
 +
$options = ParserOptions::newFromUser($wgUser);
 +
$parser->setFunctionHook('Security','securityProcessItem');
 +
$parser->setFunctionHook(':Security','securityProcessItem');
 +
$securityItems = array();
 +
$output = $parser->parse($text,$wgTitle,$options,false,false);
 +
$allItems = $securityItems;
 +
 +
# Before inheriting security from categories
 +
# - stop checking :Security because they shouldn't inherit
 +
# - remove this AfterDatabaseFetch hook because we need to read each cats content
 +
unset($parser->mFunctionHooks[':Security']);
 +
$hookBak = $wgHooks['ArticleAfterFetchContent'];
 +
$wgHooks['ArticleAfterFetchContent'][$securityAfterFetchIndex]
 +
= array_splice($wgHooks['ArticleAfterFetchContent'],$securityAfterFetchIndex,1);
 +
 +
# Get the security items from the cats by running the parser over the content of each
 +
foreach ($output->getCategoryLinks() as $cat) {
 +
$article = new Article($title = Title::newFromText($cat = "Category:$cat"));
 +
$securityItems = array();
 +
$parser->parse($article->fetchContent(0,false,false),$title,$options,false,false);
 +
foreach ($securityItems as $i) $allItems[] = array($i[0],$i[1],"this rule is inherited from [[:$cat]]");
 +
}
 +
$securityItems = $allItems;
 +
 +
# Clear content if not viewable
 +
if (!securityValidate($wgUser,$securityItems,'view')) $text = "{{Action not permitted|$securityAction}}";
 +
 +
# Put the AfterFetch hook back how it was and exit successfully
 +
$wgHooks['ArticleAfterFetchContent'][$securityAfterFetchIndex] = $hookBak;
 +
return true;
 +
}
 +
 +
# Hook2: Block content if action not allowed, and append any security info before parsing
 +
$wgHooks['ParserBeforeStrip'][] = 'securityBeforeParsing';
 +
function securityBeforeParsing(&$parser,&$text,&$strip_state) {
 +
global $securityAllow,$securityItems,$securityAction;
 +
if (!$securityAllow) {
 +
$text = "{{Action not permitted|$securityAction}}";
 +
$securityAllow = true;
 +
$securityAction = 'view';
 +
}
 +
if (count($securityItems) && 0 == $GLOBALS['rsi-done']++ && $securityAction == 'view') {
 +
$text .= "\n{{Security info|1=\n";$secinfo
 +
foreach ($securityItems as $i) {
 +
$a = $i[1] == '*' ? 'Every action' : ucfirst($i[1]);
 +
$b = $i[2] == '*' ? 'anybody' : $i[2];
 +
$text .= "*'''$a''' requires the user to be '''$b'''$comment\n";
 +
}
 +
$text .= "\n}}";
 +
}
 +
return true;
 +
}
 +
 +
# Accumulates security information in a global cache whenever a security item is parsed
 +
function securityProcessItem(&$this,$a,$b) {
 +
$GLOBALS['securityItems'][] = array($a,$b);
 +
return '';
 +
}
 +
 +
# Return whether or not a user is allowed to perform an action according to an array of security items
 +
function securityValidate(&$user,&$items,$action) {
 +
 +
# Resolve permission for this action from the extracted security links
 +
$security = '';
 +
foreach ($items as $i) {
 +
if ($i[2] == '') $i[2] = 'sysop';
 +
$actions = preg_split("/\\s*,\\s*/",strtolower($i[1]));
 +
if ((in_array($action,$actions)) || (in_array('*',$actions) && ($security == ''))) $security = $i[2];
 +
}
 +
 +
# Validate extracted security against this user/groups
 +
$groups = $user->getGroups();
 +
foreach($groups as $k => $v) $groups[$k] = strtolower($v);
 +
$deny = false;
 +
if ($security && !in_array('sysop',$groups) && !in_array('director',$groups)) {
 +
$security = preg_split("/\\s*,\\s*/",$security);
 +
if (!in_array('*',$security)) {
 +
$groups[] = ucfirst($user->mName);
 +
if (count(array_intersect($groups,$security))==0) $deny = true;
 +
}
 +
}
 +
 +
return !$deny;
 +
}
  
 
# Get security items from this article with a dummy read to activate our AfterDatabaseFetch hook
 
# Get security items from this article with a dummy read to activate our AfterDatabaseFetch hook
Line 34: Line 129:
 
$allow = securityValidate($wgUser,$securityItems,$securityAction);
 
$allow = securityValidate($wgUser,$securityItems,$securityAction);
  
 +
# If its a file, send it back to the client and exit, or block by redirecting to the file's associated article
 
if ($file) {
 
if ($file) {
  
Line 60: Line 156:
 
die;
 
die;
 
} else $title = $t;
 
} else $title = $t;
 
 
 
}
 
}
 
# Block content if action not allowed, and append any security info before parsing
 
$wgHooks['ParserBeforeStrip'][] = 'securityBeforeParsing';
 
function securityBeforeParsing(&$parser,&$text,&$strip_state) {
 
global $securityAllow,$securityItems,$securityAction;
 
if (!$securityAllow) {
 
$text = "{{Action not permitted|$securityAction}}";
 
$securityAllow = true;
 
$securityAction = 'view';
 
}
 
if (count($securityItems) && 0 == $GLOBALS['rsi-done']++ && $securityAction == 'view') {
 
$text .= "\n{{Security info|1=\n$secinfo\n}}";
 
}
 
return true;
 
}
 
 
# Add security information item
 
function addSecurityInfo(&$links,&$info,$comment='') {
 
if ($comment) $comment = "   ''($comment)''";
 
foreach ($links as $link) {
 
$a = $link[1] == '*' ? 'Every action' : ucfirst($link[1]);
 
$b = $link[2] == '*' ? 'anybody' : $link[2];
 
$info .= "*'''$a''' requires the user to be '''$b'''$comment\n";
 
}
 
}
 
 
 
 
 
 
 
# Asseses security after raw content fetched from database and clears if not readable
 
# - also fills the global $securityItems cache with info to append to the rendered article
 
$securityAfterFetchIndex = count($wgHooks['ArticleAfterFetchContent']);
 
$wgHooks['ArticleAfterFetchContent'][] = 'securityAfterFetch';
 
function securityAfterFetch(&$this,&$text) {
 
global $wgUser,$wgTitle,$securityAction,$securityItems,$securityAfterFetchIndex;
 
 
# Set up a new local parser object to process security items independently of main rendering process
 
# - both Security and :Security items are processed and remembered
 
$parser = new Parser;
 
$options = ParserOptions::newFromUser($wgUser);
 
$parser->setFunctionHook('Security','securityProcessItem');
 
$parser->setFunctionHook(':Security','securityProcessItem');
 
$securityItems = array();
 
$output = $parser->parse($text,$wgTitle,$options,false,false);
 
$allItems = $securityItems;
 
 
# Before inheriting security from categories
 
# - stop checking :Security because they shouldn't inherit
 
# - remove this AfterDatabaseFetch hook because we need to read each cats content
 
unset($parser->mFunctionHooks[':Security']);
 
$hookBak = $wgHooks['ArticleAfterFetchContent'];
 
$wgHooks['ArticleAfterFetchContent'][$securityAfterFetchIndex]
 
= array_splice($wgHooks['ArticleAfterFetchContent'],$securityAfterFetchIndex,1);
 
 
# Get the security items from the cats by running the parser over the content of each
 
foreach ($output->getCategoryLinks() as $cat) {
 
$article = new Article($title = Title::newFromText($cat = "Category:$cat"));
 
$securityItems = array();
 
$parser->parse($article->fetchContent(0,false,false),$title,$options,false,false);
 
foreach ($securityItems as $i) $allItems[] = array($i[0],$i[1],"this rule is inherited from [[:$cat]]");
 
}
 
$securityItems = $allItems;
 
 
# Clear content if not viewable
 
if (!securityValidate($wgUser,$securityItems,'view')) $text = "{{Action not permitted|$securityAction}}";
 
 
# Put the AfterFetch hook back how it was and exit successfully
 
$wgHooks['ArticleAfterFetchContent'][$securityAfterFetchIndex] = $hookBak;
 
return true;
 
}
 
 
# Accumulates security information in a global cache whenever a security item is parsed
 
function securityProcessItem(&$this,$a,$b) {
 
$GLOBALS['securityItems'][] = array($a,$b);
 
return '';
 
}
 
 
# Return whether or not a user is allowed to perform an action according to an array of security items
 
function securityValidate(&$user,&$items,$action) {
 
 
# Resolve permission for this action from the extracted security links
 
$security = '';
 
foreach ($items as $i) {
 
if ($i[2] == '') $i[2] = 'sysop';
 
$actions = preg_split("/\\s*,\\s*/",strtolower($i[1]));
 
if ((in_array($action,$actions)) || (in_array('*',$actions) && ($security == ''))) $security = $i[2];
 
}
 
 
# Validate extracted security against this user/groups
 
$groups = $user->getGroups();
 
foreach($groups as $k => $v) $groups[$k] = strtolower($v);
 
$deny = false;
 
if ($security && !in_array('sysop',$groups) && !in_array('director',$groups)) {
 
$security = preg_split("/\\s*,\\s*/",$security);
 
if (!in_array('*',$security)) {
 
$groups[] = ucfirst($user->mName);
 
if (count(array_intersect($groups,$security))==0) $deny = true;
 
}
 
}
 
 
return !$deny;
 
 
}
 
}
  
 
?>
 
?>

Revision as of 10:29, 3 March 2007

<?

  1. Simple security extension
  2. - Version 2.0
  3. - See [[MediaWiki Security]] article for installation and usage details
  4. - Licenced under LGPL (http://www.gnu.org/copyleft/lesser.html)
  5. - Needs apache's mod-rewrite for security on images, see code comments below
  1. Handle moves (since they don't use $action)

$securityAction = $action == 'submit' ? 'edit' : strtolower($action); if ($title == 'Special:Movepage' && $action == 'submit') { $securityAction = 'move'; $t = $wgRequest->getText('wpOldTitle',$wgRequest->getVal('target')); } else $t = $title;

  1. If title exists, activate the security

if ($t) {

# Handle security on files (needs apache mod-rewrite) # - mod-rewrite redirects /wiki/images/... requests to article title Download/image-path... # - Use the following rewrite condition and rule (adjust to your wiki path if necessary) # RewriteCond %{REQUEST_URI} ^/wiki/images/.+ # RewriteRule ^/wiki/images/(.+) /wiki/index.php/Download/$1 [L] if (ereg('^Download/(.+)/([^/]+)$',$t,$m)) { $path = $m[1]; $file = $image = $m[2]; if (ereg('^thumb/.+/([^/]+)$',$path,$m)) $image = $m[1]; $t = "Image:$image"; } else $file = ;

# Hook1: Asseses security after raw content fetched from database and clears if not readable # - also fills the global $securityItems cache with info to append to the rendered article $securityAfterFetchIndex = count($wgHooks['ArticleAfterFetchContent']); $wgHooks['ArticleAfterFetchContent'][] = 'securityAfterFetch'; function securityAfterFetch(&$this,&$text) { global $wgUser,$wgTitle,$securityAction,$securityItems,$securityAfterFetchIndex;

# Set up a new local parser object to process security items independently of main rendering process # - both Security and :Security items are processed and remembered $parser = new Parser; $options = ParserOptions::newFromUser($wgUser); $parser->setFunctionHook('Security','securityProcessItem'); $parser->setFunctionHook(':Security','securityProcessItem'); $securityItems = array(); $output = $parser->parse($text,$wgTitle,$options,false,false); $allItems = $securityItems;

# Before inheriting security from categories # - stop checking :Security because they shouldn't inherit # - remove this AfterDatabaseFetch hook because we need to read each cats content unset($parser->mFunctionHooks[':Security']); $hookBak = $wgHooks['ArticleAfterFetchContent']; $wgHooks['ArticleAfterFetchContent'][$securityAfterFetchIndex] = array_splice($wgHooks['ArticleAfterFetchContent'],$securityAfterFetchIndex,1);

# Get the security items from the cats by running the parser over the content of each foreach ($output->getCategoryLinks() as $cat) { $article = new Article($title = Title::newFromText($cat = "Category:$cat")); $securityItems = array(); $parser->parse($article->fetchContent(0,false,false),$title,$options,false,false); foreach ($securityItems as $i) $allItems[] = array($i[0],$i[1],"this rule is inherited from $cat"); } $securityItems = $allItems;

# Clear content if not viewable

if (!securityValidate($wgUser,$securityItems,'view')) $text = "

Sorry, action not permitted!

Your user rights do not permit the $securityAction action to be performed on this article.

";

# Put the AfterFetch hook back how it was and exit successfully $wgHooks['ArticleAfterFetchContent'][$securityAfterFetchIndex] = $hookBak; return true; }

# Hook2: Block content if action not allowed, and append any security info before parsing $wgHooks['ParserBeforeStrip'][] = 'securityBeforeParsing'; function securityBeforeParsing(&$parser,&$text,&$strip_state) { global $securityAllow,$securityItems,$securityAction; if (!$securityAllow) {

$text = "

Sorry, action not permitted!

Your user rights do not permit the $securityAction action to be performed on this article.

"; $securityAllow = true; $securityAction = 'view'; } if (count($securityItems) && 0 == $GLOBALS['rsi-done']++ && $securityAction == 'view') { $text .= "\n

Padlock.svg

There are security restrictions on this article (for information about this extension, click here)

\n";$secinfo foreach ($securityItems as $i) { $a = $i[1] == '*' ? 'Every action' : ucfirst($i[1]); $b = $i[2] == '*' ? 'anybody' : $i[2]; $text .= "*$a requires the user to be $b$comment\n"; } $text .= "\n

";

} return true; }

# Accumulates security information in a global cache whenever a security item is parsed function securityProcessItem(&$this,$a,$b) { $GLOBALS['securityItems'][] = array($a,$b); return ; }

# Return whether or not a user is allowed to perform an action according to an array of security items function securityValidate(&$user,&$items,$action) {

# Resolve permission for this action from the extracted security links $security = ; foreach ($items as $i) { if ($i[2] == ) $i[2] = 'sysop'; $actions = preg_split("/\\s*,\\s*/",strtolower($i[1])); if ((in_array($action,$actions)) || (in_array('*',$actions) && ($security == ))) $security = $i[2]; }

# Validate extracted security against this user/groups $groups = $user->getGroups(); foreach($groups as $k => $v) $groups[$k] = strtolower($v); $deny = false; if ($security && !in_array('sysop',$groups) && !in_array('director',$groups)) { $security = preg_split("/\\s*,\\s*/",$security); if (!in_array('*',$security)) { $groups[] = ucfirst($user->mName); if (count(array_intersect($groups,$security))==0) $deny = true; } }

return !$deny; }

# Get security items from this article with a dummy read to activate our AfterDatabaseFetch hook $securityItems = array(); $tmp = new Article(Title::newFromText($t)); $tmp->fetchContent(0,false,false); $allow = securityValidate($wgUser,$securityItems,$securityAction);

# If its a file, send it back to the client and exit, or block by redirecting to the file's associated article if ($file) {

# Log the download event if any security on file if (count($securityItems)) { $user = $wgUser->mName; $entry = $allow ? "User:$user accessed \"$file\"" : "User:$user was denied access to \"$file\""; $ts = $wgLang->timeanddate(wfTimestampNow(),true); $la = new Article(Title::newFromText('Download log')); $log = "{{Log entry". "|ts=$ts". "|entry=$entry". "|ip=".$_SERVER['REMOTE_ADDR']. "|ua=".$_SERVER['HTTP_USER_AGENT']. "|cookie=".$_SERVER['HTTP_COOKIE']. "|qs=".$_SERVER['QUERY_STRING']. "}}\n"; $la->quickEdit($log.$la->fetchContent(0,false,false)); }

# Return the file to the client if security validates if ($allow) { header("Content-Type: application/octet-stream"); header("Content-Disposition: attachment; filename=\"$file\""); @readfile("$wgUploadDirectory/$path/$file"); die; } else $title = $t; } }

?>