kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-04 11:58:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add version information to manager event instance XML elements

Browse Source 
* Do a git blame on the embedded XML managerEvent elements.

* From the commit hash, grab the summary line.

* Do a git log --grep <summary> to find the cherry-pick commits in all
  branches that match.

* Do a git patch-id to ensure the commits are all related and didn't get
  a false match on the summary.

* Do a git tag --contains <commit> to find the tags that contain each
  commit.

* Weed out all tags not ..0.

* Sort and discard any .0.0 and following tags where the commit
  appeared in an earlier branch.

* The result is a single tag for each branch where the application or function
  was defined.

The events defined in res/res_pjsip/pjsip_manager.xml were done by hand
because the XML was extracted from the C source file relatively recently.

Two bugs were fixed along the way...

* The get_documentation awk script was exiting after it processed the first
  DOCUMENTATION block it found in a file.  We have at least 1 source file
  with multiple DOCUMENTATION blocks so only the first one in them was being
  processed.  The awk script was changed to continue searching rather
  than exiting after the first block.

* Fixing the awk script revealed an issue in logger.c where the third
  DOCUMENTATION block contained a XML fragment that consisted only of
  a managerEventInstance element that wasn't wrapped in a managerEvent
  element.  Since logger_doc.xml already existed, the remaining fragments
  in logger.c were moved to it and properly organized.

(cherry picked from commit 2897d87a99)
This commit is contained in:
George Joseph
2025-01-20 11:33:20 -07:00
committed by Asterisk Development Team
parent 571d48fb7c
commit 3fc90e7810
45 changed files with 197 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
main/security_events.c
View File

@@ -31,6 +31,7 @@
/*** DOCUMENTATION
<managerEvent language="en_US" name="FailedACL">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request violates an ACL check.</synopsis>
<syntax>
<parameter name="EventTV">
@@ -79,6 +80,7 @@
</managerEvent>
<managerEvent language="en_US" name="InvalidAccountID">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails an authentication check due to an invalid account ID.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -96,6 +98,7 @@
</managerEvent>
<managerEvent language="en_US" name="SessionLimit">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails due to exceeding the number of allowed concurrent sessions for that service.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -113,6 +116,7 @@
</managerEvent>
<managerEvent language="en_US" name="MemoryLimit">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails due to an internal memory allocation failure.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -130,6 +134,7 @@
</managerEvent>
<managerEvent language="en_US" name="LoadAverageLimit">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails because a configured load average limit has been reached.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -147,6 +152,7 @@
</managerEvent>
<managerEvent language="en_US" name="RequestNotSupported">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails due to some aspect of the requested item not being supported by the service.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -167,6 +173,7 @@
</managerEvent>
<managerEvent language="en_US" name="RequestNotAllowed">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request is not allowed by the service.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -188,6 +195,7 @@
</managerEvent>
<managerEvent language="en_US" name="AuthMethodNotAllowed">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request used an authentication method not allowed by the service.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -208,6 +216,7 @@
</managerEvent>
<managerEvent language="en_US" name="RequestBadFormat">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request is received with bad formatting.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -230,6 +239,7 @@
</managerEvent>
<managerEvent language="en_US" name="SuccessfulAuth">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request successfully authenticates with a service.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -250,6 +260,7 @@
</managerEvent>
<managerEvent language="en_US" name="UnexpectedAddress">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request has a different source address then what is expected for a session already in progress with a service.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -270,6 +281,7 @@
</managerEvent>
<managerEvent language="en_US" name="ChallengeResponseFailed">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request's attempt to authenticate has been challenged, and the request failed the authentication challenge.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -296,6 +308,7 @@
</managerEvent>
<managerEvent language="en_US" name="InvalidPassword">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request provides an invalid password during an authentication attempt.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -322,6 +335,7 @@
</managerEvent>
<managerEvent language="en_US" name="ChallengeSent">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when an Asterisk service sends an authentication challenge to a request.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@@ -340,6 +354,7 @@
</managerEvent>
<managerEvent language="en_US" name="InvalidTransport">
<managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request attempts to use a transport not allowed by the Asterisk service.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />