OTP-8478: Added support for multiple SNMPv3 EngineIDs in a single agent

3 files changed, 107 insertions, 6 deletions

diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml
index 45e1549de7..3f4954cfbd 100644
--- a/lib/snmp/doc/src/notes.xml
+++ b/lib/snmp/doc/src/notes.xml
@@ -33,6 +33,61 @@
   </header>
 
   <section>
+    <title>SNMP Development Toolkit 4.17</title>
+    <p>Version 4.17 supports code replacement in runtime from/to
+      version 4.16.2, 4.16.1, 4.16, 4.15, 4.14 and 4.13.5.</p>
+
+    <section>
+      <title>Improvements and new features</title>
+      <!-- 
+      <p>-</p> 
+      -->
+      <list type="bulleted">
+        <item>
+          <p>[agent] Added very basic support for multiple SNMPv3 
+            EngineIDs in a single agent. See 
+            <seealso marker="snmpa#send_notification">send_notification/7</seealso>, 
+            <seealso marker="snmpa_mpd#process_packet">process_packet/7</seealso>, 
+            <seealso marker="snmpa_mpd#generate_response_msg">generate_response_msg/6</seealso> or 
+            <seealso marker="snmpa_mpd#generate_msg">generate_msg/6</seealso> 
+            for more info. </p> 
+
+          <p>Own Id: OTP-8478</p>
+        </item>
+
+      </list>
+
+    </section>
+
+    <section>
+      <title>Reported Fixed Bugs and Malfunctions</title>
+      <p>-</p>
+
+      <!-- 
+      <list type="bulleted">
+        <item>
+          <p>The config utility 
+            (<seealso marker="snmp#config">snmp:config/0</seealso>)
+            generated a default notify.conf 
+            with a bad name for the starndard trap entry (was "stadard trap", 
+            but should have been "standard trap"). This has been corrected. </p>
+          <p>Kenji Rikitake</p>
+          <p>Own Id: OTP-8433</p>
+        </item>
+
+      </list>
+      -->
+
+    </section>
+
+    <section>
+      <title>Incompatibilities</title>
+      <p>-</p>
+    </section>
+  </section> <!-- 4.17 -->
+
+
+  <section>
     <title>SNMP Development Toolkit 4.16.2</title>
     <p>Version 4.16.2 supports code replacement in runtime from/to
       version 4.16.1, 4.16, 4.15, 4.14 and 4.13.5.</p>
diff --git a/lib/snmp/doc/src/snmpa.xml b/lib/snmp/doc/src/snmpa.xml
index 69fe6d62f4..1be6abe6dd 100644
--- a/lib/snmp/doc/src/snmpa.xml
+++ b/lib/snmp/doc/src/snmpa.xml
@@ -881,6 +881,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2).
       <name>send_notification(Agent, Notification, Receiver, Varbinds)</name>
       <name>send_notification(Agent, Notification, Receiver, NotifyName, Varbinds)</name>
       <name>send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() </name>
+      <name>send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds, LocalEngineID) -> void() </name>
       <fsummary>Send a notification</fsummary>
       <type>
         <v>Agent = pid() | atom()</v>
@@ -902,6 +903,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2).
         <v>OID = oid()</v>
         <v>Value = term()</v>
         <v>RowIndex = [int()]</v>
+        <v>LocalEngineID = string()</v>
       </type>
       <desc>
         <p>Sends the notification <c>Notification</c> to the
@@ -1041,6 +1043,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2).
           <item><c>{?sysLocation_instance, "upstairs"}</c> (provided
            that the generated <c>.hrl</c> file is included)</item>
         </list>
+
         <p>If a variable in the notification is a table element, the
           <c>RowIndex</c> for the element must be given in the
           <c>Varbinds</c> list. In this case, the OBJECT IDENTIFIER sent
@@ -1048,15 +1051,27 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2).
           element.  This OBJECT IDENTIFIER could be used in a get
           operation later.
           </p>
+
         <p>This function is asynchronous, and does not return any
           information.  If an error occurs, <c>user_err/2</c> of the error
           report module is called and the notification is discarded.
           </p>
 
+        <note>
+          <p>Note that the use of the LocalEngineID argument is only intended 
+            for special cases, if the agent is to "emulate" multiple EngineIDs!
+            By default, the agent uses the value of <c>SnmpEngineID</c> 
+            (see SNMP-FRAMEWORK-MIB). </p>
+	</note>
+
+<!--
           <marker id="send_trap"></marker>
+-->
+	  <marker id="discovery"></marker>
       </desc>
     </func>
 
+<!--
     <func>
       <name>send_trap(Agent,Trap,Community)</name>
       <name>send_trap(Agent,Trap,Community,Varbinds) -> void()</name>
@@ -1128,6 +1143,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2).
         <marker id="discovery"></marker>
       </desc>
     </func>
+-->
 
     <func>
       <name>discovery(TargetName, Notification) -> {ok, ManagerEngineID} | {error, Reason}</name>
diff --git a/lib/snmp/doc/src/snmpa_mpd.xml b/lib/snmp/doc/src/snmpa_mpd.xml
index ea5bde8956..202e6b5661 100644
--- a/lib/snmp/doc/src/snmpa_mpd.xml
+++ b/lib/snmp/doc/src/snmpa_mpd.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1999</year><year>2009</year>
+      <year>1999</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -13,12 +13,12 @@
       compliance with the License. You should have received a copy of the
       Erlang Public License along with this software. If not, it can be
       retrieved online at http://www.erlang.org/.
-    
+
       Software distributed under the License is distributed on an "AS IS"
       basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
       the License for the specific language governing rights and limitations
       under the License.
-    
+
     </legalnotice>
 
     <title>snmpa_mpd</title>
@@ -63,15 +63,19 @@
     </func>
 
     <func>
-      <name>process_packet(Packet, TDomain, TAddress, State) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
+      <name>process_packet(Packet, TDomain, TAddress, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
+      <name>process_packet(Packet, TDomain, TAddress, LocalEngineID, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
       <fsummary>Process a packet received from the network</fsummary>
       <type>
         <v>Packet = binary()</v>
         <v>TDomain = snmpUDPDomain</v>
         <v>TAddress = {Ip, Udp}</v>
+        <v>LocalEngineID = string()</v>
         <v>Ip = {integer(), integer(), integer(), integer()}</v>
         <v>Udp = integer()</v>
         <v>State = mpd_state()</v>
+        <v>NoteStore = pid()</v>
+        <v>Log = snmp_log()</v>
         <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v>
         <v>Pdu = #pdu</v>
         <v>PduMs = integer()</v>
@@ -84,18 +88,27 @@
           decryption as necessary.  The return values should be passed the
           agent.</p>
 
+        <note>
+          <p>Note that the use of the LocalEngineID argument is only intended 
+            for special cases, if the agent is to "emulate" multiple EngineIDs!
+            By default, the agent uses the value of <c>SnmpEngineID</c> 
+            (see SNMP-FRAMEWORK-MIB). </p>
+	</note>
+
         <marker id="generate_response_msg"></marker>
       </desc>
     </func>
 
     <func>
-      <name>generate_response_msg(Vsn, RePdu, Type, ACMData) -> {ok, Packet} | {discarded, Reason}</name>
+      <name>generate_response_msg(Vsn, RePdu, Type, ACMData, Log) -> {ok, Packet} | {discarded, Reason}</name>
+      <name>generate_response_msg(Vsn, RePdu, Type, ACMData, LocalEngineID, Log) -> {ok, Packet} | {discarded, Reason}</name>
       <fsummary>Generate a response packet to be sent to the network</fsummary>
       <type>
         <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v>
         <v>RePdu = #pdu</v>
         <v>Type = atom()</v>
         <v>ACMData = acm_data()</v>
+        <v>LocalEngineID = string()</v>
         <v>Packet = binary()</v>
       </type>
       <desc>
@@ -103,17 +116,27 @@
           network. <c>Type</c> is the <c>#pdu.type</c> of the original
           request.</p>
 
+        <note>
+          <p>Note that the use of the LocalEngineID argument is only intended 
+            for special cases, if the agent is to "emulate" multiple EngineIDs!
+            By default, the agent uses the value of <c>SnmpEngineID</c> 
+            (see SNMP-FRAMEWORK-MIB). </p>
+	</note>
+
         <marker id="generate_msg"></marker>
       </desc>
     </func>
 
     <func>
-      <name>generate_msg(Vsn, Pdu, MsgData, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}</name>
+      <name>generate_msg(Vsn, NoteStore, Pdu, MsgData, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}</name>
+      <name>generate_msg(Vsn, NoteStore, Pdu, MsgData, LocalEngineID, To) -> {ok, PacketsAndAddresses} | {discarded, Reason}</name>
       <fsummary>Generate a request message to be sent to the network</fsummary>
       <type>
         <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v>
+        <v>NoteStore = pid()</v>
         <v>Pdu = #pdu</v>
         <v>MsgData = msg_data()</v>
+        <v>LocalEngineID = string()</v>
         <v>To = [dest_addrs()]</v>
         <v>PacketsAndAddresses = [{TDomain, TAddress, Packet}]</v>
         <v>TDomain = snmpUDPDomain</v>
@@ -136,6 +159,13 @@
           also received from the requests mentioned above.
           </p>
 
+        <note>
+          <p>Note that the use of the LocalEngineID argument is only intended 
+            for special cases, if the agent is to "emulate" multiple EngineIDs!
+            By default, the agent uses the value of <c>SnmpEngineID</c> 
+            (see SNMP-FRAMEWORK-MIB). </p>
+	</note>
+
         <marker id="discarded_pdu"></marker>
       </desc>
     </func>