Difference between revisions of "TUT:Using TLS"

Revision as of 16:26, 12 May 2010

"SNMP over DTLS over UDP" and "SNMP over TLS over TCP" are supported in Net-SNMP 5.6 and beyond. This page describes how to use DTLS or TLS for the end user. For information on the administering and configuring the agent with DTLS/TLS support, see Using_DTLS.

Zero-config Example

This section assumes you already have your certificate(s) in place and know the fingerprints for your identity and that of the remote server. More information on obtaining and setting up that information is discussed below.

snmpget -t 10 -T my_fingerprint=CD:74:45:C9:A3:A3:55:0A:6C:37:03:B2:49:38:B1:01:99:95:8E:43 \
        -T their_fingerprint=CA:B8:0A:B3:6B:4C:21:2A:F2:92:CD:0B:6B:DF:6A:9F:23:D6:30:4B \
        -v 3 -l authPriv dtlsudp:test.net-snmp.org:9161 sysUpTime.0

In this example, test.net-snmp.org is the host name of the agent to query, using version 3 of the SNMP protocol and the transport security model, and an authPriv message protected a dtls connection using the certificates identified by the given fingerprints. The OID being requested is sysUpTime.0 from the MIB module SNMPv2-MIB.

DTLS vs TLS

TLS and DTLS are both protocols that protect packets in transit. The first runs over TCP and the second over UDP, which both have unique advantages (and a discussion of those advantages is beyond scope of this tutorial).

Below you'll find examples that use both the dtlsudp: prefix and the tlstcp: prefix. Our test.net-snmp.org server will respond to both transports so you can try them both out.

Obtaining and using test.net-snmp.org certificates

TBD

Once you have the tutoral .snmp directory, uncompress it in your home directory:

$ tar xvfz tutorial-.snmp.tar.gz

.snmp/
.snmp/snmp.conf.tutorial
.snmp/tls/
.snmp/tls/newcerts/
.snmp/tls/private/
.snmp/tls/private/tutorial-joecool.key
.snmp/tls/ca-certs/
.snmp/tls/ca-certs/tutorial-CA.crt
.snmp/tls/openssl.conf
.snmp/tls/certs/
.snmp/tls/certs/tutorial-joecool.crt
.snmp/tls/certs/tutorial-agent.crt

You can use net-snmp-cert to show you the certificates (and their fingerprints):

$ net-snmp-cert showcert
/home/dummy/.snmp/tls:

certs/tutorial-agent.crt:
subject= /C=US/ST=California/O=Net-SNMP Developers/OU=SNMP-TLS/CN=tutorial-agent/emailAddress=tutorial-agent@test.net-snmp.org


certs/tutorial-joecool.crt:
subject= /C=US/ST=California/O=Net-SNMP Developers/OU=SNMP-TLS/CN=Joe Cool/emailAddress=joe.cool@test.net-snmp.org

$ net-snmp-cert showcert --fingerprint
/home/dummy/.snmp/tls:

certs/tutorial-agent.crt:
SHA1 Fingerprint=CA:B8:0A:B3:6B:4C:21:2A:F2:92:CD:0B:6B:DF:6A:9F:23:D6:30:4B


certs/tutorial-joecool.crt:
SHA1 Fingerprint=CD:74:45:C9:A3:A3:55:0A:6C:37:03:B2:49:38:B1:01:99:95:8E:43

Now that you have the certificates, you can query the test agent:

snmpget -T my_fingerprint=CD:74:45:C9:A3:A3:55:0A:6C:37:03:B2:49:38:B1:01:99:95:8E:43 \
        -T their_fingerprint=CA:B8:0A:B3:6B:4C:21:2A:F2:92:CD:0B:6B:DF:6A:9F:23:D6:30:4B 
        --defSecurityModel=tsm -l ap -u "Joe Cool" -v 3 tlstcp:test.net-snmp.org:9161 sysContact.0

That's a long ugly command line, so you might want to add some defaults in your configuration file, snmp.conf. There is an included snmp.conf file, but to ensure that we don't overwrite any existing snmp.conf it must be appended to your existing configuration file.

$ cat $HOME/.snmp/snmp.conf.tutorial >> $HOME/.snmp/snmp.conf

Now try this much simpler query:

$ snmpget -v 3 tlstcp:test.net-snmp.org:9161 sysContact.0
SNMPv2-MIB::sysContact.0 = STRING: Net-SNMP Coders <net-snmp-coders@lists.sourceforge.net>

Tutorial Sections

About the SNMP Protocol

These tutorial links talk about SNMP generically and how the protocol itself works. They are good introductory reading material and the concepts are important to understand before diving into the later tutorials about Net-SNMP itself.

• How SNMP Works: About the protocol itself (GETs, GETNEXTs, etc)
• What data is in SNMP: All about SNMP Management Information Bases (MIBs)
• Securing SNMP: How to use the SNMP protocol securely

Net-SNMP Command Line Applications

These tutorial pages discuss the command line tools provided in the Net-SNMP suite of tools. Nearly all the example commands in these tutorials works if you try it yourself, as they're all examples that talk to our online Net-SNMP test agent. Given them a shot!

• snmptranslate: learning about the MIB tree.
• snmpget: retrieving data from a host.
• snmpgetnext: retrieving unknown indexed data.
• snmpwalk: retrieving lots of data at once!
• snmptable: displaying a table.
• snmpset: peforming write operations.
• snmpbulkget: communicates with a network entity using SNMP GETBULK request
• snmpbulkwalk: retrieve a sub-tree of management values using SNMP GETBULK requests.
• snmptrap: Sending and receiving traps, and acting upon them.
  • Traps/informs with SNMPv3/USM: Sending and receiving SNMPv3/USM TRAPs and INFORMs
  • Sending Traps/Informs via AgentX: Sending notifications from the command line through snmpd
• Common command line options:
  • Using and loading MIBS
  • SNMPv3/USM Options
  • Using SNMPv3 over TLS and DTLS
  • Customized Output Formats
• Writing mib2c config files

Application Configuration

All of our applications support configuration to allow you to customize how they behave.

• Configuration files for Net-SNMP applications

Net-SNMP Daemons

Net-SNMP comes with two long-running daemons: a SNMP agent (snmpd) for responding to management requests and a notification receiver (snmptrapd) for receiving SNMP notifications.

• SNMP Agent (snmpd) Configuration
  • Configuration Basics
  • Access Control (VACM)
  • snmpconf
• SNMP Notification Receiver (snmptrapd)
  • Configuring snmptrapd
  • Configuring SNMPv3 notifications
  • Configuring snmptrapd to understand vendor-specific MIBS (Cisco)
• Agent Monitoring
  • DisMan Monitoring
  • Monitoring with MRTG

Coding Tutorials

Net-SNMP comes with a highly flexible and extensible API. The API allows you to create your own commands, add extensions to the agent to support your own MIBs and perform specialized processing of notifications.

• Client / Manager Coding Tutorials
  • Writing a simple application
  • Writing a simple asynchronous application
• Agent Coding Tutorials
  • The Agent Architecture page might be worth reading before or after the agent coding tutorials, and describes how the Agent Helpers work under the hood.
  • Writing a mib module to serve information described by an SNMP MIB, and how to compile it into the net-snmp snmpd agent.
  • Writing a Dynamically Loadable Object that can be loaded into the SNMP agent.
  • Writing a Subagent that can be run to attach to the snmpd master agent.
  • Writing a perl plugin to extend the agent using the NetSNMP::agent module.
  • Writing shell scripts to extend the agent
  • Using mib2c to help write an agent code template for you
    • General mib2c Overview
    • Using the mib2c-update script to recode your code
    • mib2c.mfd.conf tutorial
• Header files and autoconf

Debugging SNMP Applications and Agents

All our tools and applications have extensive debugging output. These tutorials talk about how the debugging system works and how you can add your own debugging statements to you code:

• Debugging output printed using the -D command line option
  • Putting DEBUGMSG tokens in your code
• Using -Ddump to display packet breakdowns
• Debugging using GDB

Operating System Specific Tutorials

• Building With Visual Studio 2005 Express
  • Using the command line and nmake
• Building Net-SNMP 64-bit with Visual C++ 2010 Express
  • Using the command line and nmake (VC++ 2010 Express)
• Net-Snmp on Ubuntu
• Net-SNMP and lm-sensors on Ubuntu 10.04
• Net-SNMP for windows:
  • How to install: [1]
  • How to configure: [2]