跳到主要內容

第一次寫MIB就上手

SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol,我對它的認識也是從工作接觸開始。雖說是管理網路設備,但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式,當然所有的操作也都可以透過SNMP來完成,不過可能會很痛苦。前陣子遇到一個學弟,它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。

在這篇文章中,不是要告訴你SNMP是什麼,會看這篇文章的大哥們,應該已經對SNMP有些認識了。

是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid,有MIB可以幫助你去了解它所提供的資訊是什麼,且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作,也讓我順便了解一下它的語法,接下來我要交給大家MIB的基礎認識。

smidump

我並非使用什麼高強的Editor去編寫MIB,我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具,唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了!

安裝

在Ubuntu上可先輸入smidump確認是否安裝,如果沒安裝可透過apt-get install libsmi2ldbl安裝。(CentOS可以透過yum install libsmi)

root@tonylin:~/multi-boot-server# smidump
The program 'smidump' is currently not installed.  You can install it by typing:
apt-get install libsmi2ldbl

使用

透過下面兩行指令,就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。

smidump -f tree example1.mib > xtree.txt
smidump -f identifiers example1.mib > xiden.txt

如果有參考其它檔案要加上p的參數:

smidump -f tree -p example1.mib example2.mib > xtree.txt
smidump -f identifiers -p example1.mib example2.mib > xiden.txt

MIB HelloWorld!

一個MIB要怎麼寫,就看你要提供的資料結構是怎樣。舉例來說,如果要提供一個神盾局(S.H.I.E.L.D)的MIB,以下是我的一個簡易範例(xtree):

--shieldMIB(1.3.6.1.4.1.135)
  |
  +-- rwn DisplayString directorName(1)
  |  
  +--staffObjects(2)
  |  |
  |  +--heroTable(1)
  |     |
  |     +--heroEntry(1) [heroIndex]
  |        |
  |        +-- --- Integer32         heroIndex(1)
  |        +-- r-n DisplayString     heroName(2)
  |        +-- rwn DisplayString     heroSex(3)
  |        +-- rwn Integer32         heroPower(4)
  |        +-- rwn DisplayString     wellknown(5)
  |
  +--enemyObjects(3)

(各oid中的名稱必須是小寫開頭)

對應的意義即:

  • 1.3.6.1.4.1.135.1: 局長姓名,Nick Fury。
  • 1.3.6.1.4.1.135.2: 雇員物件。我有列出來其下的heroTable。
  • 1.3.6.1.4.1.135.2.1: heroTable,放置各個英雄資訊。
    • 1.3.6.1.4.1.135.2.1: 英雄資訊。
      • 1.3.6.1.4.1.135.2.1.1: 識別號。
      • 1.3.6.1.4.1.135.2.1.2: 姓名,浩克。
      • 1.3.6.1.4.1.135.2.1.3: 性別,男。
      • 1.3.6.1.4.1.135.2.1.4: 攻擊力,65535。
      • 1.3.6.1.4.1.135.2.1.4: 名言,「好弱的神」。
  • 1.3.6.1.4.1.135.3: 敵人物件。與雇員物件雷同,不贅述。

像上面的範例我們該怎麼寫MIB呢? 

結構

以我觀察smidump的結果,共有node、table、row、column、scala、type、notification、compliance、group這幾個種類。在這個範例中會使用到的有node、table、row、column與scala。

彼此的關係如下:

  • node > table > row > column,一個node可能會有多個table,table下會有多個row,row下會有多個column。用於重複的屬性,如heroTable。
  • node > scala。用於不重複的屬性,如generalName。
  • node > node,把node當分支就對了,如staffObjects和enemyObjects。

Init MIB

一個初始的MIB file就長的像下面這個樣子,ModuleName就是這個MIB名稱;ImportsList就像是import library或package,包含所有會使用到的形態與物件的宣告,基本上也是使用到什麼就匯入什麼;AssignmentsList就是那堆oid結構宣告。

ModuleName DEFINITIONS ::= BEGIN
?ImportsList?
?AssignmentsList?
END

以這個範例來說,基本的雛形會長這個樣子:

SHIELDMIB DEFINITIONS ::= BEGIN
IMPORTS
	MODULE-IDENTITY,
	OBJECT-IDENTITY,
        OBJECT-TYPE,
	Integer32,
	enterprises
		FROM SNMPv2-SMI
	DisplayString
		FROM SNMPv2-TC;

?AssignmentsList?
END

MODULE-IDENTITY、OBJECT-IDENTITY、OBJECT-TYPE是用來描述結構與節點的;Integer32與DisplayString是會使用到的形態;enterprise代表1.3.6.1.4.1,SHIELDMIB是1.3.6.1.4.1.135,其中135必須與IANA註冊,也代表著你的ID,這是用來代表私人企業的意思。這些宣告後都有FROM XXXX,是要告訴smidump這些宣告的來源,你也可以將你寫過的MIB弄進來重複使用。(假如是一個很大的組織,可能都會有類似Common Library的MIB file)透過設定SMIPATH,可以把參考的路徑設定進去。

MODULE-IDENTITY

一個MIB Module就是需要一個MODULE-IDENTITY的宣告,裡面的內容就是記錄這個MIB Module的資訊。

shieldMIB MODULE-IDENTITY
    LAST-UPDATED "201208200000Z"
    ORGANIZATION "S.H.I.E.L.D"
    CONTACT-INFO "shield@shield.gov.us"
    DESCRIPTION  "復仇者聯盟"
    REVISION     "201005200000Z"
    DESCRIPTION  "神盾局創立"
    REVISION     "201102140000Z"
    DESCRIPTION  "浩克加入"
::= { enterprises 135 }   

依樣畫葫蘆,revision+description是用來描述這個module有做過什麼修改,如果不喜歡也可以在整個MIB file最上方用兩個減號(註解)做說明;::=之後是接OID。

OBJECT-IDENTITY

OBJECT-IDENTITY又叫branch node,用來做分類。以我們例子而言包含了staffObjects和enemyObjects,它們的oid宣告就是接在shieldMIB之後。

staffObjects OBJECT-IDENTIFIER ::= { shieldMIB 2 }
enemyObjects OBJECT-IDENTIFIER ::= { shieldMIB 3 }

OBJECT-TYPE

OBJECT-TYPE可表示scala、table、row與column。

scala

oid是接在node下,而且已經是leaf就是scala。以我們範例而言,就是神盾局局長,總不會同時會有兩個局長吧?其中SYNTAX代表著OBJECT-TYPE的型態;MAX-ACCESS代表著存取權限,可以參考這裡;STATUS代表這個oid目前的狀態,可以參考這裡

directorName OBJECT-TYPE
    SYNTAX      DisplayString
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION "The director's name for the S.H.I.E.L.D."
    ::= { shieldMIB 1 }

table&row

與scala最大的不同就在於SYNTAX的描述。以我們的範例而言,heroTable是一個table包含多個heroEntry row代表著不同英雄,而heroEntry中又會有個別的column去描述英雄屬性。你可以把HeroEntry(大寫的)當做一種資料結構,裡面就是描述英雄屬性,而heroEntry(小寫的)的型態就是這個結構。而heroTable的SYNTAX就是代表著很多個HeroEntry。另外要注意的是oid,heroEntry一定是在heroTable之下,而heroTable則是在staffObjects之下。

heroTable OBJECT-TYPE
    SYNTAX      SEQUENCE OF HeroEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
        "A table of hero entries."
    ::= { staffObjects 1 }

heroEntry OBJECT-TYPE
    SYNTAX        HeroEntry 
    MAX-ACCESS    not-accessible
    STATUS        current
    DESCRIPTION
        "An entry in the hero table."
    INDEX        { heroIndex }
    ::= { heroTable 1 }

HeroEntry ::=
    SEQUENCE {
        heroIndex      Integer32,
        heroName       DisplayString,
        heroSex        DisplayString,
        heroPower      Integer32,
        wellknown      DisplayString
    }

column

在row下的就是column,這部分寫法與scala大同小異,唯一差別就在於父節點是誰而已。

heroIndex      OBJECT-TYPE
	SYNTAX	    Integer32 (1..65535)
	MAX-ACCESS  not-accessible
	STATUS	    current
	DESCRIPTION
		"The unique value which identifies the hero."
	::= { heroEntry 1 }

heroName       OBJECT-TYPE
	SYNTAX	    DisplayString
	MAX-ACCESS  read-write
	STATUS	    current
	DESCRIPTION
		"A textual full name assigned to a hero."
	::= { heroEntry 2 }

部屬MIB

將寫好的MIB放到/usr/share/snmp/mibs/,接著執行export MIBS=ALL。只要透過snmpwalk -v 1 127.0.0.1 .1.3.6.1.4.1.135 -c public可以看到透過MIB翻譯後的結果。

但是不要天真的以為照做就能夠看到了! 你必須要有SNMP的Provider,否則執行snmpwalk系統哪知道這是誰家的裝置!

Summary

MIB的語法算是一種程式語言了。除了沒提及的type、notification、compliance、group外,其實還包含了許多細節。但我想如果之後有接觸再分享給大家。

Reference

延伸閱讀

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php