使用snmp4j通过snmpv3协议获取指标

参考：https://blog.csdn.net/zhouzhiwengang/article/details/46816371，本文对此又做了精进

先说一下参考链接中没提到的点：

1、通过snmp.getUSM()获取到的USM实例是同一个，因此不要在多线程并发中去往USM中添加用户或修改，否则有时会报找不到securityName的异常，在stackoverflow上有相关问题

2、USM有三种添加用户的方法，其中通过engineID的方式添加的时候，再获取时候也要通过engineID+name去获取，在参考中体现在，设置target的时候要设置AuthoritativeEngineID，否则在执行时查询USM会报找不到securityName

//加上这句
target.setAuthoritativeEngineID(new OctetString("0002651100").getValue());

更新：此engineID为设备侧所配置的engineID，非snmp4j所特有的，在敲snmpwalk命令时也发现此参数

 

下面是我自己测试时用到代码段，可以修改调试一下，加深理解：

package com.moon.test3;

import java.io.IOException;
import java.util.List;
import java.util.Vector;
import java.util.concurrent.TimeUnit;

import org.snmp4j.PDU;
import org.snmp4j.ScopedPDU;
import org.snmp4j.Snmp;
import org.snmp4j.Target;
import org.snmp4j.UserTarget;
import org.snmp4j.event.ResponseEvent;
import org.snmp4j.mp.MPv3;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.security.AuthMD5;
import org.snmp4j.security.PrivDES;
import org.snmp4j.security.SecurityLevel;
import org.snmp4j.security.SecurityModels;
import org.snmp4j.security.SecurityProtocols;
import org.snmp4j.security.USM;
import org.snmp4j.security.UsmUser;
import org.snmp4j.security.UsmUserEntry;
import org.snmp4j.smi.OID;
import org.snmp4j.smi.OctetString;
import org.snmp4j.smi.UdpAddress;
import org.snmp4j.smi.VariableBinding;
import org.snmp4j.transport.DefaultUdpTransportMapping;
import org.snmp4j.util.DefaultPDUFactory;
import org.snmp4j.util.TableEvent;
import org.snmp4j.util.TableUtils;
 
public class SNMP {
	public static void main(String[] args) throws IOException, InterruptedException {
		
		Snmp snmp = new Snmp(new DefaultUdpTransportMapping());
		USM usm = new USM(SecurityProtocols.getInstance(), new OctetString(MPv3.createLocalEngineID()), 0);
		SecurityModels.getInstance().addSecurityModel(usm);
		snmp.listen();
		
		// Add User
		Thread thread1 = new Thread( new Runnable() {
			@Override
			public void run() {
				try {
					TimeUnit.SECONDS.sleep(1);
				} catch (InterruptedException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
				UsmUser user = new UsmUser(
						new OctetString("qiucf"),
						AuthMD5.ID, new OctetString("qiucfsnmpv3pwd"),
						PrivDES.ID, new OctetString("qiucfsnmpv3k"));
				//If the specified SNMP engine id is specified, this user can only be used with the specified engine ID
				//So if it's not correct, will get an error that can't find a user from the user table.
				//snmp.getUSM().addUser(new OctetString("nmsAdmin"), new OctetString("0002651100"), user);
				snmp.getUSM().addUser(user);
				
				UsmUser user2 = new UsmUser(
						new OctetString("qiucf2"),
						AuthMD5.ID, new OctetString("qiucfsnmpv3pwd2"),
						PrivDES.ID, new OctetString("qiucfsnmpv3k2"));
				//这种方式添加的用户仅能通过name和engineID获取，不能单纯通过name获取
				snmp.getUSM().addUser(new OctetString("qiucf2"), new OctetString("0002651100"), user2);
			}
		});
		thread1.start();
		
		Thread thread2 = new Thread(new Runnable() {
			@Override
			public void run() {
				
				try {
					TimeUnit.SECONDS.sleep(2);
				} catch (InterruptedException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
				
				Snmp snmp2;
				UsmUserEntry entry = null;
				try {
					snmp2 = new Snmp(new DefaultUdpTransportMapping());
					//entry = snmp2.getUSM().getUserTable().getUser(new OctetString("0002651100"), new OctetString("qiucf2"));
					entry = snmp2.getUSM().getUserTable().getUser(new OctetString("0002651100"),new OctetString("qiucf2"));
				} catch (IOException e1) {
					e1.printStackTrace();
				}
				
				try {
					System.out.println(entry.getUserName());
				} catch (Exception e) {
					System.out.println("No such user");
				}
			}
		});
		thread2.start();
		
		try {
			TimeUnit.SECONDS.sleep(3);
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		
		
		UserTarget target = new UserTarget();
		target.setVersion(SnmpConstants.version3);
		target.setAddress(new UdpAddress("192.168.0.100/161"));
		target.setSecurityLevel(SecurityLevel.AUTH_PRIV);
		target.setSecurityName(new OctetString("qiucf2"));
		//加上这句
		target.setAuthoritativeEngineID(new OctetString("0002651100").getValue());
		
		target.setTimeout(3000);	//3s
		target.setRetries(0);
				
		OctetString contextEngineId = new OctetString("0002651100[02]");
		sendRequest(snmp, createGetPdu(contextEngineId), target);
		snmpWalk(snmp, target, contextEngineId);
	}
	
	private static PDU createGetPdu(OctetString contextEngineId) {
		ScopedPDU pdu = new ScopedPDU();
		pdu.setType(PDU.GET);
		pdu.setContextEngineID(contextEngineId);	//if not set, will be SNMP engine id
		//pdu.setContextName(contextName);  //must be same as SNMP agent
		
		pdu.add(new VariableBinding(new OID("1.3.6.1.2.1.1.3.0")));	//sysUpTime
		pdu.add(new VariableBinding(new OID("1.3.6.1.2.1.1.5.0")));	//sysName
		pdu.add(new VariableBinding(new OID("1.3.6.1.2.1.1.5")));	//expect an no_such_instance error
		return pdu;
	}
	
	private static void sendRequest(Snmp snmp, PDU pdu, UserTarget target)
	throws IOException {
		ResponseEvent responseEvent = snmp.send(pdu, target);
		PDU response = responseEvent.getResponse();
		
		if (response == null) {
			System.out.println("TimeOut...");
		} else {
			if (response.getErrorStatus() == PDU.noError) {
				Vector<? extends VariableBinding> vbs = response.getVariableBindings();
				for (VariableBinding vb : vbs) {
					System.out.println(vb + " ," + vb.getVariable().getSyntaxString());
				}
			} else {
				System.out.println("Error:" + response.getErrorStatusText());
			}
		}
	}
	
	private static void snmpWalk(Snmp snmp, UserTarget target, OctetString contextEngineId) {
		TableUtils utils = new TableUtils(snmp,
				new MyDefaultPDUFactory(PDU.GETNEXT, //GETNEXT or GETBULK)
										contextEngineId));
		utils.setMaxNumRowsPerPDU(5);	//only for GETBULK, set max-repetitions, default is 10
		OID[] columnOids = new OID[] {
				new OID("1.3.6.1.2.1.1.9.1.2"),	//sysORID
				new OID("1.3.6.1.2.1.1.9.1.3")	//sysORDescr
		};
		// If not null, all returned rows have an index in a range (lowerBoundIndex, upperBoundIndex]
		List<TableEvent> l = utils.getTable(target, columnOids, new OID("3"), new OID("10"));
		for (TableEvent e : l) {
			System.out.println(e);
		}
	}
	
	private static class MyDefaultPDUFactory extends DefaultPDUFactory {
		private OctetString contextEngineId = null;
		
		public MyDefaultPDUFactory(int pduType, OctetString contextEngineId) {
			super(pduType);
			this.contextEngineId = contextEngineId;
		}
 
		@Override
		public PDU createPDU(Target target) {
			PDU pdu = super.createPDU(target);
			if (target.getVersion() == SnmpConstants.version3) {
				((ScopedPDU)pdu).setContextEngineID(contextEngineId);
			}
			return pdu;
		}		
	}
}