From caabfe14e161e8d86df766cf468403c70382287f Mon Sep 17 00:00:00 2001
From: Bram Matthys <syzop@vulnscan.org>
Date: Sat, 14 May 2022 09:03:34 +0200
Subject: [PATCH] Document and give examples in release notes for new mask and
 security-group functionality.

---
 doc/RELEASE-NOTES.md | 45 +++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 42 insertions(+), 3 deletions(-)

diff --git a/doc/RELEASE-NOTES.md b/doc/RELEASE-NOTES.md
index 53a51fcfc..ab20b7484 100644
--- a/doc/RELEASE-NOTES.md
+++ b/doc/RELEASE-NOTES.md
@@ -6,10 +6,49 @@ If you are already running UnrealIRCd 6 then read below. Otherwise, jump
 straight to the [summary about UnrealIRCd 6](#Summary) to learn more
 about UnrealIRCd 6.
 
-Fixes:
-* 
-
 Enhancements:
+* The [security-group block](https://www.unrealircd.org/docs/Security-group_block)
+  has been expanded and the same functionality is now available in
+  [mask items](https://www.unrealircd.org/docs/Mask_item) too:
+  * This means the existing options like identified, webirc, tls and
+    reputation-score can be used in allow::mask, tld::mask, etc.
+  * New options (in both security-group and mask) are:
+    * connect-time: time a user is connected to IRC
+    * security-group: to check another security group
+    * account: services account name
+    * country: country as found by GeoIP
+    * realname: realname (gecos) of the user
+    * certfp: certificate fingerprint
+    * Some of this functionality was already available in a different way
+      (extended server bans) but this makes it easier to read in the config file
+      and is more flexible.
+  * Every option also has an exclude- variant, eg. *exclude-country*.
+    If a user matches any exclude- option then it is considered not a match.
+  * Example of direct use in a ::mask item:
+    ```
+    tld {
+        mask { country { ES; MX; } }
+        motd "motd.es.txt";
+        rules "rules.es.txt";
+    }
+    ```
+  * Example of defining a security group and using it in a mask item later:
+    ```
+    security-group irccloud {
+        mask { ip1; ip2; ip3; ip4 }
+    }
+    allow {
+        mask { security-group irccloud; }
+        class clients;
+        maxperip 128;
+    }
+    except ban {
+        mask { security-group irccloud; }
+        type { blacklist; connect-flood; handshake-data-flood; }
+    }
+    ```
+
+Fixes:
 * 
 
 UnrealIRCd 6.0.3