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

   1 '\" te
   2 .\" Copyright (c) 1998, 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 GSSCRED 1M "Feb 11, 2004"
   7 .SH NAME
   8 gsscred \- add, remove, and list gsscred table entries
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBgsscred\fR [\fB-n\fR \fIuser\fR [\fB-o\fR \fIoid\fR] [\fB-u\fR \fIuid\fR]] [\fB-c\fR \fIcomment\fR] \fB-m\fR \fImech\fR \fB-a\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBgsscred\fR [\fB-n\fR \fIuser\fR [\fB-o\fR \fIoid\fR]] [\fB-u\fR \fIuid\fR] [\fB-m\fR \fImech\fR] \fB-r\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBgsscred\fR [\fB-n\fR \fIuser\fR [\fB-o\fR \fIoid\fR]] [\fB-u\fR \fIuid\fR] [\fB-m\fR \fImech\fR] \fB-l\fR
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBgsscred\fR utility is used to create and maintain a mapping between a
  29 security principal name and a local UNIX \fIuid\fR. The format of the user name
  30 is assumed to be \fBGSS_C_NT_USER_NAME\fR. You can use the \fB-o\fR option to
  31 specify the object identifier of the \fIname\fR type. The \fBOID\fR must be
  32 specified in dot-separated notation, for example: \fB1.2.3.45464.3.1\fR
  33 .sp
  34 .LP
  35 The \fBgsscred\fR table is used on server machines to lookup the \fIuid\fR of
  36 incoming clients connected using \fBRPCSEC_GSS\fR.
  37 .sp
  38 .LP
  39 When adding users, if no \fIuser\fR name is specified, an entry is created in
  40 the table for each user from the \fBpasswd\fR table. If no \fIcomment\fR is
  41 specified, the \fBgsscred\fR utility inserts a comment that specifies the user
  42 name as an \fBASCII\fR string and the \fBGSS-API\fRsecurity mechanism that
  43 applies to it. The security mechanism will be in string representation as
  44 defined in the \fB/etc/gss/mech\fR file.
  45 .sp
  46 .LP
  47 The parameters are interpreted the same way by the \fBgsscred\fR utility to
  48 delete users as they are to create users. At least one of the following options
  49 must be specified: \fB-n\fR, \fB-u\fR, or \fB-m\fR. If no security mechanism is
  50 specified, then all entries will be deleted for the user identified by either
  51 the \fIuid\fR or \fIuser\fR name. If only the security mechanism is specified,
  52 then all \fIuser\fR entries for that security mechanism will be deleted.
  53 .sp
  54 .LP
  55 Again, the parameters are interpreted the same way by the \fBgsscred\fR utility
  56 to search for users as they are to create users. If no options are specified,
  57 then the entire table is returned. If the \fIuser\fR name or \fIuid\fR is
  58 specified, then all entries for that \fIuser\fR are returned. If a security
  59 mechanism is specified, then all \fIuser\fR entries for that security mechanism
  60 are returned.
  61 .SH OPTIONS
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fB-a\fR\fR
  66 .ad
  67 .RS 14n
  68 Add a table entry.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-c\fR \fIcomment\fR\fR
  75 .ad
  76 .RS 14n
  77 Insert comment about this table entry.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-l\fR\fR
  84 .ad
  85 .RS 14n
  86 Search table for entry.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-m\fR \fImech\fR\fR
  93 .ad
  94 .RS 14n
  95 Specify the mechanism for which this name is to be translated.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fB-n\fR \fIuser\fR\fR
 102 .ad
 103 .RS 14n
 104 Specify the optional principal name.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fB-o\fR \fIoid\fR\fR
 111 .ad
 112 .RS 14n
 113 Specify the OID indicating the name type of the user.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-r\fR\fR
 120 .ad
 121 .RS 14n
 122 Remove the entry from the table.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB-u\fR \fIuid\fR\fR
 129 .ad
 130 .RS 14n
 131 Specify the \fIuid\fR for the \fIuser\fR if the \fIuser\fR is not local.
 132 .RE
 133
 134 .SH EXAMPLES
 135 .LP
 136 \fBExample 1 \fRCreating a \fBgsscred\fR Table for the Kerberos v5 Security
 137 Mechanism
 138 .sp
 139 .LP
 140 The following shows how to create a \fBgsscred\fR table for the kerberos v5
 141 security mechanism. \fBgsscred\fR obtains \fIuser\fR names and \fIuid\fR's from
 142 the \fBpasswd\fR table to populate the table.
 143
 144 .sp
 145 .in +2
 146 .nf
 147 example% \fBgsscred -m kerberos_v5 -a\fR
 148 .fi
 149 .in -2
 150 .sp
 151
 152 .LP
 153 \fBExample 2 \fRAdding an Entry for \fBroot/host1\fR for the Kerberos v5
 154 Security Mechanism
 155 .sp
 156 .LP
 157 The following shows how to add an entry for \fBroot/host1\fR with a specified
 158 \fIuid\fR of \fB0\fR for the kerberos v5 security mechanism.
 159
 160 .sp
 161 .in +2
 162 .nf
 163 example% \fBgsscred -m kerberos_v5 -n root/host1 -u 0 -a\fR
 164 .fi
 165 .in -2
 166 .sp
 167
 168 .LP
 169 \fBExample 3 \fRListing All User Mappings for the Kerberos v5 Security
 170 Mechanism
 171 .sp
 172 .LP
 173 The following lists all user mappings for the kerberos v5 security mechanism.
 174
 175 .sp
 176 .in +2
 177 .nf
 178 example% \fBgsscred -m kerberos_v5 -l\fR
 179 .fi
 180 .in -2
 181 .sp
 182
 183 .LP
 184 \fBExample 4 \fRListing All Mappings for All Security Mechanism for a Specified
 185 User
 186 .sp
 187 .LP
 188 The following lists all mappings for all security mechanisms for the user
 189 \fBbsimpson\fR.
 190
 191 .sp
 192 .in +2
 193 .nf
 194 example% \fBgsscred -n bsimpson -l\fR
 195 .fi
 196 .in -2
 197 .sp
 198
 199 .SH EXIT STATUS
 200 .sp
 201 .LP
 202 The following exit values are returned:
 203 .sp
 204 .ne 2
 205 .na
 206 \fB\fB0\fR\fR
 207 .ad
 208 .RS 6n
 209 Successful completion.
 210 .RE
 211
 212 .sp
 213 .ne 2
 214 .na
 215 \fB>\fB0\fR\fR
 216 .ad
 217 .RS 6n
 218 An error occurred.
 219 .RE
 220
 221 .SH ATTRIBUTES
 222 .sp
 223 .LP
 224 See \fBattributes\fR(5) for descriptions of the following attributes:
 225 .sp
 226
 227 .sp
 228 .TS
 229 box;
 230 c | c
 231 l | l .
 232 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 233 _
 234 Interface Stability     Evolving
 235 .TE
 236
 237 .SH SEE ALSO
 238 .sp
 239 .LP
 240 \fBgssd\fR(1m), \fBgsscred.conf\fR(4), \fBattributes\fR(5)
 241 .SH NOTES
 242 .sp
 243 .LP
 244 Some GSS mechanisms, such as \fBkerberos_v5\fR, provide their own
 245 authenticated-name-to-local-name (uid) mapping and thus do not usually have to
 246 be mapped using \fBgsscred\fR. See \fBgsscred.conf\fR(4) for more information.