SNMP學習筆記之SNMP4J介紹(Java)

 

0x00 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的有效的異步表格獲取。
• 支持多線程。

 

0x01 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就是負責幫你寄信收信的郵差。

 

0x2 SNMP4J的兩種消息發送模式

 

　　SNMP4J支持兩種消息發送模式：同步發送模式和異步發送模式。

　　同步發送模式也稱阻塞模式。當管理端發送出一條消息之后，線程會被阻塞，直到收到對方的回應或者時間超時。同步發送模式編程較為簡單，但是不適用於發送廣播消息。

　　異步發送模式也稱非阻塞模式。當程序發送一條消息之后，線程將會繼續執行，當收到消息的回應的時候，程序會對消息作出相應的處理。要實現異步發送模式，需要實例化一個實現了ResponseListener接口的類的對象。ResponseListener接口中有一個名為onResponse的函數。這是一個回調函數，當程序收到響應的時候，會自動調用該函數。由該函數完成對響應的處理。

 

0x03 使用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函數。該函數中的語句便是我們對響應的處理

 

0x04 使用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、獲取遠程計算機的名稱

package me.gacl.snmp;

import java.io.IOException;
import org.snmp4j.CommunityTarget;
import org.snmp4j.PDU;
import org.snmp4j.ScopedPDU;
import org.snmp4j.Snmp;
import org.snmp4j.Target;
import org.snmp4j.TransportMapping;
import org.snmp4j.UserTarget;
import org.snmp4j.event.ResponseEvent;
import org.snmp4j.event.ResponseListener;
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.smi.Address;
import org.snmp4j.smi.GenericAddress;
import org.snmp4j.smi.OID;
import org.snmp4j.smi.OctetString;
import org.snmp4j.smi.VariableBinding;
import org.snmp4j.transport.DefaultUdpTransportMapping;

public class Snmp4jFirstDemo {

    private Snmp snmp = null;
    private int version ;

    public Snmp4jFirstDemo(int version) {
        try {
            this.version = version;
            TransportMapping transport = new DefaultUdpTransportMapping();
            snmp = new Snmp(transport);
            if (version == SnmpConstants.version3) {
                // 設置安全模式
                USM usm = new USM(SecurityProtocols.getInstance(),new OctetString(MPv3.createLocalEngineID()), 0);
                SecurityModels.getInstance().addSecurityModel(usm);
            }
            // 開始監聽消息
            transport.listen();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public void sendMessage(Boolean syn, final Boolean bro, PDU pdu, String addr)
            throws IOException {
        // 生成目標地址對象
        Address targetAddress = GenericAddress.parse(addr);
        Target target = null;
        if (version == SnmpConstants.version3) {
            // 添加用戶
            snmp.getUSM().addUser(new OctetString("MD5DES"),new UsmUser(new OctetString("MD5DES"), AuthMD5.ID,new OctetString("MD5DESUserAuthPassword"),PrivDES.ID, new OctetString("MD5DESUserPrivPassword")));
            target = new UserTarget();
            // 設置安全級別
            ((UserTarget) target).setSecurityLevel(SecurityLevel.AUTH_PRIV);
            ((UserTarget) target).setSecurityName(new OctetString("MD5DES"));
            target.setVersion(SnmpConstants.version3);
        } else {
            target = new CommunityTarget();
            if (version == SnmpConstants.version1) {
                target.setVersion(SnmpConstants.version1);
                ((CommunityTarget) target).setCommunity(new OctetString("public"));
            } else {
                target.setVersion(SnmpConstants.version2c);
                ((CommunityTarget) target).setCommunity(new OctetString("public"));
            }

        }
        // 目標對象相關設置
        target.setAddress(targetAddress);
        target.setRetries(5);
        target.setTimeout(1000);

        if (!syn) {
            // 發送報文 並且接受響應
            ResponseEvent response = snmp.send(pdu, target);
            // 處理響應
            System.out.println("Synchronize(同步) message(消息) from(來自) "
                    + response.getPeerAddress() + "\r\n"+"request(發送的請求):"
                    + response.getRequest() + "\r\n"+"response(返回的響應):"
                    + response.getResponse());
            /**
             * 輸出結果：
             * Synchronize(同步) message(消息) from(來自) 192.168.1.233/161
                request(發送的請求):GET[requestID=632977521, errorStatus=Success(0), errorIndex=0, VBS[1.3.6.1.2.1.1.5.0 = Null]]
                response(返回的響應):RESPONSE[requestID=632977521, errorStatus=Success(0), errorIndex=0, VBS[1.3.6.1.2.1.1.5.0 = WIN-667H6TS3U37]]

             */
        } else {
            // 設置監聽對象
            ResponseListener listener = new ResponseListener() {

                public void onResponse(ResponseEvent event) {
                    if (bro.equals(false)) {
                        ((Snmp) event.getSource()).cancel(event.getRequest(),this);
                    }
                    // 處理響應
                    PDU request = event.getRequest();
                    PDU response = event.getResponse();
                    System.out.println("Asynchronise(異步) message(消息) from(來自) "
                            + event.getPeerAddress() + "\r\n"+"request(發送的請求):" + request
                            + "\r\n"+"response(返回的響應):" + response);
                }

            };
            // 發送報文
            snmp.send(pdu, target, null, listener);
        }
    }

    public static void main(String[] args) {
        //Snmp的三個版本號
        //int ver3 = SnmpConstants.version3;
        int ver2c = SnmpConstants.version2c;
        //int ver1 = SnmpConstants.version1;
        Snmp4jFirstDemo manager = new Snmp4jFirstDemo(ver2c);
        // 構造報文
        PDU pdu = new PDU();
         //PDU pdu = new ScopedPDU();
        // 設置要獲取的對象ID，這個OID代表遠程計算機的名稱
        OID oids = new OID("1.3.6.1.2.1.1.5.0");
        pdu.add(new VariableBinding(oids));
        // 設置報文類型
        pdu.setType(PDU.GET);
        //((ScopedPDU) pdu).setContextName(new OctetString("priv"));
        try {
            // 發送消息 其中最后一個是想要發送的目標地址
            //manager.sendMessage(false, true, pdu, "udp:192.168.1.229/161");//192.168.1.229 Linux服務器
            manager.sendMessage(false, true, pdu, "udp:192.168.1.233/161");//192.168.1.233 WinServer2008服務器
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

 

5.2、獲得本機的信息

package me.gacl.snmp;

import java.io.IOException;
import org.snmp4j.CommunityTarget;
import org.snmp4j.PDU;
import org.snmp4j.Snmp;
import org.snmp4j.TransportMapping;
import org.snmp4j.event.ResponseEvent;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.smi.Address;
import org.snmp4j.smi.GenericAddress;
import org.snmp4j.smi.OID;
import org.snmp4j.smi.OctetString;
import org.snmp4j.smi.VariableBinding;
import org.snmp4j.transport.DefaultUdpTransportMapping;

/**
 * <p>ClassName: GetOID<p>
 * <p>Description:獲得本機的信息 <p>
 * @author xudp
 * @version 1.0 V
 * @createTime 2014-9-15 下午04:45:12
 */
public class GetOID {

    public static void main(String[] args) throws Exception{  
        
        try{  
            //設定CommunityTarget   
            CommunityTarget myTarget = new CommunityTarget();
            //定義遠程主機的地址  
            //Address deviceAdd = GenericAddress.parse("udp:192.168.1.233/161"); 
            //定義本機的地址   
            Address localAdd = GenericAddress.parse("udp:localhost/161");
            //設定遠程主機的地址 
            //myTarget.setAddress(deviceAdd); 
            //設定本地主機的地址
            myTarget.setAddress(localAdd);
            //設置snmp共同體   
            myTarget.setCommunity(new OctetString("public")); 
            //設置超時重試次數   
            myTarget.setRetries(2); 
            //設置超時的時間  
            myTarget.setTimeout(5*60);
            //設置使用的snmp版本 
            myTarget.setVersion(SnmpConstants.version2c);  
             
            //設定采取的協議   
            TransportMapping transport = new DefaultUdpTransportMapping();//設定傳輸協議為UDP
            //調用TransportMapping中的listen()方法，啟動監聽進程，接收消息，由於該監聽進程是守護進程，最后應調用close()方法來釋放該進程
            transport.listen();  
            //創建SNMP對象，用於發送請求PDU
            Snmp protocol = new Snmp(transport);  
            //創建請求pdu,獲取mib   
            PDU request = new PDU(); 
            //調用的add方法綁定要查詢的OID
            request.add(new VariableBinding(new OID("1.3.6.1.2.1.1.1")));  
            request.add(new VariableBinding(new OID(new int[] {1,3,6,1,2,1,1,2})));
            //調用setType()方法來確定該pdu的類型
            request.setType(PDU.GETNEXT);
            //調用 send(PDU pdu,Target target)發送pdu，返回一個ResponseEvent對象
            ResponseEvent responseEvent = protocol.send(request, myTarget);  
            //通過ResponseEvent對象來獲得SNMP請求的應答pdu，方法：public PDU getResponse()
            PDU response=responseEvent.getResponse();  
            //輸出   
            if(response != null){  
                System.out.println("request.size()="+request.size());  
                System.out.println("response.size()="+response.size());
                //通過應答pdu獲得mib信息（之前綁定的OID的值），方法：VaribleBinding get(int index)
                VariableBinding vb1 = response.get(0);  
                VariableBinding vb2 = response.get(1);  
                System.out.println(vb1);  
                System.out.println(vb2);
                //調用close()方法釋放該進程
                transport.close();  
                
                /**
                 * 輸出結果：
                 * request.size()=2
                   response.size()=2
                    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)
                    1.3.6.1.2.1.1.2.0 = 1.3.6.1.4.1.311.1.1.3.1.1

                 */
            }  
            
          }catch(IOException e){  
              e.printStackTrace();  
          }  
        }  
}

 

參考