Network.Protocol.Snmp

snmp types

data Value

Snmp data types

Constructors

OI OID

Zero

Integer Int32

String ByteString

IpAddress Word8 Word8 Word8 Word8

Counter32 Word32

Gauge32 Word32

TimeTicks Word32

Opaque ByteString

Counter64 Word64

ZeroDotZero

NoSuchInstance

NoSuchObject

EndOfMibView

Instances

Eq Value

Show Value

ASN1Object Value

type OID = [Integer]

Standard ASN.1 Object ID (OID)

type OIDS = [OID]

top level types

data V2

Phantom type for version 2 (Header V2, PDU V2)

Instances

HasV2 V2

HasItem V2

ASN1Object (PDU V2)

ASN1Object (Header V2)

Construct (PDU V2)

Construct (Header V2)

data V3

Phantom type for version 3 (Header V3, PDU V3)

Instances

HasV3 V3

HasItem V3

ASN1Object (PDU V3)

ASN1Object (Header V3)

Binary (PDU V3)

Construct (PDU V3)

Construct (Header V3)

data Version

Snmp version tag

Constructors

Version1

Version2

Version3

Instances

Eq Version

Show Version

ASN1Object Version

Construct (Version -> Packet)

Construct (Version -> Config)

data Packet

Top level type, which describe snmp packet

Instances

Eq Packet

Show Packet

ASN1Object Packet

Binary Packet

Construct (Version -> Packet)

header

data Header a

Snmp header without version tag

Instances

Eq (Header a)

Show (Header a)

ASN1Object (Header V3)

ASN1Object (Header V2)

Construct (Header V3)

Construct (Header V2)

header snmpV2

newtype Community

(snmp2 only) Community for 2(1) version

Constructors

Community ByteString

Instances

Eq Community

Show Community

ASN1Object Community

header snmpV3

newtype ID

(snmp3 only) Message Identifier (like RequestId in PDU)

Constructors

ID Int32

Instances

Eq ID

Show ID

ASN1Object ID

newtype MaxSize

(snmp3 only) Message max size must be > 484

Constructors

MaxSize Integer

Instances

Eq MaxSize

Show MaxSize

ASN1Object MaxSize

data Flag

(snmp3 only) rfc3412, message flag

Constructors

Flag Reportable PrivAuth

Instances

Eq Flag

Show Flag

ASN1Object Flag

data SecurityModel

(snmp3 only) rfc3412, security model

Constructors

UserBasedSecurityModel

Instances

Eq SecurityModel

Show SecurityModel

ASN1Object SecurityModel

data SecurityParameter

(snmp3 only) rfc3412, security parameter

Constructors

SecurityParameter

Fields

authoritiveEngineId :: ByteString

authoritiveEngineBoots :: Int32

authoritiveEngineTime :: Int32

userName :: ByteString

authenticationParameters :: ByteString

privacyParameters :: ByteString

Instances

Eq SecurityParameter

Show SecurityParameter

ASN1Object SecurityParameter

Construct SecurityParameter

type Reportable = Bool

(snmp3 only) rfc3412, as PrivAuth

data PrivAuth

(snmp3 only) rfc3412, type for create message flag

Constructors

NoAuthNoPriv

AuthNoPriv

AuthPriv

Instances

Eq PrivAuth

Show PrivAuth

type EngineBootId = Int32

type PrivacyParameter = ByteString

type EngineTime = Int32

type EngineId = ByteString

PDU

data PDU a where

Snmp body

Constructors

CryptedPDU :: ByteString -> PDU V3

Instances

Eq (PDU a)

Show (PDU a)

ASN1Object (PDU V3)

ASN1Object (PDU V2)

Binary (PDU V3)

Construct (PDU V3)

Construct (PDU V2)

PDU universal

data Request

requests

Constructors

GetRequest

Fields

rid :: RequestId

es :: ErrorStatus

ei :: ErrorIndex

GetNextRequest

Fields

rid :: RequestId

es :: ErrorStatus

ei :: ErrorIndex

GetResponse

Fields

rid :: RequestId

es :: ErrorStatus

ei :: ErrorIndex

SetRequest

Fields

rid :: RequestId

es :: ErrorStatus

ei :: ErrorIndex

GetBulk

Fields

rid :: RequestId

es :: ErrorStatus

ei :: ErrorIndex

Inform

Fields

rid :: RequestId

es :: ErrorStatus

ei :: ErrorIndex

V2Trap

Fields

rid :: RequestId

es :: ErrorStatus

ei :: ErrorIndex

Report

Fields

rid :: RequestId

es :: ErrorStatus

ei :: ErrorIndex

Instances

Eq Request

Show Request

Construct Request

type RequestId = Int32

Request id

type ErrorStatus = Integer

Error status

type ErrorIndex = Integer

Error index

newtype Suite

Variable bindings

Constructors

Suite [Coupla]

Instances

Eq Suite

Show Suite

ASN1Object Suite

Monoid Suite

Construct Suite

data Coupla

Coupla oid -> value

Constructors

Coupla

Fields

oid :: OID

value :: Value

Instances

Eq Coupla

Show Coupla

PDU snmpV3

newtype ContextEngineID

(snmp3 only) rfc3412, types for ScopedPDU

Constructors

ContextEngineID ByteString

Instances

Eq ContextEngineID

Show ContextEngineID

newtype ContextName

Constructors

ContextName ByteString

Instances

Eq ContextName

Show ContextName

some classes and helpers

universal, for work with both versions

class HasItem a where

some universal getters, setters

Methods

getHeader :: Packet -> Header a

setHeader :: Header a -> Packet -> Packet

getPDU :: Packet -> PDU a

setPDU :: PDU a -> Packet -> Packet

Instances

HasItem V3

HasItem V2

v2 only, for work with Header V2

class HasV2 a where

(snmp2 only) getters, setters for work with Header V2

Methods

getCommunity :: Header a -> Community

setCommunity :: Community -> Header a -> Header a

Instances

HasV2 V2

v3 only, for work with Header V3, PDU V3

class HasV3 a where

(snmp3 only) getters, setters for work with Header V3 and PDU V3.

Methods

getID :: Header a -> ID

getMaxSize :: Header a -> MaxSize

getFlag :: Header a -> Flag

getSecurityModel :: Header a -> SecurityModel

getSecurityParameter :: Header a -> SecurityParameter

getAuthoritiveEngineId :: Header a -> ByteString

getAuthoritiveEngineBoots :: Header a -> Int32

getAuthoritiveEngineTime :: Header a -> Int32

getUserName :: Header a -> ByteString

getAuthenticationParameters :: Header a -> ByteString

getPrivacyParameters :: Header a -> ByteString

getContextEngineID :: PDU a -> ContextEngineID

getContextName :: PDU a -> ContextName

setID :: ID -> Header a -> Header a

setMaxSize :: MaxSize -> Header a -> Header a

setFlag :: Flag -> Header a -> Header a

setSecurityModel :: SecurityModel -> Header a -> Header a

setSecurityParameter :: SecurityParameter -> Header a -> Header a

setAuthoritiveEngineId :: ByteString -> Header a -> Header a

setAuthoritiveEngineBoots :: Int32 -> Header a -> Header a

setAuthoritiveEngineTime :: Int32 -> Header a -> Header a

setUserName :: ByteString -> Header a -> Header a

setAuthenticationParameters :: ByteString -> Header a -> Header a

setPrivacyParameters :: ByteString -> Header a -> Header a

setContextEngineID :: ContextEngineID -> PDU a -> PDU a

setContextName :: ContextName -> PDU a -> PDU a

Instances

HasV3 V3

create new Packet

class Construct a where

initial new object, like mempty for monoid

Methods

initial :: a

Instances

Construct SecurityParameter

Construct Suite

Construct Request

Construct (PDU V3)

Construct (PDU V2)

Construct (Header V3)

Construct (Header V2)

Construct (Version -> Packet)

Construct (Version -> Config)

helpers for work with Packet

universal

getVersion :: Packet -> Version

getRequest :: Packet -> Request

setRequest :: Request -> Packet -> Packet

getRid :: Packet -> RequestId

setRid :: RequestId -> Packet -> Packet

getSuite :: Packet -> Suite

setSuite :: Suite -> Packet -> Packet

getErrorStatus :: Packet -> ErrorStatus

setErrorStatus :: ErrorStatus -> Packet -> Packet

v2 only

setCommunityP :: Community -> Packet -> Packet

v3 only

setIDP :: ID -> Packet -> Packet

setMaxSizeP :: MaxSize -> Packet -> Packet

setUserNameP :: ByteString -> Packet -> Packet

getAuthenticationParametersP :: Packet -> ByteString

setAuthenticationParametersP :: ByteString -> Packet -> Packet

setReportableP :: Reportable -> Packet -> Packet

setPrivAuthP :: PrivAuth -> Packet -> Packet

getEngineIdP :: Packet -> EngineId

setEngineIdP :: EngineId -> Packet -> Packet

getEngineBootsP :: Packet -> EngineBootId

setEngineBootsP :: EngineBootId -> Packet -> Packet

getEngineTimeP :: Packet -> Int32

setEngineTimeP :: Int32 -> Packet -> Packet

getPrivParametersP :: Packet -> ByteString

setPrivParametersP :: ByteString -> Packet -> Packet

authentication

passwordToKey :: AuthType -> Password -> EngineId -> Key

create auth key from password and context engine id

signPacket :: AuthType -> Key -> Packet -> Packet

(only V3) sign Packet

data AuthType

Constructors

MD5

SHA

Instances

Eq AuthType

Show AuthType

data PrivType

Constructors

DES

AES

Instances

Eq PrivType

Show PrivType

type Password = ByteString

type Key = ByteString

cleanPass :: ByteString

priv

type Salt = ByteString

type Raw = ByteString

type Encrypted = ByteString

type Rand32 = Int32

type Rand64 = Int64

desEncrypt :: Key -> EngineBootId -> Rand32 -> Raw -> (Encrypted, Salt)

desDecrypt :: Key -> Salt -> Encrypted -> Raw

aesEncrypt :: Key -> EngineBootId -> EngineTime -> Rand64 -> Raw -> (Encrypted, Salt)

aesDecrypt :: Key -> Salt -> EngineBootId -> EngineTime -> Encrypted -> Raw

toSalt :: Int32 -> Int32 -> ByteString

exceptions

data ClientException

some exception

Constructors

TimeoutException

ServerException Integer

Instances

Eq ClientException

Show ClientException

Exception ClientException

Typeable * ClientException

usage example

Here example for snmpV2

import Network.Protocol.Snmp
import Control.Applicative
import Network.Socket.ByteString (recv, sendAll)
import Network.Socket hiding (recv, sendAll)

-- create new empty packet
v2 :: Packet
v2 = initial Version2

community = Community "hello"

oi = Coupla [1,3,6,1,2,1,1,4,0] Zero

-- set community, oid
packet :: Community -> Coupla -> Packet
packet community oi = 
  setCommunityP community . setSuite (Suite [oi]) $ v2

-- here must be code for create udp socket
makeSocket :: Hostname -> Port -> IO Socket
makeSocket = undefined

main :: IO ()
main = do
   socket <- makeSocket "localhost" "161"
   sendAll socket $ encode $ setRequest (GetRequest 1 0 0) packet
   result <- decode <$> recv socket 1500 :: IO Packet
   print $ getSuite result