From 09a4489bb1b019214c12040eef00f239b78d5c19 Mon Sep 17 00:00:00 2001
From: Dick Visser <dick.visser@geant.org>
Date: Thu, 22 Nov 2018 13:14:15 +0100
Subject: [PATCH] New array syntax, fix missing brackets

---
 modules/authorize/docs/authorize.md | 77 +++++++++++++++--------------
 1 file changed, 40 insertions(+), 37 deletions(-)

diff --git a/modules/authorize/docs/authorize.md b/modules/authorize/docs/authorize.md
index 0e6e29986..6c5097108 100644
--- a/modules/authorize/docs/authorize.md
+++ b/modules/authorize/docs/authorize.md
@@ -2,9 +2,9 @@ authorize Module
 ================
 
 <!--
-	This file is written in Markdown syntax.
-	For more information about how to use the Markdown syntax, read here:
-	http://daringfireball.net/projects/markdown/syntax
+  This file is written in Markdown syntax.
+  For more information about how to use the Markdown syntax, read here:
+  http://daringfireball.net/projects/markdown/syntax
 -->
 
   * Author: Ernesto Revilla <erny@yaco.es>, Yaco Sistemas, Ryan Panning
@@ -20,9 +20,9 @@ This module provides a user authorization filter based on attribute matching for
 `authorize:Authorize`
 ---------------------
 
-There are two configuration options that can be defined; deny and regex. All other filter configuration options are considered attribute matching rules.
+There are three configuration options that can be defined: `deny`, `regex`, and `reject_msg`. All other filter configuration options are considered attribute matching rules.
 
-The users not authorized will be shown a 403 Forbidden page.
+Unauthorized will be shown a 403 Forbidden page.
 
 ### Deny ###
 The default action of the filter is to authorize only if an attribute match is found (default allow). When set to TRUE, this option reverses that rule and authorizes the user unless an attribute match is found (default deny), causing an unauthorized action.
@@ -52,44 +52,47 @@ Note: If regex is enabled, you must use the preg_match format, i.e. you have to
 ### Examples ###
 To use this filter configure it in `config/config.php`:
 
-	'authproc.sp' => array(
-		60 => array(
-			'class' => 'authorize:Authorize',
-			'uid'   =>  array(
-				'/.*@example.com/',
-				'/(user1|user2|user3)@example.edu/',
-			),
-			'schacUserStatus' => '@urn:mace:terena.org:userStatus:' .
-				'example.org:service:active.*@',
-	)
+  'authproc.sp' => [
+    60 => [
+      'class' => 'authorize:Authorize',
+      'uid'   =>  array(
+        '/.*@example.com/',
+        '/(user1|user2|user3)@example.edu/',
+      ],
+      'schacUserStatus' => '@urn:mace:terena.org:userStatus:' .
+        'example.org:service:active.*@',
+    ]
+  ]
 
 
 An alternate way of using this filter is to deny certain users. Or even use multiple filters to create a simple ACL, by first allowing a group of users but then denying a "black list" of users.
 
-	'authproc.sp' => array(
-		60 => array(
-			'class' => 'authorize:Authorize',
-			'deny'  => TRUE,
-			'uid'   =>  array(
-				'/.*@students.example.edu/',
-				'/(stu1|stu2|stu3)@example.edu/',
-			)
-	)
+  'authproc.sp' => [
+    60 => array[
+      'class' => 'authorize:Authorize',
+      'deny'  => TRUE,
+      'uid'   =>  [
+        '/.*@students.example.edu/',
+        '/(stu1|stu2|stu3)@example.edu/',
+      ]
+    ]
+  ]
 
 The regex pattern matching can be turned off, allowing for exact attribute matching rules. This can be helpful in cases where you know what the value should be. An example of this is with the memberOf attribute or using the ldap:AttributeAddUsersGroups filter with the group attribute.
 
 Additionally, some helpful instructions are shown.
 
-	'authproc.sp' => array(
-		60 => array(
-			'class' => 'authorize:Authorize',
-			'regex' => FALSE,
-			'group' =>  array(
-				'CN=SimpleSAML Students,CN=Users,DC=example,DC=edu',
-				'CN=All Teachers,OU=Staff,DC=example,DC=edu',
-			),
-			'reject_msg' => array(
-				'en' => 'This service is only available to students and teachers. Please contact <a href="mailto:support@example.edu">support</a>.',
-				'nl' => 'Deze dienst is alleen beschikbaar voor studenten en docenten. Neem contact op met <a href="mailto:support@example.edu">support</a>.',
-			)
-	)
+  'authproc.sp' => [
+    60 => [
+      'class' => 'authorize:Authorize',
+      'regex' => FALSE,
+      'group' =>  array(
+        'CN=SimpleSAML Students,CN=Users,DC=example,DC=edu',
+        'CN=All Teachers,OU=Staff,DC=example,DC=edu',
+      ],
+      'reject_msg' => [
+        'en' => 'This service is only available to students and teachers. Please contact <a href="mailto:support@example.edu">support</a>.',
+        'nl' => 'Deze dienst is alleen beschikbaar voor studenten en docenten. Neem contact op met <a href="mailto:support@example.edu">support</a>.',
+      ]
+    ]
+  ]
-- 
GitLab