usr/src/man/man1m/ldapaddent.1m

   1 '\" te
   2 .\" Copyright (C) 2002, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\" See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LDAPADDENT 1M "May 4, 2009"
   7 .SH NAME
   8 ldapaddent \- create LDAP entries from corresponding /etc files
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBldapaddent\fR [\fB-cpv\fR] [\fB-a\fR \fIauthenticationMethod\fR] [\fB-b\fR \fIbaseDN\fR]
  13      \fB-D\fR \fIbindDN\fR [\fB-w\fR \fIbind_password\fR] [\fB-j\fR \fIpasswdFile\fR] [\fB-f\fR \fIfilename\fR]
  14      \fIdatabase\fR
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBldapaddent\fR [\fB-cpv\fR] \fB-a\fR sasl/GSSAPI [\fB-b\fR \fIbaseDN\fR] [\fB-f\fR \fIfilename\fR]
  20      \fIdatabase\fR
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBldapaddent\fR \fB-d\fR [\fB-v\fR] [\fB-a\fR \fIauthenticationMethod\fR] [\fB-D\fR \fIbindDN\fR]
  26      [\fB-w\fR \fIbind_password\fR] [\fB-j\fR \fIpasswdFile\fR] \fIdatabase\fR
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBldapaddent\fR [\fB-cpv\fR] \fB-h\fR \fILDAP_server\fR[:\fIserverPort\fR] [\fB-M\fR \fIdomainName\fR]
  32      [\fB-N\fR \fIprofileName\fR]  [\fB-P\fR \fIcertifPath\fR] [\fB-a\fR \fIauthenticationMethod\fR]
  33      [\fB-b\fR \fIbaseDN\fR] \fB-D\fR \fIbindDN\fR [\fB-w\fR \fIbind_password\fR] [\fB-f\fR \fIfilename\fR]
  34      [\fB-j\fR \fIpasswdFile\fR] \fIdatabase\fR
  35 .fi
  36
  37 .LP
  38 .nf
  39 \fBldapaddent\fR [\fB-cpv\fR] \fB-h\fR \fILDAP_server\fR[:\fIserverPort\fR] [\fB-M\fR \fIdomainName\fR]
  40      [\fB-N\fR \fIprofileName\fR]  [\fB-P\fR \fIcertifPath\fR] [\fB-a\fR \fIauthenticationMethod\fR]
  41      [\fB-b\fR \fIbaseDN\fR] [\fB-f\fR \fIfilename\fR] \fIdatabase\fR
  42 .fi
  43
  44 .LP
  45 .nf
  46 \fBldapaddent\fR \fB-d\fR [\fB-v\fR] \fB-h\fR \fILDAP_server\fR[:\fIserverPort\fR] [\fB-M\fR \fIdomainName\fR]
  47      [\fB-N\fR \fIprofileName\fR]  [\fB-P\fR \fIcertifPath\fR] [\fB-a\fR \fIauthenticationMethod\fR]
  48      [\fB-b\fR \fIbaseDN\fR] \fB-D\fR \fIbindDN\fR [\fB-w\fR \fIbind_password\fR] [\fB-j\fR \fIpasswdFile\fR]
  49      \fIdatabase\fR
  50 .fi
  51
  52 .SH DESCRIPTION
  53 .sp
  54 .LP
  55 \fBldapaddent\fR creates entries in LDAP containers from their corresponding
  56 \fB/etc\fR files. This operation is customized for each of the standard
  57 containers that are used in the administration of Solaris systems. The
  58 \fIdatabase\fR argument specifies the type of the data being processed. Legal
  59 values for this type are one of \fBaliases\fR, \fBauto_*\fR, \fBbootparams\fR,
  60 \fBethers\fR, \fBgroup\fR, \fBhosts\fR (including both IPv4 and IPv6
  61 addresses), \fBipnodes\fR (alias for \fBhosts\fR), \fBnetgroup\fR,
  62 \fBnetmasks\fR, \fBnetworks\fR, \fBpasswd\fR, \fBshadow\fR, \fBprotocols\fR,
  63 \fBpublickey\fR, \fBrpc\fR, and \fBservices\fR. In addition to the preceding,
  64 the \fIdatabase\fR argument can be one of the RBAC-related files (see
  65 \fBrbac\fR(5)):
  66 .RS +4
  67 .TP
  68 .ie t \(bu
  69 .el o
  70 \fB/etc/user_attr\fR
  71 .RE
  72 .RS +4
  73 .TP
  74 .ie t \(bu
  75 .el o
  76 \fB/etc/security/auth_attr\fR
  77 .RE
  78 .RS +4
  79 .TP
  80 .ie t \(bu
  81 .el o
  82 \fB/etc/security/prof_attr\fR
  83 .RE
  84 .RS +4
  85 .TP
  86 .ie t \(bu
  87 .el o
  88 \fB/etc/security/exec_attr\fR
  89 .RE
  90 .sp
  91 .LP
  92 By default, \fBldapaddent\fR reads from the standard input and adds this data
  93 to the LDAP container associated with the database specified on the command
  94 line. An input file from which data can be read is specified using the \fB-f\fR
  95 option.
  96 .sp
  97 .LP
  98 If you specify the \fB-h\fR option, \fBldapaddent\fR establishes a connection
  99 to the server indicated by the option in order to obtain a \fBDUAProfile\fR
 100 specified by the \fB-N\fR option. The entries will be stored in the directory
 101 described by the configuration obtained.
 102 .sp
 103 .LP
 104 By default (if the \fB-h\fR option is not specified), entries will be stored in
 105 the directory based on the client's configuration. To use the utility in the
 106 default mode, the Solaris LDAP client must be set up in advance.
 107 .sp
 108 .LP
 109 The location where entries are to be written can be overridden by using the
 110 \fB-b\fR option.
 111 .sp
 112 .LP
 113 If the entry to be added exists in the directory, the command displays an error
 114 and exits, unless the \fB-c\fR option is used.
 115 .sp
 116 .LP
 117 Although, there is a \fBshadow\fR database type, there is no corresponding
 118 \fBshadow\fR container. Both the \fBshadow\fR and the \fBpasswd\fR data is
 119 stored in the \fBpeople\fR container itself. Similarly, data from
 120 \fBnetworks\fR and \fBnetmasks\fR databases are stored in the \fBnetworks\fR
 121 container.
 122 .sp
 123 .LP
 124 The \fBuser_attr\fR and \fBaudit_user\fR data is stored by default in the
 125 \fBpeople\fR container. The \fBprof_attr\fR and \fBexec_attr\fR data is stored
 126 by default in the \fBSolarisProfAttr\fR container.
 127 .sp
 128 .LP
 129 You must add entries from the \fBpasswd\fR database before you attempt to add
 130 entries from the \fBshadow\fR database. The addition of a \fBshadow\fR entry
 131 that does not have a corresponding \fBpasswd\fR entry will fail.
 132 .sp
 133 .LP
 134 The \fBpasswd\fR database must precede both the \fBuser_attr\fR and
 135 \fBaudit_user\fR databases.
 136 .sp
 137 .LP
 138 For better performance, the recommended order in which the databases should be
 139 loaded is as follows:
 140 .RS +4
 141 .TP
 142 .ie t \(bu
 143 .el o
 144 \fBpasswd\fR database followed by \fBshadow\fR database
 145 .RE
 146 .RS +4
 147 .TP
 148 .ie t \(bu
 149 .el o
 150 \fBnetworks\fR database followed by \fBnetmasks\fR database
 151 .RE
 152 .RS +4
 153 .TP
 154 .ie t \(bu
 155 .el o
 156 \fBbootparams\fR database followed by \fBethers\fR database
 157 .RE
 158 .sp
 159 .LP
 160 Only the first entry of a given type that is encountered will be added to the
 161 LDAP server. The \fBldapaddent\fR command skips any duplicate entries.
 162 .SH OPTIONS
 163 .sp
 164 .LP
 165 The \fBldapaddent\fR command supports the following options:
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fB-a\fR \fIauthenticationMethod\fR\fR
 170 .ad
 171 .sp .6
 172 .RS 4n
 173 Specify authentication method. The default value is what has been configured in
 174 the profile. The supported authentication methods are:
 175 .RS +4
 176 .TP
 177 .ie t \(bu
 178 .el o
 179 \fBsimple\fR
 180 .RE
 181 .RS +4
 182 .TP
 183 .ie t \(bu
 184 .el o
 185 \fBsasl/CRAM-MD5\fR
 186 .RE
 187 .RS +4
 188 .TP
 189 .ie t \(bu
 190 .el o
 191 \fBsasl/DIGEST-MD5\fR
 192 .RE
 193 .RS +4
 194 .TP
 195 .ie t \(bu
 196 .el o
 197 \fBsasl/GSSAPI\fR
 198 .RE
 199 .RS +4
 200 .TP
 201 .ie t \(bu
 202 .el o
 203 \fBtls:simple\fR
 204 .RE
 205 .RS +4
 206 .TP
 207 .ie t \(bu
 208 .el o
 209 \fBtls:sasl/CRAM-MD5\fR
 210 .RE
 211 .RS +4
 212 .TP
 213 .ie t \(bu
 214 .el o
 215 \fBtls:sasl/DIGEST-MD5\fR
 216 .RE
 217 Selecting \fBsimple\fR causes passwords to be sent over the network in clear
 218 text. Its use is strongly discouraged. Additionally, if the client is
 219 configured with a profile which uses no authentication, that is, either the
 220 \fBcredentialLevel\fR attribute is set to \fBanonymous\fR or
 221 \fBauthenticationMethod\fR is set to \fBnone\fR, the user must use this option
 222 to provide an authentication method. If the authentication method is
 223 \fBsasl/GSSAPI\fR, \fIbindDN\fR and \fIbindPassword\fR is not required and the
 224 \fBhosts\fR and \fBipnodes\fR fields of \fB/etc/nsswitch.conf\fR must be
 225 configured as:
 226 .sp
 227 .in +2
 228 .nf
 229 hosts: dns files
 230 ipnodes: dns files
 231 .fi
 232 .in -2
 233
 234 See \fBnsswitch.conf\fR(4).
 235 .RE
 236
 237 .sp
 238 .ne 2
 239 .na
 240 \fB\fB-b\fR\ \fIbaseDN\fR\fR
 241 .ad
 242 .sp .6
 243 .RS 4n
 244 Create entries in the \fIbaseDN\fR directory. \fIbaseDN\fR is not relative to
 245 the client's default search base, but rather. it is the actual location where
 246 the entries will be created. If this parameter is not specified, the first
 247 search descriptor defined for the service or the default container will be
 248 used.
 249 .RE
 250
 251 .sp
 252 .ne 2
 253 .na
 254 \fB\fB-c\fR\fR
 255 .ad
 256 .sp .6
 257 .RS 4n
 258 Continue adding entries to the directory even after an error. Entries will not
 259 be added if the directory server is not responding or if there is an
 260 authentication problem.
 261 .RE
 262
 263 .sp
 264 .ne 2
 265 .na
 266 \fB\fB-D\fR\ \fIbindDN\fR\fR
 267 .ad
 268 .sp .6
 269 .RS 4n
 270 Create an entry which has write permission to the \fIbaseDN\fR. When used with
 271 \fB-d\fR option, this entry only needs read permission.
 272 .RE
 273
 274 .sp
 275 .ne 2
 276 .na
 277 \fB\fB-d\fR\fR
 278 .ad
 279 .sp .6
 280 .RS 4n
 281 Dump the LDAP container to the standard output in the appropriate format for
 282 the given database.
 283 .RE
 284
 285 .sp
 286 .ne 2
 287 .na
 288 \fB\fB-f\fR \fIfilename\fR\fR
 289 .ad
 290 .sp .6
 291 .RS 4n
 292 Indicates input file to read in an \fB/etc/\fR file format.
 293 .RE
 294
 295 .sp
 296 .ne 2
 297 .na
 298 \fB\fB-h\fR \fILDAP_server\fR[:\fIserverPort\fR]\fR
 299 .ad
 300 .sp .6
 301 .RS 4n
 302 Specify an address (or a name) and an optional port of the LDAP server in which
 303 the entries will be stored. The current naming service specified in the
 304 \fBnsswitch.conf\fR file is used. The default value for the port is \fB389\fR,
 305 except when TLS is specified as the authentication method. In this case, the
 306 default LDAP server port number is \fB636\fR.
 307 .RE
 308
 309 .sp
 310 .ne 2
 311 .na
 312 \fB\fB-j\fR\ \fIpasswdFile\fR\fR
 313 .ad
 314 .sp .6
 315 .RS 4n
 316 Specify a file containing the password for the bind DN or the password for the
 317 SSL client's key database. To protect the password, use this option in scripts
 318 and place the password in a secure file. This option is mutually exclusive of
 319 the \fB-w\fR option.
 320 .RE
 321
 322 .sp
 323 .ne 2
 324 .na
 325 \fB\fB-M\fR\ \fIdomainName\fR\fR
 326 .ad
 327 .sp .6
 328 .RS 4n
 329 The name of a domain served by the specified server. If not specified, the
 330 default domain name will be used.
 331 .RE
 332
 333 .sp
 334 .ne 2
 335 .na
 336 \fB\fB-N\fR\ \fIprofileName\fR\fR
 337 .ad
 338 .sp .6
 339 .RS 4n
 340 Specify the \fBDUAProfile\fR name. A profile with such a name is supposed to
 341 exist on the server specified by \fB-h\fR option. Otherwise, a default
 342 \fBDUAProfile\fR will be used. The default value is \fBdefault\fR.
 343 .RE
 344
 345 .sp
 346 .ne 2
 347 .na
 348 \fB\fB-P\fR\ \fIcertifPath\fR\fR
 349 .ad
 350 .sp .6
 351 .RS 4n
 352 The certificate path for the location of the certificate database. The value is
 353 the path where security database files reside. This is used for TLS support,
 354 which is specified in the \fBauthenticationMethod\fR and
 355 \fBserviceAuthenticationMethod\fR attributes. The default is \fB/var/ldap\fR.
 356 .RE
 357
 358 .sp
 359 .ne 2
 360 .na
 361 \fB\fB-p\fR\fR
 362 .ad
 363 .sp .6
 364 .RS 4n
 365 Process the \fBpassword\fR field when loading password information from a file.
 366 By default, the \fBpassword\fR field is ignored because it is usually not
 367 valid, as the actual password appears in a \fBshadow\fR file.
 368 .RE
 369
 370 .sp
 371 .ne 2
 372 .na
 373 \fB\fB-w\fR\ \fIbindPassword\fR\fR
 374 .ad
 375 .sp .6
 376 .RS 4n
 377 Password to be used for authenticating the \fIbindDN\fR. If this parameter is
 378 missing, the command will prompt for a password. \fBNULL\fR passwords are not
 379 supported in LDAP.
 380 .sp
 381 When you use \fB-w\fR\ \fIbindPassword\fR to specify the password to be used
 382 for authentication, the password is visible to other users of the system by
 383 means of the \fBps\fR command, in script files or in shell history.
 384 .sp
 385 If you supply "\fB-\fR" (hyphen) as a password, you will be prompted to enter a
 386 password.
 387 .RE
 388
 389 .sp
 390 .ne 2
 391 .na
 392 \fB\fB-v\fR\fR
 393 .ad
 394 .sp .6
 395 .RS 4n
 396 Verbose.
 397 .RE
 398
 399 .SH OPERANDS
 400 .sp
 401 .LP
 402 The following operands are supported:
 403 .sp
 404 .ne 2
 405 .na
 406 \fB\fIdatabase\fR\fR
 407 .ad
 408 .sp .6
 409 .RS 4n
 410 The name of the database or service name. Supported values are: \fBaliases\fR,
 411 \fBauto_*\fR, \fBbootparams\fR, \fBethers\fR, \fBgroup\fR, \fBhosts\fR
 412 (including IPv6 addresses), \fBnetgroup\fR, \fBnetmasks\fR, \fBnetworks\fR,
 413 \fBpasswd\fR, \fBshadow\fR, \fBprotocols\fR, \fBpublickey\fR, \fBrpc\fR, and
 414 \fBservices\fR. Also supported are \fBauth_attr\fR, \fBprof_attr\fR,
 415 \fBexec_attr\fR, \fBuser_attr\fR, and \fBprojects\fR.
 416 .RE
 417
 418 .SH EXAMPLES
 419 .LP
 420 \fBExample 1 \fRAdding Password Entries to the Directory Server
 421 .sp
 422 .LP
 423 The following example shows how to add password entries to the directory
 424 server:
 425
 426 .sp
 427 .in +2
 428 .nf
 429 example# \fBldapaddent -D "cn=directory manager" -w secret \e
 430       -f /etc/passwd passwd\fR
 431 .fi
 432 .in -2
 433 .sp
 434
 435 .LP
 436 \fBExample 2 \fRAdding Group Entries
 437 .sp
 438 .LP
 439 The following example shows how to add \fBgroup\fR entries to the directory
 440 server using \fBsasl/CRAM-MD5\fR as the authentication method:
 441
 442 .sp
 443 .in +2
 444 .nf
 445 example# \fBldapaddent -D "cn=directory manager" -w secret \e
 446      -a "sasl/CRAM-MD5" -f /etc/group group\fR
 447 .fi
 448 .in -2
 449 .sp
 450
 451 .LP
 452 \fBExample 3 \fRAdding \fBauto_master\fR Entries
 453 .sp
 454 .LP
 455 The following example shows how to add \fBauto_master\fR entries to the
 456 directory server:
 457
 458 .sp
 459 .in +2
 460 .nf
 461 example# \fBldapaddent -D "cn=directory manager" -w secret \e
 462      -f /etc/auto_master auto_master\fR
 463 .fi
 464 .in -2
 465 .sp
 466
 467 .LP
 468 \fBExample 4 \fRDumping \fBpasswd\fR Entries from the Directory to File
 469 .sp
 470 .LP
 471 The following example shows how to dump \fBpassword\fR entries from the
 472 directory to a file \fBfoo\fR:
 473
 474 .sp
 475 .in +2
 476 .nf
 477 example# \fBldapaddent -d passwd > foo\fR
 478 .fi
 479 .in -2
 480 .sp
 481
 482 .LP
 483 \fBExample 5 \fRAdding Password Entries to a Specific Directory Server
 484 .sp
 485 .LP
 486 The following example shows how to add password entries to a directory server
 487 that you specify:
 488
 489 .sp
 490 .in +2
 491 .nf
 492 example# \fBldapaddent -h 10.10.10.10:3890 \e
 493 -M another.domain.name -N special_duaprofile \e
 494 -D "cn=directory manager" -w secret \e
 495 -f /etc/passwd passwd\fR
 496 .fi
 497 .in -2
 498 .sp
 499
 500 .SH EXIT STATUS
 501 .sp
 502 .LP
 503 The following exit values are returned:
 504 .sp
 505 .ne 2
 506 .na
 507 \fB\fB0\fR\fR
 508 .ad
 509 .sp .6
 510 .RS 4n
 511 Successful completion.
 512 .RE
 513
 514 .sp
 515 .ne 2
 516 .na
 517 \fB>\fB0\fR\fR
 518 .ad
 519 .sp .6
 520 .RS 4n
 521 An error occurred.
 522 .RE
 523
 524 .SH FILES
 525 .sp
 526 .ne 2
 527 .na
 528 \fB\fB/var/ldap/ldap_client_file\fR\fR
 529 .ad
 530 .br
 531 .na
 532 \fB\fB/var/ldap/ldap_client_cred\fR\fR
 533 .ad
 534 .sp .6
 535 .RS 4n
 536 Files containing the LDAP configuration of the client. These files are not to
 537 be modified manually. Their content is not guaranteed to be human readable. Use
 538 \fBldapclient\fR(1M) to update these files.
 539 .RE
 540
 541 .SH ATTRIBUTES
 542 .sp
 543 .LP
 544 See \fBattributes\fR(5) for descriptions of the following attributes:
 545 .sp
 546
 547 .sp
 548 .TS
 549 box;
 550 c | c
 551 l | l .
 552 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 553 _
 554 Interface Stability     Committed
 555 .TE
 556
 557 .SH SEE ALSO
 558 .sp
 559 .LP
 560 \fBldap\fR(1), \fBldaplist\fR(1), \fBldapmodify\fR(1), \fBldapmodrdn\fR(1),
 561 \fBldapsearch\fR(1), \fBidsconfig\fR(1M), \fBldapclient\fR(1M),
 562 \fBsuninstall\fR(1M), \fBnsswitch.conf\fR(4), \fBattributes\fR(5)
 563 .sp
 564 .LP
 565 \fI\fR
 566 .SH CAUTION
 567 .sp
 568 .LP
 569 Currently StartTLS is not supported by \fBlibldap.so.5\fR, therefore the port
 570 number provided refers to the port used during a TLS open, rather than the port
 571 used as part of a StartTLS sequence. For example:
 572 .sp
 573 .in +2
 574 .nf
 575 -h foo:1000 -a tls:simple
 576 .fi
 577 .in -2
 578 .sp
 579
 580 .sp
 581 .LP
 582 The preceding refers to a raw TLS open on host \fBfoo\fR port 1000, not an
 583 open, StartTLS sequence on an unsecured port 1000. If port 1000 is unsecured
 584 the connection will not be made.