File 1544-snmp-doc-Add-documentation-about-RFC-7860-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1544-snmp-doc-Add-documentation-about-RFC-7860-additions.patch of Package erlang (Revision bf3a5557316b9c4af47c55d0b2592dd6)

Currently displaying revision bf3a5557316b9c4af47c55d0b2592dd6 , Show latest

From a984dc1a8e4c05062391c8254dd430954b33d4a2 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Wed, 29 Sep 2021 11:55:05 +0200
Subject: [PATCH 4/9] [snmp|doc] Add documentation about RFC-7860 additions

Add support for new authentication algorithms (SHA-224,
SHA-256, SHA-384 and SHA-512).

OTP-17615 (RFC7860)
---
 lib/snmp/doc/src/snmp.xml                     |  4 +-
 lib/snmp/doc/src/snmp_agent_config_files.xml  | 39 ++++++++++++++----
 .../doc/src/snmp_manager_config_files.xml     | 40 +++++++++++++++----
 lib/snmp/doc/src/snmp_user_based_sm_mib.xml   | 11 ++---
 lib/snmp/doc/src/snmpa_conf.xml               |  4 +-
 lib/snmp/doc/src/snmpm.xml                    | 10 +++--
 lib/snmp/doc/src/snmpm_conf.xml               |  4 +-
 7 files changed, 83 insertions(+), 29 deletions(-)

diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml
index 4c3d2efa94..9a4e123cb2 100644
--- a/lib/snmp/doc/src/snmp.xml
+++ b/lib/snmp/doc/src/snmp.xml
@@ -4,7 +4,7 @@
 <erlref>
 <header>
 <copyright>
- <year>1996</year><year>2018</year>
+ <year>1996</year><year>2021</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -290,7 +290,7 @@
 </type>
 <desc>
 Generates a key that can be used as an authentication
-	or privacy key using MD5, SHA, SHA224, SHA256, SHA354 or SHA512.
+	or privacy key using MD5, SHA, SHA224, SHA256, SHA384 or SHA512.
 	The key is localized for EngineID.
 
 <marker id="octet_string_to_bits"></marker>
diff --git a/lib/snmp/doc/src/snmp_agent_config_files.xml b/lib/snmp/doc/src/snmp_agent_config_files.xml
index 8456b84952..a07d642687 100644
--- a/lib/snmp/doc/src/snmp_agent_config_files.xml
+++ b/lib/snmp/doc/src/snmp_agent_config_files.xml
@@ -4,7 +4,7 @@
 <chapter>
 <header>
 <copyright>
- <year>1997</year><year>2020</year>
+ <year>1997</year><year>2021</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -38,7 +38,8 @@
 parameter. These files are read at start-up, and are used to
 initialize the SNMPv2-MIB or STANDARD-MIB, SNMP-FRAMEWORK-MIB,
 SNMP-MPD-MIB, SNMP-VIEW-BASED-ACM-MIB, SNMP-COMMUNITY-MIB,
- SNMP-USER-BASED-SM-MIB, SNMP-TARGET-MIB and SNMP-NOTIFICATION-MIB
+ SNMP-USER-BASED-SM-MIB (adjusted according to SNMP-USM-HMAC-SHA2-MIB),
+ SNMP-TARGET-MIB and SNMP-NOTIFICATION-MIB
 (refer to the 
 <seeguide marker="snmp_agent_funct_descr#management">Management of the Agent</seeguide> 
 for a description of the MIBs). 
@@ -347,7 +348,7 @@
 file called <c>usm.conf</c>, which must be present if the agent is 
 configured for SNMPv3. 
 The corresponding table is <c>usmUserTable</c> in the
- SNMP-USER-BASED-SM-MIB.
+ SNMP-USER-BASED-SM-MIB (adjusted according to SNMP-USM-HMAC-SHA2-MIB).
 Each entry is a term:
 <c>{EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey}.</c>
 <list type="bulleted">
@@ -365,7 +366,12 @@
 </item>
 <item>
 <c>AuthP</c> is a <c>usmNoAuthProtocol</c>,
-	<c>usmHMACMD5AuthProtocol</c>, or <c>usmHMACSHAAuthProtocol</c>.
+	<c>usmHMACMD5AuthProtocol</c>,
+	<c>usmHMACSHAAuthProtocol</c>,
+	<c>usmHMAC128SHA224AuthProtocol</c>,
+	<c>usmHMAC192SH256AuthProtocol</c>,
+	<c>usmHMAC256SHA384AuthProtocol</c> or
+	<c>usmHMAC384SHA512AuthProtocol</c>.
 </item>
 <item>
 <c>AuthKeyC</c> is a string.
@@ -388,9 +394,28 @@
 </item>
 <item>
 <c>AuthKey</c> is a list (of integer). This is the User's secret
-	localized authentication key. It is not visible in the MIB. The length
-	of this key needs to be 16 if <c>usmHMACMD5AuthProtocol</c> is used, 
-	and 20 if <c>usmHMACSHAAuthProtocol</c> is used.
+	localized authentication key. It is not visible in the MIB.
+	The length (number of octets) of this key needs to be:
+	<list type="bulleted">
+	 <item>
+	 16 if <c>usmHMACMD5AuthProtocol</c>.
+	 </item>
+	 <item>
+	 20 if <c>usmHMACSHAAuthProtocol</c>.
+	 </item>
+	 <item>
+	 28 if <c>usmHMAC128SHA224AuthProtocol</c>.
+	 </item>
+	 <item>
+	 32 if <c>usmHMAC192SHA256AuthProtocol</c>.
+	 </item>
+	 <item>
+	 48 if <c>usmHMAC256SHA384AuthProtocol</c>.
+	 </item>
+	 <item>
+	 64 if <c>usmHMAC384SHA512AuthProtocol</c>.
+	 </item>
+	</list>
 </item>
 <item>
 <c>PrivKey</c> is a list (of integer). This is the User's secret
diff --git a/lib/snmp/doc/src/snmp_manager_config_files.xml b/lib/snmp/doc/src/snmp_manager_config_files.xml
index 1db96afa78..fb741430c3 100644
--- a/lib/snmp/doc/src/snmp_manager_config_files.xml
+++ b/lib/snmp/doc/src/snmp_manager_config_files.xml
@@ -4,7 +4,7 @@
 <chapter>
 <header>
 <copyright>
- <year>2004</year><year>2016</year>
+ <year>2004</year><year>2021</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -245,7 +245,7 @@
 <seeerl marker="snmpm#register_usm_user">register_usm_user</seeerl>.
 
 The corresponding table is <c>usmUserTable</c> in the
- SNMP-USER-BASED-SM-MIB.
+ SNMP-USER-BASED-SM-MIB (adjusted according to SNMP-USM-HMAC-SHA2-MIB).
 
 Each entry is a term:
 
@@ -266,14 +266,38 @@
 </item>
 <item>
 <c>AuthP</c> is a <c>usmNoAuthProtocol</c>,
- <c>usmHMACMD5AuthProtocol</c> or <c>usmHMACSHAAuthProtocol</c>.
+	<c>usmHMACMD5AuthProtocol</c>,
+	<c>usmHMACSHAAuthProtocol</c>,
+	<c>usmHMAC128SHA224AuthProtocol</c>,
+	<c>usmHMAC192SH256AuthProtocol</c>,
+	<c>usmHMAC256SHA384AuthProtocol</c> or
+	<c>usmHMAC384SHA512AuthProtocol</c>.
 </item>
 <item>
- <c>AuthKey</c> is a list (of integer). This is the User's 
- secret localized authentication key. It is not visible in the MIB. 
- The length of this key needs to be 16 if 
- <c>usmHMACMD5AuthProtocol</c> is used and 20 if 
- <c>usmHMACSHAAuthProtocol</c> is used.
+	<c>AuthKey</c> is a list (of integer).
+	This is the User's secret localized authentication key.
+	It is not visible in the MIB. 
+	The length (number of octets) of this key needs to be: 
+	<list type="bulleted">
+	 <item>
+	 16 if <c>usmHMACMD5AuthProtocol</c>.
+	 </item>
+	 <item>
+	 20 if <c>usmHMACSHAAuthProtocol</c>.
+	 </item>
+	 <item>
+	 28 if <c>usmHMAC128SHA224AuthProtocol</c>.
+	 </item>
+	 <item>
+	 32 if <c>usmHMAC192SHA256AuthProtocol</c>.
+	 </item>
+	 <item>
+	 48 if <c>usmHMAC256SHA384AuthProtocol</c>.
+	 </item>
+	 <item>
+	 64 if <c>usmHMAC384SHA512AuthProtocol</c>.
+	 </item>
+	</list>
 </item>
 <item>
 <c>PrivP</c> is a <c>usmNoPrivProtocol</c>, 
diff --git a/lib/snmp/doc/src/snmp_user_based_sm_mib.xml b/lib/snmp/doc/src/snmp_user_based_sm_mib.xml
index d487439160..779fd8ce3a 100644
--- a/lib/snmp/doc/src/snmp_user_based_sm_mib.xml
+++ b/lib/snmp/doc/src/snmp_user_based_sm_mib.xml
@@ -4,7 +4,7 @@
 <erlref>
 <header>
 <copyright>
- <year>1999</year><year>2020</year>
+ <year>1999</year><year>2021</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -36,9 +36,10 @@
 <modulesummary>Instrumentation Functions for SNMP-USER-BASED-SM-MIB</modulesummary>
 <description>
 The module <c>snmp_user_based_sm_mib</c> implements the instrumentation 
- functions for the SNMP-USER-BASED-SM-MIB, and functions for configuring 
- the database.
- 
+ functions for the SNMP-USER-BASED-SM-MIB, and functions for configuring 
+ the database. 
+ Note that authentication has been extended according to RFC 7860
+ (SNMP-USM-HMAC-SHA2-MIB). 
 The configuration files are described in the SNMP User's Manual.
 </description>
 <funcs>
@@ -110,7 +111,7 @@
 <v>Name = string()</v>
 <v>SecName = string()</v>
 <v>Clone = zeroDotZero | [integer()]</v>
- <v>AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocol</v>
+ <v>AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocol | usmHMAC128SHA224AuthProtocol | usmHMAC192SH256AuthProtocol | usmHMAC256SHA384AuthProtocol | usmHMAC384SHA512AuthProtocol</v>
 <v>AuthKeyC = string()</v>
 <v>OwnAuthKeyC = string()</v>
 <v>PrivP = usmNoPrivProtocol | usmDESPrivProtocol</v>
diff --git a/lib/snmp/doc/src/snmpa_conf.xml b/lib/snmp/doc/src/snmpa_conf.xml
index 8a0df62939..b7ca747dc7 100644
--- a/lib/snmp/doc/src/snmpa_conf.xml
+++ b/lib/snmp/doc/src/snmpa_conf.xml
@@ -4,7 +4,7 @@
 <erlref>
 <header>
 <copyright>
- <year>2006</year><year>2020</year>
+ <year>2006</year><year>2021</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -737,7 +737,7 @@ word() = 0..65535
 <v>UserName = string()</v>
 <v>SecName = string()</v>
 <v>Clone = zeroDotZero | [integer()]</v>
- <v>AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol, | usmHMACSHAAuthProtocol</v>
+ <v>AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocol | usmHMAC128SHA224AuthProtocol | usmHMAC192SH256AuthProtocol | usmHMAC256SHA384AuthProtocol | usmHMAC384SHA512AuthProtocol</v>
 <v>AuthKeyC = string()</v>
 <v>OwnAuthKeyC = string()</v>
 <v>PrivP = usmNoPrivProtocol | usmDESPrivProtocol | usmAesCfb128Protocol</v>
diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml
index 7b755c457a..bb0826f2ce 100644
--- a/lib/snmp/doc/src/snmpm.xml
+++ b/lib/snmp/doc/src/snmpm.xml
@@ -415,9 +415,13 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv
 The type of <c>Val</c> depends on <c>Item</c>: 
 <code type="none"><![CDATA[
 sec_name = string()
-auth = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocoltimeout
+auth = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocol | usmHMAC128SHA224AuthProtocol | usmHMAC192SH256AuthProtocol | usmHMAC256SHA384AuthProtocol | usmHMAC384SHA512AuthProtocol
 auth_key = [integer()] (length 16 if auth = usmHMACMD5AuthProtocol, 
- length 20 if auth = usmHMACSHAAuthProtocol)
+ length 20 if auth = usmHMACSHAAuthProtocol,
+ length 28 if auth = usmHMAC128SHA224AuthProtocol,
+ length 32 if auth = usmHMAC192SHA256AuthProtocol,
+ length 48 if auth = usmHMAC256SHA384AuthProtocol,
+ length 64 if auth = usmHMAC384SHA512AuthProtocol)
 priv = usmNoPrivProtocol | usmDESPrivProtocol | usmAesCfb128Protocol
 priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb128Protocol).
 ]]></code>
diff --git a/lib/snmp/doc/src/snmpm_conf.xml b/lib/snmp/doc/src/snmpm_conf.xml
index e3c9322a32..5549bc3c2f 100644
--- a/lib/snmp/doc/src/snmpm_conf.xml
+++ b/lib/snmp/doc/src/snmpm_conf.xml
@@ -4,7 +4,7 @@
 <erlref>
 <header>
 <copyright>
- <year>2006</year><year>2020</year>
+ <year>2006</year><year>2021</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -287,7 +287,7 @@
 <v>EngineID = string()</v>
 <v>UserName = string()</v>
 <v>SecName = string()</v>
- <v>AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocol</v>
+ <v>AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocol | usmHMAC128SHA224AuthProtocol | usmHMAC192SH256AuthProtocol | usmHMAC256SHA384AuthProtocol | usmHMAC384SHA512AuthProtocol</v>
 <v>AuthKey = [integer()]</v>
 <v>PrivP = usmNoPrivProtocol | usmDESPrivProtocol | usmAesCfb128Protocol</v>
 <v>PrivKey = [integer()]</v>
-- 
2.31.1

Places

File 1544-snmp-doc-Add-documentation-about-RFC-7860-additions.patch of Package erlang (Revision bf3a5557316b9c4af47c55d0b2592dd6)

Places