snmp: T818: T1738: remove per user/trap engine id

As of the SNMP specification an SNMP engine ID should be unique per device.
To not make it more complicated for users - only use the global SNMP engine ID.

(cherry picked from commit d523111279b3a9a5266b442db5f04049a31685f7)

3 files changed, 53 insertions, 58 deletions

diff --git a/interface-definitions/snmp.xml b/interface-definitions/snmp.xml
index 744d80b2e..11cfc249d 100644
--- a/interface-definitions/snmp.xml
+++ b/interface-definitions/snmp.xml
@@ -307,15 +307,6 @@
                       </leafNode>
                     </children>
                   </node>
-                  <leafNode name="engineid">
-                    <properties>
-                      <help>Specifies the EngineID that uniquely identify an agent (e.g. 0xff42)</help>
-                      <constraint>
-                        <regex>^(0x){0,1}([0-9a-f][0-9a-f]){1,18}$</regex>
-                      </constraint>
-                      <constraintErrorMessage>ID must contain from 2 to 36 hex digits</constraintErrorMessage>
-                    </properties>
-                  </leafNode>
                   <leafNode name="port">
                     <properties>
                       <help>Specifies TCP/UDP port of destination SNMP traps/informs (default: '162')</help>
@@ -503,15 +494,6 @@
                       </leafNode>
                     </children>
                   </node>
-                  <leafNode name="engineid">
-                    <properties>
-                      <help>Specifies the EngineID that uniquely identify an agent (e.g. 0xff42)</help>
-                      <constraint>
-                        <regex>^(0x){0,1}([0-9a-f][0-9a-f]){1,18}$</regex>
-                      </constraint>
-                      <constraintErrorMessage>ID must contain from 2 to 36 hex digits</constraintErrorMessage>
-                    </properties>
-                  </leafNode>
                   <leafNode name="group">
                     <properties>
                       <help>Specifies group for user name</help>
diff --git a/src/conf_mode/snmp.py b/src/conf_mode/snmp.py
index 06d2e253a..e992804af 100755
--- a/src/conf_mode/snmp.py
+++ b/src/conf_mode/snmp.py
@@ -78,7 +78,7 @@ createUser {{ u.name }}
 {%- elif u.authPassword %}
 createUser {{ u.name }} {{ u.authProtocol | upper }} "{{ u.authPassword }}" {{ u.privProtocol | upper }} {{ u.privPassword }}
 {%- else %}
-usmUser 1 3 {{ u.engineID }} "{{ u.name }}" "{{ u.name }}" NULL {{ u.authOID }} {{ u.authMasterKey }} {{ u.privOID }} {{ u.privMasterKey }} 0x
+usmUser 1 3 {{ v3_engineid }} "{{ u.name }}" "{{ u.name }}" NULL {{ u.authOID }} {{ u.authMasterKey }} {{ u.privOID }} {{ u.privMasterKey }} 0x
 {%- endif %}
 {%- endfor %}
 
@@ -197,7 +197,7 @@ access {{ g.name }} "" tsm {{ g.seclevel }} exact {{ g.view }} {% if g.mode == '
 
 # trap-target
 {%- for t in v3_traps %}
-trapsess -v 3 {{ '-Ci' if t.type == 'inform' }} -e {{ t.engineID }} -u {{ t.secName }} -l {{ t.secLevel }} -a {{ t.authProtocol }} {% if t.authPassword %}-A {{ t.authPassword }}{% elif t.authMasterKey %}-3m {{ t.authMasterKey }}{% endif %} -x {{ t.privProtocol }} {% if t.privPassword %}-X {{ t.privPassword }}{% elif t.privMasterKey %}-3M {{ t.privMasterKey }}{% endif %} {{ t.ipProto }}:{{ t.ipAddr }}:{{ t.ipPort }}
+trapsess -v 3 {{ '-Ci' if t.type == 'inform' }} -e {{ v3_engineid }} -u {{ t.secName }} -l {{ t.secLevel }} -a {{ t.authProtocol }} {% if t.authPassword %}-A {{ t.authPassword }}{% elif t.authMasterKey %}-3m {{ t.authMasterKey }}{% endif %} -x {{ t.privProtocol }} {% if t.privPassword %}-X {{ t.privPassword }}{% elif t.privMasterKey %}-3M {{ t.privMasterKey }}{% endif %} {{ t.ipProto }}:{{ t.ipAddr }}:{{ t.ipPort }}
 {%- endfor %}
 
 # group
@@ -359,15 +359,11 @@ def get_config():
     else:
         snmp['v3_enabled'] = True
 
-    #
     # 'set service snmp v3 engineid'
-    #
     if conf.exists('v3 engineid'):
         snmp['v3_engineid'] = conf.return_value('v3 engineid')
 
-    #
     # 'set service snmp v3 group'
-    #
     if conf.exists('v3 group'):
         for group in conf.list_nodes('v3 group'):
             v3_group = {
@@ -388,14 +384,11 @@ def get_config():
 
             snmp['v3_groups'].append(v3_group)
 
-    #
     # 'set service snmp v3 trap-target'
-    #
     if conf.exists('v3 trap-target'):
         for trap in conf.list_nodes('v3 trap-target'):
             trap_cfg = {
                 'ipAddr': trap,
-                'engineID': '',
                 'secName': '',
                 'authProtocol': 'md5',
                 'authPassword': '',
@@ -409,11 +402,6 @@ def get_config():
                 'secLevel': 'noAuthNoPriv'
             }
 
-            if conf.exists('v3 trap-target {0} engineid'.format(trap)):
-                # Set the context engineID used for SNMPv3 REQUEST messages scopedPdu.
-                # If not specified, this will default to the authoritative engineID.
-                trap_cfg['engineID'] = conf.return_value('v3 trap-target {0} engineid'.format(trap))
-
             if conf.exists('v3 trap-target {0} user'.format(trap)):
                 # Set the securityName used for authenticated SNMPv3 messages.
                 trap_cfg['secName'] = conf.return_value('v3 trap-target {0} user'.format(trap))
@@ -488,7 +476,6 @@ def get_config():
                 'authPassword': '',
                 'authProtocol': 'md5',
                 'authOID': 'none',
-                'engineID': '',
                 'group': '',
                 'mode': 'ro',
                 'privMasterKey': '',
@@ -498,9 +485,7 @@ def get_config():
                 'privProtocol': 'des'
             }
 
-            #
             # v3 user {0} auth
-            #
             if conf.exists('v3 user {0} auth encrypted-key'.format(user)):
                 user_cfg['authMasterKey'] = conf.return_value('v3 user {0} auth encrypted-key'.format(user))
 
@@ -516,27 +501,15 @@ def get_config():
             user_cfg['authProtocol'] = type
             user_cfg['authOID'] = OIDs[type]
 
-            #
-            # v3 user {0} engineid
-            #
-            if conf.exists('v3 user {0} engineid'.format(user)):
-                user_cfg['engineID'] = conf.return_value('v3 user {0} engineid'.format(user))
-
-            #
             # v3 user {0} group
-            #
             if conf.exists('v3 user {0} group'.format(user)):
                 user_cfg['group'] = conf.return_value('v3 user {0} group'.format(user))
 
-            #
             # v3 user {0} mode
-            #
             if conf.exists('v3 user {0} mode'.format(user)):
                 user_cfg['mode'] = conf.return_value('v3 user {0} mode'.format(user))
 
-            #
             # v3 user {0} privacy
-            #
             if conf.exists('v3 user {0} privacy encrypted-key'.format(user)):
                 user_cfg['privMasterKey'] = conf.return_value('v3 user {0} privacy encrypted-key'.format(user))
 
@@ -660,13 +633,6 @@ def verify(snmp):
             if not 'privPassword' and 'privMasterKey' in trap.keys():
                 raise ConfigError('v3 trap: "user" must be specified')
 
-            if 'type' in trap.keys():
-                if trap['type'] == 'trap' and trap['engineID'] == '':
-                    raise ConfigError('must specify engineid if type is "trap"')
-            else:
-                raise ConfigError('"type" must be specified')
-
-
     if 'v3_users' in snmp.keys():
         for user in snmp['v3_users']:
             #
@@ -698,9 +664,6 @@ def verify(snmp):
             if user['privPassword'] == '' and user['privMasterKey'] == '':
                 raise ConfigError('Must specify encrypted-key or plaintext-key for user privacy')
 
-            if user['privMasterKey'] and user['engineID'] == '':
-                raise ConfigError('Can not have "encrypted-key" without engineid')
-
             if user['authPassword'] == '' and user['authMasterKey'] == '' and user['privTsmKey'] == '':
                 raise ConfigError('Must specify auth or tsm-key for user auth')
 
@@ -835,7 +798,6 @@ def apply(snmp):
                     # Now update the running configuration
                     #
                     # Currently when executing os.system() the environment does not have the vyos_libexec_dir variable set, see T685
-                    os.system('vyos_libexec_dir=/usr/libexec/vyos /opt/vyatta/sbin/my_set service snmp v3 user "{0}" engineid {1} > /dev/null'.format(cfg['user'], engineID))
                     os.system('vyos_libexec_dir=/usr/libexec/vyos /opt/vyatta/sbin/my_set service snmp v3 user "{0}" auth encrypted-key {1} > /dev/null'.format(cfg['user'], cfg['auth_pw']))
                     os.system('vyos_libexec_dir=/usr/libexec/vyos /opt/vyatta/sbin/my_set service snmp v3 user "{0}" privacy encrypted-key {1} > /dev/null'.format(cfg['user'], cfg['priv_pw']))
                     os.system('vyos_libexec_dir=/usr/libexec/vyos /opt/vyatta/sbin/my_delete service snmp v3 user "{0}" auth plaintext-key > /dev/null'.format(cfg['user']))
diff --git a/src/migration-scripts/snmp/0-to-1 b/src/migration-scripts/snmp/0-to-1
new file mode 100755
index 000000000..e52e6e04f
--- /dev/null
+++ b/src/migration-scripts/snmp/0-to-1
@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2019 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import sys
+from vyos.configtree import ConfigTree
+
+if (len(sys.argv) < 1):
+    print("Must specify file name!")
+    sys.exit(1)
+
+file_name = sys.argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+config = ConfigTree(config_file)
+config_base = ['service', 'snmp', 'v3']
+
+if not config.exists(config_base):
+    # Nothing to do
+    sys.exit(0)
+else:
+    # we no longer support a per trap target engine ID (https://phabricator.vyos.net/T818)
+    if config.exists(config_base + ['v3', 'trap-target']):
+        for target in config.list_nodes(config_base + ['v3', 'trap-target']):
+            config.delete(config_base + ['v3', 'trap-target', target, 'engineid'])
+
+    # we no longer support a per user engine ID (https://phabricator.vyos.net/T818)
+    if config.exists(config_base + ['v3', 'user']):
+        for user in config.list_nodes(config_base + ['v3', 'user']):
+            config.delete(config_base + ['v3', 'user', user, 'engineid'])
+
+    try:
+        with open(file_name, 'w') as f:
+            f.write(config.to_string())
+    except OSError as e:
+        print("Failed to save the modified config: {}".format(e))
+        sys.exit(1)