mod_muc_http_auth: External auth services might need to check on the nickname as well

author: Seve Ferrer <seve@delape.net>
date: Tue, 21 Sep 2021 14:00:01 +0200
parent: 4322:9606e7a63a69
child: 4723:0a0334a3a784
--- a/mod_muc_http_auth/README.md	Sat Sep 18 11:51:48 2021 +0100
+++ b/mod_muc_http_auth/README.md	Tue Sep 21 14:00:01 2021 +0200
@@ -2,9 +2,9 @@
 
 This module externalizes MUC authorization via HTTP.  
 Whenever a user wants to join a MUC, an HTTP GET request is made to `authorization_url`
-with the user bare jid (`userJID`) and the MUC jid (`mucJID`) as GET parameters.  
+with the user's bare jid (`userJID`), the MUC jid (`mucJID`) and the user's nickname (`nickname`) as GET parameters.  
 Example:  
-`https://www.prosody.im/users/can-join/?userJID=romeo@example.com&mucJID=teaparty@chat.example.com`
+`https://www.prosody.im/users/can-join/?userJID=romeo@example.com&mucJID=teaparty@chat.example.com&nickname=Romeo`
 
 This allows an external service to decide whether a user is authorized to join a MUC or not.  
 
@@ -41,7 +41,7 @@
 
 |Name |Description |Default |
 |-----|------------|--------|
-|muc_http_auth_url| URL of the external HTTP service to which send `userJID` and `mucJID` in a GET request | "" |
+|muc_http_auth_url| URL of the external HTTP service to which send `userJID`, `mucJID` and `nickname` in a GET request | "" |
 |muc_http_auth_enabled_for| List of MUC names (node part) to enable this module for | nil |
 |muc_http_auth_disabled_for| List of MUC names (node part) to disable this module for | nil |
 |muc_http_auth_insecure| Disable certificate verification for request. Only intended for development of the external service. | false |