| blob | 8b8486213eef3c3a115697bdd209b0f39ab875ce |
1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SMTNRHDB 1M "Dec 19, 2008"
7 .SH NAME
8 smtnrhdb \- manage entries in the tnrhdb database
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/sadm/bin/smtnrhdb\fR \fIsubcommand\fR [\fIauth_args\fR] \fB--\fR \fIsubcommand_args\fR]
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBsmtnrhdb\fR command adds, modifies, deletes, and lists entries in the
19 \fBtnrhdb\fR database.
20 .sp
21 .LP
22 The \fBtnrhdb\fR database specifies which remote-host template to use for each
23 host, including the local host, in the distributed system. If a host's IP
24 address cannot be matched to some entry in the \fBtnrhdb\fR database,
25 communication with the host is not permitted.
26 .sp
27 .LP
28 The \fBsmtnrhdb\fR command requires the Solaris Management Console to be
29 initialized for the command to succeed (see \fBsmc\fR(1M)). After rebooting the
30 Solaris Management Console server, the first \fBsmc\fR connection can time out,
31 so you might need to retry the command.
32 .SS "Valid Host Addresses and Wildcards"
33 .sp
34 .LP
35 The trusted network software uses a network "longest prefix of matching bits"
36 mechanism when looking for a host. The software looks first for the IP address
37 of the host. If the software does not find this address, then the software
38 falls back to searching for an IP address with the longest prefix of a matching
39 bit pattern, and so on.
40 .LP
41 Note -
42 .sp
43 .RS 2
44 The actual numeric value of the subnet address or other subnetting
45 information on the system (for example, from the \fBnetmasks\fR(4) file) are
46 not considered by this mechanism.
47 .RE
48 .sp
49 .LP
50 Using the "longest prefix of matching bits" mechanism, an IPv4 address of
51 0.0.0.0 is a wildcard address with a prefix length of 0 and hence matches any
52 IPv4 address. For more information about prefi x lengths in IPv4 and IPv6
53 addresses, see \fISystem Administration Guide: IP Services\fR.
54 .sp
55 .LP
56 The \fBsmtnrhdb\fR command accepts a hostname, IP address, and wildcard address
57 with as optional prefix as valid addresses. See \fIsubcommand_args\fR, below,
58 for the format of valid addresses.
59 .SH SUB-COMMANDS
60 .sp
61 .LP
62 \fBsmtnrhdb\fR \fIsubcommand\fRs are:
63 .sp
64 .ne 2
65 .na
66 \fB\fBadd\fR\fR
67 .ad
68 .sp .6
69 .RS 4n
70 Adds a new entry to the \fBtnrhdb\fR database. To add an entry, the
71 administrator must have the \fBsolaris.network.host.write\fR and
72 \fBsolaris.network.security.write\fR authorizations.
73 .RE
75 .sp
76 .ne 2
77 .na
78 \fB\fBdelete\fR\fR
79 .ad
80 .sp .6
81 .RS 4n
82 Deletes an entry from the \fBtnrhdb\fR database. To delete an entry, the
83 administrator must have the \fBsolaris.network.host.write\fR and
84 \fBsolaris.network.security.write\fR authorizations.
85 .RE
87 .sp
88 .ne 2
89 .na
90 \fB\fBlist\fR\fR
91 .ad
92 .sp .6
93 .RS 4n
94 Lists all entries in the \fBtnrhdb\fR database. To list an entry, the
95 administrator must have the \fBsolaris.network.host.read\fR and
96 \fBsolaris.network.security.read\fR authorizations.
97 .RE
99 .sp
100 .ne 2
101 .na
102 \fB\fBmodify\fR\fR
103 .ad
104 .sp .6
105 .RS 4n
106 Modifies an entry in the \fBtnrhdb\fR database. To modify an entry, the
107 administrator must have the \fBsolaris.network.host.write\fR and
108 \fBsolaris.network.security.write\fR authorizations.
109 .RE
111 .SH OPTIONS
112 .sp
113 .LP
114 The \fBsmtnrhdb\fR authentication arguments, \fIauth_args\fR, are derived from
115 the \fBsmc\fR arg set. These arguments are the same regardless of which
116 subcommand you use.
117 .sp
118 .LP
119 The subcommand-specific options, \fIsubcommand_args\fR, must be preceded by the
120 \fB--\fR option.
121 .SS "\fIauth_args\fR"
122 .sp
123 .LP
124 The valid \fIauth_args\fR are \fB-D\fR, \fB-H\fR, \fB-l\fR, \fB-p\fR, \fB-r\fR,
125 and \fB-u\fR; they are all optional. If no \fIauth_args\fR are specified,
126 certain defaults will be assumed and the user might be prompted for additional
127 information, such as a password for authentication purposes. These letter
128 options can also be specified by their equivalent option words preceded by a
129 double dash. For example, you can use either \fB-D\fR or \fB--domain\fR.
130 .sp
131 .ne 2
132 .na
133 \fB\fB-D\fR | \fB--domain\fR \fIdomain\fR\fR
134 .ad
135 .sp .6
136 .RS 4n
137 Specifies the default domain that you want to manage. The syntax of
138 \fIdomain\fR=\fItype\fR:/\fIhost_name\fR/\fIdomain_name\fR, where \fItype\fR is
139 \fBdns\fR, \fBldap\fR, or \fBfile\fR; \fIhost_name\fR is the name of the
140 server; and \fIdomain_name\fR is the name of the domain you want to manage.
141 .sp
142 If you do not specify this option, the Solaris Management Console assumes the
143 \fBfile\fR default domain on whatever server you choose to manage, meaning that
144 changes are local to the server. Toolboxes can change the domain on a
145 tool-by-tool basis; this option specifies the domain for all other tools.
146 .RE
148 .sp
149 .ne 2
150 .na
151 \fB\fB-H\fR | \fB--hostname\fR \fIhost_name:port\fR\fR
152 .ad
153 .sp .6
154 .RS 4n
155 Specifies the \fIhost_name\fR and \fIport\fR to which you want to connect. If
156 you do not specify a \fIport\fR, the system connects to the default port,
157 \fB898\fR. If you do not specify \fIhost_name:port\fR, the Solaris Management
158 Console connects to the local host on port \fB898\fR.
159 .RE
161 .sp
162 .ne 2
163 .na
164 \fB\fB-l\fR | \fB--rolepassword\fR \fIrole_password\fR\fR
165 .ad
166 .sp .6
167 .RS 4n
168 Specifies the password for the \fIrole_name\fR. If you specify a
169 \fIrole_name\fR but do not specify a \fIrole_password\fR, the system prompts
170 you to supply a \fIrole_password\fR. Passwords specified on the command line
171 can be seen by any user on the system, hence this option is considered
172 insecure.
173 .RE
175 .sp
176 .ne 2
177 .na
178 \fB\fB-p\fR | \fB--password\fR \fIpassword\fR\fR
179 .ad
180 .sp .6
181 .RS 4n
182 Specifies the password for the \fIuser_name\fR. If you do not specify a
183 password, the system prompts you for one. Passwords specified on the command
184 line can be seen by any user on the system, hence this option is considered
185 insecure.
186 .RE
188 .sp
189 .ne 2
190 .na
191 \fB\fB-r\fR | \fB--rolename\fR \fIrole_name\fR\fR
192 .ad
193 .sp .6
194 .RS 4n
195 Specifies a role name for authentication. If you do not specify this option, no
196 role is assumed.
197 .RE
199 .sp
200 .ne 2
201 .na
202 \fB\fB-u\fR | \fB--username\fR \fIuser_name\fR\fR
203 .ad
204 .sp .6
205 .RS 4n
206 Specifies the user name for authentication. If you do not specify this option,
207 the user identity running the console process is assumed.
208 .RE
210 .sp
211 .ne 2
212 .na
213 \fB\fB--\fR\fR
214 .ad
215 .sp .6
216 .RS 4n
217 This option is required and must always follow the preceding options. If you do
218 not enter the preceding options, you must still enter the \fB--\fR option.
219 .RE
221 .SS "\fIsubcommand_args\fR"
222 .sp
223 .LP
224 \fBNote:\fR Descriptions and other arg options that contain white spaces must
225 be enclosed in double quotes.
226 .sp
227 .ne 2
228 .na
229 \fB\fB-h\fR\fR
230 .ad
231 .sp .6
232 .RS 4n
233 Displays the command's usage statement.
234 .RE
236 .sp
237 .ne 2
238 .na
239 \fB\fB-H\fR \fIhostname\fR\fR
240 .ad
241 .sp .6
242 .RS 4n
243 Specifies the name of the host. For the list subcommand, the hostname argument
244 is not specified. This is not required if the ipaddress subcommand argument is
245 specified.
246 .RE
248 .sp
249 .ne 2
250 .na
251 \fB\fB-i\fR \fIipaddress\fR\fR
252 .ad
253 .sp .6
254 .RS 4n
255 Specifies the \fBIP\fR address of the host. This is not required if the
256 hostname subcommand argument is specified. This option is not valid with the
257 \fB-w\fR option.
258 .RE
260 .sp
261 .ne 2
262 .na
263 \fB\fB-n\fR \fItemplatename\fR\fR
264 .ad
265 .sp .6
266 .RS 4n
267 Specifies the name of an existing template.
268 .RE
270 .sp
271 .ne 2
272 .na
273 \fB\fB-p\fR \fIprefixlen\fR\fR
274 .ad
275 .sp .6
276 .RS 4n
277 Specifies the prefix length (in bits) of a wildcard representation of the IP
278 address. The prefix is the left-most portion of the IP address. This option is
279 valid only with the \fB-w\fR option. For example, when the value of \fB-w\fR
280 \fIipaddress-wildcard\fR is 192.168.0.0, a \fIprefixlen\fR value of 24
281 indicates that the wildcard matches all addresses on the 192.168.0 network.
282 With a \fIprefixlen\fR of 32, the wildcard 192.168.0.0 matches all addresses on
283 the 192.168.0.0 network.
284 .RE
286 .sp
287 .ne 2
288 .na
289 \fB\fB-w\fR \fIipaddress-wildcard\fR\fR
290 .ad
291 .sp .6
292 .RS 4n
293 Specifies the IP address of the subnet using a wildcard.
294 .RE
296 .RS +4
297 .TP
298 .ie t \(bu
299 .el o
300 One of the following sets of arguments must be specified for subcommand
301 \fBadd\fR:
302 .sp
303 .in +2
304 .nf
305 \fB-H\fR \fIhostname\fR \fB-n\fR \fItemplatename\fR |
306 \fB-i\fR \fIipaddress\fR \fB-n\fR \fItemplatename\fR |
307 \fB-w\fR \fIipaddress-wildcard\fR \fB-n\fR \fItemplatename\fR [ \fB-p\fR \fIprefixlen\fR ] |
308 \fB-h\fR
309 .fi
310 .in -2
311 .sp
313 .RE
314 .RS +4
315 .TP
316 .ie t \(bu
317 .el o
318 One of the following sets of arguments must be specified for subcommand
319 \fBmodify\fR:
320 .sp
321 .in +2
322 .nf
323 \fB-H\fR \fIhostname\fR \fB-n\fR \fItemplatename\fR |
324 \fB-i\fR \fIipaddress\fR \fB-n\fR \fItemplatename\fR |
325 \fB-w\fR \fIipaddress-wildcard\fR \fB-n\fR \fItemplatename\fR [ \fB-p\fR \fIprefixlen\fR ] |
326 \fB-h\fR
327 .fi
328 .in -2
329 .sp
331 .RE
332 .RS +4
333 .TP
334 .ie t \(bu
335 .el o
336 One of the following sets of arguments must be specified for subcommand
337 \fBdelete\fR:
338 .sp
339 .in +2
340 .nf
341 \fB-H\fR \fIhostname\fR |
342 \fB-i\fR \fIipaddress\fR |
343 \fB-w\fR \fIipaddress-wildcard\fR [ \fB-p\fR \fIprefixlen\fR ] |
344 \fB-h\fR
345 .fi
346 .in -2
347 .sp
349 .RE
350 .RS +4
351 .TP
352 .ie t \(bu
353 .el o
354 The subcommand \fBlist\fR takes the following argument:
355 .sp
356 .in +2
357 .nf
358 \fB-h\fR
359 .fi
360 .in -2
361 .sp
363 .RE
364 .SH EXAMPLES
365 .LP
366 \fBExample 1 \fRSpecifying the Template Name for a Wildcard IP Address
367 .sp
368 .LP
369 The admin role specifies the template name, \fBcipso_lan\fR, for a series of
370 hosts that use the IP address wildcard \fB192.168.113.0\fR on the local file
371 system. Since no authorization arguments were specified, the administrator
372 connects to port 898 of the local host on the local server with the file domain
373 type, which are the defaults. The administrator is prompted for the admin
374 password.
376 .sp
377 .in +2
378 .nf
379 $ \fBusr/sadm/bin/smtnrhdb add -- -w 192.168.113.0 -n cipso_lan\fR
380 .fi
381 .in -2
382 .sp
384 .LP
385 \fBExample 2 \fRDeleting an Entry in the \fBtnrhdb\fR Database
386 .sp
387 .LP
388 The admin role connects to port 898 (which happens to be the default) of the
389 LDAP server and deletes a host entry from the database by specifying its IP
390 address, \fB192.168.113.8\fR. Since the domain was not specified, the file
391 domain type and local server are used by default. The administrator is prompted
392 for the admin password.
394 .sp
395 .in +2
396 .nf
397 # \fB/usr/sadm/bin/smtnrhdb delete \
398 -D ldap:/example.domain -i 192.168.113.8\fR
399 .fi
400 .in -2
401 .sp
403 .LP
404 \fBExample 3 \fRAdding a Subnet to the \fBtnrhdb\fR Database
405 .sp
406 .LP
407 The following command adds all the addresses on the 192.168.55.0 subnet, from
408 192.168.55.1 to 192.168.55.255, to the \fBtnrhdb\fR database:
410 .sp
411 .in +2
412 .nf
413 # \fB/usr/sadm/bin/smtnrhdb add \e
414 -D file:/machine1.ExampleCo.COM/machine1.ExampleCo.COM \e
415 -- -w 192.168.55.0 -n cipso\fR
416 Authenticating as user: \fBroot\fR
417 Type /? for help, pressing <enter> accepts the default denoted by [ ]
418 Please enter a string value for: password \fB::\fR
419 Loading Tool: com.exampleco.admin.hostmgr.cli.smtnrhdb.HostMgrTnrhdbCli
420 from machine1.ExampleCo.COM
421 Login to machine1.ExampleCo.COM as user root was successful.
422 Download of com.exampleco.admin.hostmgr.cli.smtnrhdb.HostMgrTnrhdbCli
423 from machine1.ExampleCo.COM
424 was successful.
425 .fi
426 .in -2
427 .sp
429 .LP
430 \fBExample 4 \fRAdding Subnet 192.168.0 to the \fBtnrhdb\fR Database
431 .sp
432 .LP
433 The following command adds all the addresses on the 192.168.0 subnet, from
434 192.168.0.1 to 192.168.0.255 to the \fBtnrhdb\fR database. The prefix, 24,
435 indicates that the first 24 bits (192.168.0) are fixed. Only the final zero is
436 a wildcard.
438 .sp
439 .in +2
440 .nf
441 # \fB/usr/sadm/bin/smtnrhdb add \e
442 -D file:/machine1.ExampleCo.COM/machine1.ExampleCo.COM \e
443 -- -w 192.168.0.0 -p 24 -n cipso\fR
445 Login to machine1.ExampleCo.COM as user root was successful.
446 Download of com.exampleco.admin.hostmgr.cli.smtnrhdb.HostMgrTnrhdbCli
447 from machine1.ExampleCo.COM was successful.
448 .fi
449 .in -2
450 .sp
452 .SH EXIT STATUS
453 .sp
454 .LP
455 The following exit values are returned:
456 .sp
457 .ne 2
458 .na
459 \fB\fB0\fR\fR
460 .ad
461 .sp .6
462 .RS 4n
463 Successful completion.
464 .RE
466 .sp
467 .ne 2
468 .na
469 \fB\fB1\fR\fR
470 .ad
471 .sp .6
472 .RS 4n
473 Invalid command syntax. A usage message displays.
474 .RE
476 .sp
477 .ne 2
478 .na
479 \fB\fB2\fR\fR
480 .ad
481 .sp .6
482 .RS 4n
483 An error occurred while executing the command. An error message displays.
484 .RE
486 .SH FILES
487 .sp
488 .LP
489 The following files are used by the \fBsmtnrhdb\fR command:
490 .sp
491 .ne 2
492 .na
493 \fB\fB/etc/security/tsol/tnrhdb\fR\fR
494 .ad
495 .sp .6
496 .RS 4n
497 Trusted network remote-host database.
498 .RE
500 .SH ATTRIBUTES
501 .sp
502 .LP
503 See \fBattributes\fR(5) for descriptions of the following attributes:
504 .sp
506 .sp
507 .TS
508 box;
509 c | c
510 l | l .
511 ATTRIBUTE TYPE ATTRIBUTE VALUE
512 _
513 Interface Stability Committed
514 .TE
516 .SH SEE ALSO
517 .sp
518 .LP
519 \fBsmc\fR(1M), \fBnetmasks\fR(4), \fBattributes\fR(5)
520 .sp
521 .LP
522 \fISystem Administration Guide: Security Services\fR
523 .SH NOTES
524 .sp
525 .LP
526 The functionality described on this manual page is available only if the system
527 is configured with Trusted Extensions.