OSDN Git Service

Import translated manuals from JM CVS Repository.
[linuxjm/jm.git] / manual / ucd-snmp / original / man1 / snmpusm.1
1 .TH SNMPUSM 1 "02 Feb 2000"
2 .UC 4
3 .SH NAME
4 snmpusm - creates and maintains SNMPv3 user's on a remote entity.
5 .SH SYNOPSIS
6 snmpusm [ common arguments ] create username [cloneFromUser]
7 .br
8 snmpusm [ common arguments ] delete username
9 .br
10 snmpusm [ common arguments ] cloneFrom username cloneFromUser
11 .br
12 snmpusm [ common arguments ] passwd [-Co] [-Ca] [-Cx] old_passphrase new_passphrase
13
14 .SH DESCRIPTION
15 Snmpusm is an SNMP application that can be used to do simple maintenance
16 on a SNMP agent's User based Security Module (USM) table.  You can
17 create, delete, clone, and change the password of users configured on a 
18 running SNMP agent.
19 .PP
20 The SNMPv3 USM specifications (see RFC2574) dictate that users are
21 created and maintained by adding and modifying rows to the usmUser MIB
22 table.  To create a new user you simply create the row using an
23 snmpset.  User's profiles contain private keys that are never
24 transmitted over the wire in clear text (regardless of whether the
25 administration requests are in encrypted or not).  
26 .PP
27 The secret key for a user is initially set by cloning another user in
28 the table, so that a new user inherits the cloned user's secret key.
29 A user can only be cloned once, however, after which they must be
30 deleted and re-created to be re-cloned.  The authentication and
31 privacy security types are also inherited during this cloning (E.G.,
32 MD5 vs SHA1).  To change the secret key for a user, you must know the
33 user's old passphrase as well as the new one.  The passwd sub-command
34 of the snmpusm command, therefore, requires both the new and the old
35 password to be supplied.  After cloning from the appropriate
36 template, you should immediately change the new users password.
37 .PP
38 The ucd-snmp agent must first be initialized so that at least one user
39 is setup in it before you can use this command to clone new ones.  See the
40 .I snmpd.conf(5)
41 manual page on the
42 .B createUser
43 configuration parameter.
44 .SH EXAMPLES
45 .PP
46 Lets assume for our examples that the following VACM and USM
47 configurations lines were in the snmpd.conf file for a ucd-snmp agent,
48 which sets up a default user called "initial" with the passphrase
49 "setup_password" so that we can perform the initial setup of an agent:
50 .RS
51 .nf
52 # VACM configuration entries
53 rwuser initial
54 # lets add the new user we'll create too:
55 rwuser wes
56 # USM configuration entries
57 createUser initial MD5 setup_password DES
58 .fi
59 .RE
60 Note: that the "initial" user's setup should be removed after creating
61 a real user that you grant administrative privileges to (like the user 
62 "wes" we'll be creating in this example.
63 .PP
64 Note: passwords (passphrases really) must be 8 characters minimum in
65 length.
66 .IP "snmpusm -v 3 -u initial -n "" -l authNoPriv -a MD5 -A setup_password localhost create wes initial"
67 Creates a new user, here named "wes" using the user "initial" to do
68 it.  "wes" is cloned from "initial" in the process, so he inherits
69 that users password ("setup_password").
70 .IP "snmpusm -v 3 -u wes -n "" -l authNoPriv -a MD5 -A setup_password localhost passwd -setup_password new_passphrase"
71 After creating the user "wes" with the same password as the
72 "initial" user, we need to change his passphrase for him.  The above
73 command changed it from "setup_password", which was inherited from
74 the initial user, to "new_passphrase".
75 .IP "snmpget -v 3 -u wes -n "" -l authNoPriv -a MD5 -A new_passphrase localhost sysUpTime.0"
76 If the above commands were successful, this command should have
77 properly performed an authenticated snmpv3 GET request to the agent.
78 .PP
79 Now, go remove the vacm "group" snmpd.conf entry for the "initial"
80 user and you have a valid user 'wes' that you can use for future
81 transactions instead of initial.
82 .PP
83 .SH "SEE ALSO"
84 snmpd.conf(5), snmp.conf(5)