Commits

Anonymous committed 5664186

Improve technical documentation of BAN protocol.

Comments (0)

Files changed (2)

doc/technical/ts6-protocol.txt

 
 Propagates a network wide ban.
 
-The type is K for K:lines; other types are reserved.
+The type is K for K:lines, R for resvs and X for X:lines; other types are
+reserved. The user mask field is only used for K:lines; for resvs and X:lines
+the field is ignored in input and sent as an asterisk.
 
 The creation TS indicates when this ban was last modified. An incoming ban MUST
 be ignored and not propagated if the creation TS is older than the creation TS

modules/core/m_ban.c

 	ptr = find_prop_ban(ntype, parv[2], parv[3]);
 	if (ptr != NULL)
 	{
+		/* We already know about this ban mask. */
 		aconf = ptr->data;
 		if (aconf->created > created ||
 				(aconf->created == created &&
 						aconf->host);
 			return 0;
 		}
+		/* act indicates if something happened (from the oper's
+		 * point of view). This is the case if the ban was
+		 * previously active (not deleted) or if the new ban
+		 * is not a removal and not already expired.
+		 */
 		act = !(aconf->status & CONF_ILLEGAL) || (hold != created &&
 				hold > rb_current_time());
 		if (lifetime > aconf->lifetime)
 		/* already expired, hmm */
 		if (aconf->lifetime <= rb_current_time())
 			return 0;
+		/* Deactivate, it will be reactivated later if appropriate. */
 		deactivate_conf(aconf, ptr);
 		rb_free(aconf->user);
 		aconf->user = NULL;
 	}
 	else
 	{
+		/* New ban mask. */
 		aconf = make_conf();
 		aconf->status = CONF_ILLEGAL | ntype;
 		aconf->lifetime = lifetime;
 		aconf->passwd = rb_strndup(parv[parc - 1], p - parv[parc - 1] + 1);
 		aconf->spasswd = rb_strdup(p + 1);
 	}
+	/* The ban is fully filled in and in the prop_bans list
+	 * but still deactivated. Now determine if it should be activated
+	 * and send the server notices.
+	 */
+	/* We only reject *@* and the like here.
+	 * Otherwise malformed bans are fairly harmless and can be removed.
+	 */
 	switch (ntype)
 	{
 		case CONF_KILL:
 				aconf->user ? " " : "",
 				aconf->host);
 	}
+	/* If CONF_ILLEGAL is still set at this point, remove entries from the
+	 * reject cache (for klines and xlines).
+	 * If CONF_ILLEGAL is not set, add the ban to the type-specific data
+	 * structure and take action on matched clients/channels.
+	 */
 	switch (ntype)
 	{
 		case CONF_KILL: