Snmp學習總結(二)——SNMP4J介紹
一、SNMP4J介紹
SNMP4J是一個用Java來實現SNMP(簡單網路管理協議)協議的開源專案.它支援以命令列的形式進行管理與響應。SNMP4J是純面向物件設計與SNMP++(用C++實現SNMPv1/v2c/v3)相類似。
SNMP4J API 提供以下下特性：
- 支援MD5和SHA驗證，DES，3DES,AES128、AES192和AES256加密的SNMPv3。
- 支援MPv1,MPv2C和MPv3，帶執行的可阻塞的資訊處理模組。
- 全部PDU格式。
- 可阻塞的傳輸拓撲。支援UPD、TCP、TLS 。
- 可阻塞的超時模組。
- 同步和非同步請求。
- 命令發生器以及命令應答器的支援。
- 基於Apache license的開源免費。
- JAVA 1.4.1或更高版本(2.0或更高版本需要jdk1.6及以上的支援)。
- 基於LOG4J記錄日誌。
- 使用GETBULK實現Row-based的有效的非同步表格獲取。
- 支援多執行緒。
二、SNMP4J重要的類和介面介紹
2.1、Snmp類
Snmp類：該類是SNMP4J中最為核心的類。負責SNMP報文的接受和傳送。它提供了傳送和接收PDU的方法，所有的PDU型別都可以採用同步或者非同步的方式被髮送
2.2、PDU類和ScopedPDU類
該類是SNMP報文單元的抽象，其中PDU類適用於SNMPv1和SNMPv2c。ScopedPDU類繼承於PDU類，適用於SNMPv3。
2.3、Target介面和CommunityTarget類以及UserTarget類
對應於SNMP代理的地址資訊，包括IP地址和埠號（161）。其中Target介面適用於SNMPv1和SNMPv2c。CommunityTarget類實現了Target介面，用於SNMPv1和SNMPv2c這兩個版本，UserTarget類實現了Target介面，適用於SNMPv3。
2.4、TransportMapping介面
該介面代表了SNMP4J所使用的傳輸層協議。這也是SNMP4J一大特色的地方。按照RFC的規定，SNMP是隻使用UDP作為傳輸層協議的。而SNMP4J支援管理端和代理端使用UDP或者TCP進行傳輸。該介面有兩個子介面。
2.5、Snmp、Target、PDU三者的關係
Target代表遠端裝置或者遠端實體、PDU代表管理端同Target通訊的資料，Snmp就代表管理者管理功能（其實就是資料的收發）的具體執行者。
打個比方：Target就是你遠方的戀人，PDU就是你們之間傳遞的情書、而Snmp就是負責幫你寄信收信的郵差。
三、SNMP4J的兩種訊息傳送模式
SNMP4J支援兩種訊息傳送模式：同步傳送模式和非同步傳送模式。
同步傳送模式也稱阻塞模式。當管理端傳送出一條訊息之後，執行緒會被阻塞，直到收到對方的迴應或者時間超時。同步傳送模式程式設計較為簡單，但是不適用於傳送廣播訊息。
非同步傳送模式也稱非阻塞模式。當程式傳送一條訊息之後，執行緒將會繼續執行，當收到訊息的迴應的時候，程式會對訊息作出相應的處理。要實現非同步傳送模式，需要例項化一個實現了ResponseListener介面的類的物件。ResponseListener介面中有一個名為onResponse的函式。這是一個回撥函式，當程式收到響應的時候，會自動呼叫該函式。由該函式完成對響應的處理。
四、使用SNMP4J實現管理端的步驟
該部分說明了利用SNMP4J編寫SNMP管理端的大致過程，讀者在閱讀之後會對SNMP4J有一個巨集觀上的認識。在附錄部分，作者給出了一個用SNMP4J開發管理站的樣例程式，如果有進一步的需要，請參考附錄部分。
4.1 、初始化
①、明確SNMP在傳輸層所使用的協議
一般情況下，我們都使用使用UDP協議作為SNMP的傳輸層協議，所以我們需要例項化的是一個DefaultUdpTransportMapping介面物件；
②、例項化一個snmp物件
在此過程中，我們需要將1中例項化的DefaultUdpTransportMapping介面的物件作為引數，穿snmp類的建構函式中。另外，如果實現的SNMPv3協議，我們還需要設定安全機制，新增安全使用者等等；
③、監聽snmp訊息
在此，我們可以呼叫剛剛例項化的DefaultUdpTransportMapping的介面物件的listen方法，讓程式監聽snmp訊息；
4.2、 構造傳送目標
如果實現的是SNMPv2c或者說SNMPv1，需要例項化一個CommunityTarget物件。如果實現的是SNMPv3程式，則需要例項化一個UserTarget物件。
之後，我們還需要對例項化的物件做一些設定。如果是CommunityTarget的物件，則需要設定使用的Snmp版本，重傳時間和等待時延。如果是UserTarget物件，我們不僅需要設定版本、重傳時間、等待時延，還需要設定安全級別和安全名稱。
4.3、 構造傳送報文
如果傳送的是SNMPv2c或者說SNMPv1的報文，我們需要例項化一個PDU類的物件。如果傳送的是SNMPv3的報文，我們則需要例項化一個ScopedPDU類的物件。之後，我們還需要生成一個OID物件，其中包含了我們所需要獲取的SNMP物件在MIB庫中的ID。然後我們需要將OID和之前生成的PDU物件或者是ScopedPDU物件繫結，並且設定PDU的報文型別（五種SNMP報文型別之一）。
4.4、 構造響應監聽物件（非同步模式）
當使用非同步模式的時候，我們需要例項化一個實現了ResponseListener介面的物件，作為響應訊息的監聽物件。在構造該物件的過程中，我們需要重寫ResponseListener的OnResponse函式，該函式是一個回撥函式，用來處理程式收到響應後的一些操作。
4.5、 傳送訊息
當所有上述操作都設定完畢之後，就可以傳送訊息了。同步模式和非同步模式傳送訊息呼叫的函式名字均為send，但是兩個函式所需引數不一樣。同步模式的引數僅為4.2和4.3中構造的目標物件和報文物件，而非同步模式還需要4.4中構造的監聽物件。
同步模式傳送訊息後便等待響應的到達，到達之後會返回一個ResponseEvent物件，該物件中包含了響應的相應資訊。
非同步模式傳送訊息之後便會繼續執行，當收到響應訊息時便會呼叫監聽物件的OnResponse函式。該函式中的語句便是我們對響應的處理
五、使用SNMP4J實現管理端的程式設計實現
①、設定遠端實體
snmp4j中，用CommunityTarget物件來表示遠端實體（要進行snmp訊息通訊的遠端主機，使用snmp的v2版本）
②、指定遠端實體的地址
snmp4j中使用Address介面物件來表示，Address物件需要通過實現該介面的類的物件向上轉型來例項化
③、通過CommunityTarget以及其父介面中提供的setXX方法來設定遠端實體的屬性，如設定遠端實體的snmp共同體屬性、遠端實體的地址、超時時間、重傳次數、snmp版本等
④、設定使用的傳輸協議
snmp4j中，用TransportMapping介面的物件來表示傳輸協議（tcp/udp）
⑤、呼叫TransportMapping中的listen()方法，啟動監聽程序，接收訊息，由於該監聽程序是守護程序，最後應呼叫close()方法來釋放該程序
⑥、建立SNMP物件，用於傳送請求PDU
a、建立請求pdu，即建立PDU類的物件，呼叫PDU類中的add()方法繫結要查詢的OID，呼叫PDU中的setType()方法來確定該pdu的型別（與snmp中五種操作想對應）
b、通過PDU的構造方法 public SNMP(TransportMapping transportingMapping),或者其他構造方法來生成pdu,之後呼叫 ResopnseEvent send(PDU pdu,Target target)傳送pdu，該方法返回一個ResponseEvent物件
⑦、通過ResponseEvent物件來獲得SNMP請求的應答pdu，方法：public PDU getResponse()
⑧、通過應答pdu獲得mib資訊（之前繫結的OID的值），方法：VaribleBinding get（int index）
5.1、獲取遠端計算機的名稱
1 package me.gacl.snmp; 2 3 import java.io.IOException; 4 import org.snmp4j.CommunityTarget; 5 import org.snmp4j.PDU; 6 import org.snmp4j.ScopedPDU; 7 import org.snmp4j.Snmp; 8 import org.snmp4j.Target; 9 import org.snmp4j.TransportMapping; 10 import org.snmp4j.UserTarget; 11 import org.snmp4j.event.ResponseEvent; 12 import org.snmp4j.event.ResponseListener; 13 import org.snmp4j.mp.MPv3; 14 import org.snmp4j.mp.SnmpConstants; 15 import org.snmp4j.security.AuthMD5; 16 import org.snmp4j.security.PrivDES; 17 import org.snmp4j.security.SecurityLevel; 18 import org.snmp4j.security.SecurityModels; 19 import org.snmp4j.security.SecurityProtocols; 20 import org.snmp4j.security.USM; 21 import org.snmp4j.security.UsmUser; 22 import org.snmp4j.smi.Address; 23 import org.snmp4j.smi.GenericAddress; 24 import org.snmp4j.smi.OID; 25 import org.snmp4j.smi.OctetString; 26 import org.snmp4j.smi.VariableBinding; 27 import org.snmp4j.transport.DefaultUdpTransportMapping; 28 29 public class Snmp4jFirstDemo { 30 31 private Snmp snmp = null; 32 private int version ; 33 34 public Snmp4jFirstDemo(int version) { 35 try { 36 this.version = version; 37 TransportMapping transport = new DefaultUdpTransportMapping(); 38 snmp = new Snmp(transport); 39 if (version == SnmpConstants.version3) { 40 // 設定安全模式 41 USM usm = new USM(SecurityProtocols.getInstance(),new OctetString(MPv3.createLocalEngineID()), 0); 42 SecurityModels.getInstance().addSecurityModel(usm); 43 } 44 // 開始監聽訊息 45 transport.listen(); 46 } catch (IOException e) { 47 e.printStackTrace(); 48 } 49 } 50 51 public void sendMessage(Boolean syn, final Boolean bro, PDU pdu, String addr) 52 throws IOException { 53 // 生成目標地址物件 54 Address targetAddress = GenericAddress.parse(addr); 55 Target target = null; 56 if (version == SnmpConstants.version3) { 57 // 新增使用者 58 snmp.getUSM().addUser(new OctetString("MD5DES"),new UsmUser(new OctetString("MD5DES"), AuthMD5.ID,new OctetString("MD5DESUserAuthPassword"),PrivDES.ID, new OctetString("MD5DESUserPrivPassword"))); 59 target = new UserTarget(); 60 // 設定安全級別 61 ((UserTarget) target).setSecurityLevel(SecurityLevel.AUTH_PRIV); 62 ((UserTarget) target).setSecurityName(new OctetString("MD5DES")); 63 target.setVersion(SnmpConstants.version3); 64 } else { 65 target = new CommunityTarget(); 66 if (version == SnmpConstants.version1) { 67 target.setVersion(SnmpConstants.version1); 68 ((CommunityTarget) target).setCommunity(new OctetString("public")); 69 } else { 70 target.setVersion(SnmpConstants.version2c); 71 ((CommunityTarget) target).setCommunity(new OctetString("public")); 72 } 73 74 } 75 // 目標物件相關設定 76 target.setAddress(targetAddress); 77 target.setRetries(5); 78 target.setTimeout(1000); 79 80 if (!syn) { 81 // 傳送報文 並且接受響應 82 ResponseEvent response = snmp.send(pdu, target); 83 // 處理響應 84 System.out.println("Synchronize(同步) message(訊息) from(來自) " 85 + response.getPeerAddress() + "\r\n"+"request(傳送的請求):" 86 + response.getRequest() + "\r\n"+"response(返回的響應):" 87 + response.getResponse()); 88 /** 89 * 輸出結果： 90 * Synchronize(同步) message(訊息) from(來自) 192.168.1.233/161 91 request(傳送的請求):GET[requestID=632977521, errorStatus=Success(0), errorIndex=0, VBS[1.3.6.1.2.1.1.5.0 = Null]] 92 response(返回的響應):RESPONSE[requestID=632977521, errorStatus=Success(0), errorIndex=0, VBS[1.3.6.1.2.1.1.5.0 = WIN-667H6TS3U37]] 93 94 */ 95 } else { 96 // 設定監聽物件 97 ResponseListener listener = new ResponseListener() { 98 99 public void onResponse(ResponseEvent event) { 100 if (bro.equals(false)) { 101 ((Snmp) event.getSource()).cancel(event.getRequest(),this); 102 } 103 // 處理響應 104 PDU request = event.getRequest(); 105 PDU response = event.getResponse(); 106 System.out.println("Asynchronise(非同步) message(訊息) from(來自) " 107 + event.getPeerAddress() + "\r\n"+"request(傳送的請求):" + request 108 + "\r\n"+"response(返回的響應):" + response); 109 } 110 111 }; 112 // 傳送報文 113 snmp.send(pdu, target, null, listener); 114 } 115 } 116 117 public static void main(String[] args) { 118 //Snmp的三個版本號 119 //int ver3 = SnmpConstants.version3; 120 int ver2c = SnmpConstants.version2c; 121 //int ver1 = SnmpConstants.version1; 122 Snmp4jFirstDemo manager = new Snmp4jFirstDemo(ver2c); 123 // 構造報文 124 PDU pdu = new PDU(); 125 //PDU pdu = new ScopedPDU(); 126 // 設定要獲取的物件ID，這個OID代表遠端計算機的名稱 127 OID oids = new OID("1.3.6.1.2.1.1.5.0"); 128 pdu.add(new VariableBinding(oids)); 129 // 設定報文型別 130 pdu.setType(PDU.GET); 131 //((ScopedPDU) pdu).setContextName(new OctetString("priv")); 132 try { 133 // 傳送訊息 其中最後一個是想要傳送的目標地址 134 //manager.sendMessage(false, true, pdu, "udp:192.168.1.229/161");//192.168.1.229 Linux伺服器 135 manager.sendMessage(false, true, pdu, "udp:192.168.1.233/161");//192.168.1.233 WinServer2008伺服器 136 } catch (IOException e) { 137 e.printStackTrace(); 138 } 139 } 140 }
5.2、獲得本機的資訊
1 package me.gacl.snmp; 2 3 import java.io.IOException; 4 import org.snmp4j.CommunityTarget; 5 import org.snmp4j.PDU; 6 import org.snmp4j.Snmp; 7 import org.snmp4j.TransportMapping; 8 import org.snmp4j.event.ResponseEvent; 9 import org.snmp4j.mp.SnmpConstants; 10 import org.snmp4j.smi.Address; 11 import org.snmp4j.smi.GenericAddress; 12 import org.snmp4j.smi.OID; 13 import org.snmp4j.smi.OctetString; 14 import org.snmp4j.smi.VariableBinding; 15 import org.snmp4j.transport.DefaultUdpTransportMapping; 16 17 /** 18 * <p>ClassName: GetOID<p> 19 * <p>Description:獲得本機的資訊 <p> 20 * @author xudp 21 * @version 1.0 V 22 * @createTime 2014-9-15 下午04:45:12 23 */ 24 public class GetOID { 25 26 public static void main(String[] args) throws Exception{ 27 28 try{ 29 //設定CommunityTarget 30 CommunityTarget myTarget = new CommunityTarget(); 31 //定義遠端主機的地址 32 //Address deviceAdd = GenericAddress.parse("udp:192.168.1.233/161"); 33 //定義本機的地址 34 Address localAdd = GenericAddress.parse("udp:localhost/161"); 35 //設定遠端主機的地址 36 //myTarget.setAddress(deviceAdd); 37 //設定本地主機的地址 38 myTarget.setAddress(localAdd); 39 //設定snmp共同體 40 myTarget.setCommunity(new OctetString("public")); 41 //設定超時重試次數 42 myTarget.setRetries(2); 43 //設定超時的時間 44 myTarget.setTimeout(5*60); 45 //設定使用的snmp版本 46 myTarget.setVersion(SnmpConstants.version2c); 47 48 //設定採取的協議 49 TransportMapping transport = new DefaultUdpTransportMapping();//設定傳輸協議為UDP 50 //呼叫TransportMapping中的listen()方法，啟動監聽程序，接收訊息，由於該監聽程序是守護程序，最後應呼叫close()方法來釋放該程序 51 transport.listen(); 52 //建立SNMP物件，用於傳送請求PDU 53 Snmp protocol = new Snmp(transport); 54 //建立請求pdu,獲取mib 55 PDU request = new PDU(); 56 //呼叫的add方法繫結要查詢的OID 57 request.add(new VariableBinding(new OID("1.3.6.1.2.1.1.1"))); 58 request.add(new VariableBinding(new OID(new int[] {1,3,6,1,2,1,1,2}))); 59 //呼叫setType()方法來確定該pdu的型別 60 request.setType(PDU.GETNEXT); 61 //呼叫 send(PDU pdu,Target target)傳送pdu，返回一個ResponseEvent物件 62 ResponseEvent responseEvent = protocol.send(request, myTarget); 63 //通過ResponseEvent物件來獲得SNMP請求的應答pdu，方法：public PDU getResponse() 64 PDU response=responseEvent.getResponse(); 65 //輸出 66 if(response != null){ 67 System.out.println("request.size()="+request.size()); 68 System.out.println("response.size()="+response.size()); 69 //通過應答pdu獲得mib資訊（之前繫結的OID的值），方法：VaribleBinding get(int index) 70 VariableBinding vb1 = response.get(0); 71 VariableBinding vb2 = response.get(1); 72 System.out.println(vb1); 73 System.out.println(vb2); 74 //呼叫close()方法釋放該程序 75 transport.close(); 76 77 /** 78 * 輸出結果： 79 * request.size()=2 80 response.size()=2 81 1.3.6.1.2.1.1.1.0 = Hardware: x86 Family 6 Model 58 Stepping 9 AT/AT COMPATIBLE - Software: Windows 2000 Version 5.1 (Build 2600 Multiprocessor Free)