1SNMPKEY(1)            User Contributed Perl Documentation           SNMPKEY(1)
2
3
4

NAME

6       snmpkey - Create SNMPv3 security keys for the Net::SNMP module
7

SYNOPSIS

9       The "snmpkey" utility generates security keys based on a password and
10       an authoritativeEngineID passed on the command line.  This key can then
11       be used by the Net::SNMP module instead of the plain text password when
12       creating SNMPv3 objects.
13
14          snmpkey <authProto> <password> <authEngineID> [<privProto> [<password>]]
15

DESCRIPTION

17       The User-based Security Model used by SNMPv3 defines an algorithm which
18       "localizes" a plain text password to a specific authoritativeEngineID
19       using a one-way hash.  This resulting key is used by the SNMP applica‐
20       tion instead of the plain text password for security reasons.
21
22       The Net::SNMP module allows the user to either provide a plain text
23       password or a localized key to the object constructor when configuring
24       authentication or privacy.  The "snmpkey" utility can be used to gener‐
25       ate the key to be used by the -authkey or -privkey named arguments when
26       they are passed to the Net::SNMP "session()" constructor.
27
28       The "snmpkey" utility requires at least three command line arguments.
29       The first argument defines which hash algorithm to use when creating
30       the authKey.  Either HMAC-MD5-96 or HMAC-SHA-96 can be specified with
31       the string 'md5' or 'sha' respectively.  This choice must match the
32       algorithm passed to the -authprotocol argument when creating the
33       Net::SNMP object.  The second argument is the plain text password that
34       is to be localized to create the authKey.  The third required argument
35       is the authoritativeEngineID of the remote SNMP engine associated with
36       the Net::SNMP argument -hostname.  The authoritativeEngineID is to be
37       entered as a hexadecimal string 10 to 64 characters (5 to 32 octets)
38       long and can be prefixed with an optional "0x".
39
40       The last two arguments are optional and can be used to determine how
41       the privKey will be generated.  By default, the fourth argument assumes
42       a value of 'des' corresponding to the default privacy protocol defined
43       in the User-based Security Model.  The Net::SNMP module supports
44       CBC-3DES-EDE and CFB128-AES-128 as alternatives to the default protocol
45       CBC-DES.  These protocols can be chosen by specifying the string '3des'
46       or 'aes' respectively.  This choice must match the protocol passed to
47       the -privprotocol argument when creating the Net::SNMP object.  The
48       last argument can be used to specify the plain text password that is to
49       be localized to create the privKey.  If this argument is not specified,
50       the authKey password is used.
51

AUTHOR

53       David M. Town <dtown@cpan.org>
54

56       Copyright (c) 2001-2005 David M. Town.  All rights reserved.  This pro‐
57       gram is free software; you may redistribute it and/or modify it under
58       the same terms as Perl itself.
59

SEE ALSO

61       Net::SNMP
62
63
64
65perl v5.8.8                       2006-05-18                        SNMPKEY(1)
Impressum