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

NAME

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

USAGE

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
20       application 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
25       generate the key to be used by the -authkey or -privkey named arguments
26       when they are passed to the Net::SNMP "session()" constructor.
27

REQUIRED ARGUMENTS

29       The "snmpkey" utility requires at least three command line arguments.
30       The first argument defines which hash algorithm to use when creating
31       the authKey.  Either HMAC-MD5-96 or HMAC-SHA-96 can be specified with
32       the string 'md5' or 'sha' respectively.  This choice must match the
33       algorithm passed to the -authprotocol argument when creating the
34       Net::SNMP object.  The second argument is the plain text password that
35       is to be localized to create the authKey.  The third required argument
36       is the authoritativeEngineID of the remote SNMP engine associated with
37       the Net::SNMP argument -hostname.  The authoritativeEngineID is to be
38       entered as a hexadecimal string 10 to 64 characters (5 to 32 octets)
39       long and can be prefixed with an optional "0x".
40
41       The last two arguments are optional and can be used to determine how
42       the privKey will be generated.  By default, the fourth argument assumes
43       a value of 'des' corresponding to the default privacy protocol defined
44       in the User-based Security Model.  The Net::SNMP module supports
45       CBC-3DES-EDE and CFB128-AES-128 as alternatives to the default protocol
46       CBC-DES.  These protocols can be chosen by specifying the string '3des'
47       or 'aes' respectively.  This choice must match the protocol passed to
48       the -privprotocol argument when creating the Net::SNMP object.  The
49       last argument can be used to specify the plain text password that is to
50       be localized to create the privKey.  If this argument is not specified,
51       the authKey password is used.
52

AUTHOR

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

57       Copyright (c) 2001-2009 David M. Town.  All rights reserved.
58
59       This program is free software; you may redistribute it and/or modify it
60       under the same terms as the Perl 5 programming language system itself.
61

SEE ALSO

63       Net::SNMP
64
65
66
67perl v5.36.0                      2022-07-22                        SNMPKEY(1)
Impressum