1 /* $NetBSD: auth.h,v 1.15 2000/06/02 22:57:55 fvdl Exp $ */
4 * SPDX-License-Identifier: BSD-3-Clause
6 * Copyright (c) 2009, Sun Microsystems, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * - Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 * - Neither the name of Sun Microsystems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
32 * from: @(#)auth.h 1.17 88/02/08 SMI
33 * from: @(#)auth.h 2.3 88/08/07 4.0 RPCSRC
34 * from: @(#)auth.h 1.43 98/02/02 SMI
39 * auth.h, Authentication interface.
41 * Copyright (C) 1984, Sun Microsystems, Inc.
43 * The data structures are completely opaque to the client. The client
44 * is required to pass an AUTH * to routines that create rpc
51 #include <rpc/clnt_stat.h>
52 #include <sys/cdefs.h>
53 #include <sys/socket.h>
55 #define MAX_AUTH_BYTES 400
56 #define MAXNETNAMELEN 255 /* maximum length of network user's name */
59 * Client side authentication/security data
62 typedef struct sec_data {
63 u_int secmod; /* security mode number e.g. in nfssec.conf */
64 u_int rpcflavor; /* rpc flavors:AUTH_UNIX,AUTH_DES,RPCSEC_GSS */
65 int flags; /* AUTH_F_xxx flags */
66 caddr_t data; /* opaque data per flavor */
69 #ifdef _SYSCALL32_IMPL
71 uint32_t secmod; /* security mode number e.g. in nfssec.conf */
72 uint32_t rpcflavor; /* rpc flavors:AUTH_UNIX,AUTH_DES,RPCSEC_GSS */
73 int32_t flags; /* AUTH_F_xxx flags */
74 caddr32_t data; /* opaque data per flavor */
76 #endif /* _SYSCALL32_IMPL */
79 * AUTH_DES flavor specific data from sec_data opaque data field.
80 * AUTH_KERB has the same structure.
82 typedef struct des_clnt_data {
83 struct netbuf syncaddr; /* time sync addr */
84 struct knetconfig *knconf; /* knetconfig info that associated */
85 /* with the syncaddr. */
86 char *netname; /* server's netname */
87 int netnamelen; /* server's netname len */
90 #ifdef _SYSCALL32_IMPL
91 struct des_clnt_data32 {
92 struct netbuf32 syncaddr; /* time sync addr */
93 caddr32_t knconf; /* knetconfig info that associated */
94 /* with the syncaddr. */
95 caddr32_t netname; /* server's netname */
96 int32_t netnamelen; /* server's netname len */
98 #endif /* _SYSCALL32_IMPL */
102 * flavor specific data to hold the data for AUTH_DES/AUTH_KERB(v4)
103 * in sec_data->data opaque field.
105 typedef struct krb4_svc_data {
106 int window; /* window option value */
109 typedef struct krb4_svc_data des_svcdata_t;
110 #endif /* KERBEROS */
113 * authentication/security specific flags
115 #define AUTH_F_RPCTIMESYNC 0x001 /* use RPC to do time sync */
116 #define AUTH_F_TRYNONE 0x002 /* allow fall back to AUTH_NONE */
120 * Status returned from authentication check
125 * failed at remote end
127 AUTH_BADCRED=1, /* bogus credentials (seal broken) */
128 AUTH_REJECTEDCRED=2, /* client should begin new session */
129 AUTH_BADVERF=3, /* bogus verifier (seal broken) */
130 AUTH_REJECTEDVERF=4, /* verifier expired or was replayed */
131 AUTH_TOOWEAK=5, /* rejected due to security reasons */
135 AUTH_INVALIDRESP=6, /* bogus response verifier */
136 AUTH_FAILED=7, /* some unknown reason */
142 AUTH_KERB_GENERIC = 8, /* kerberos generic error */
143 AUTH_TIMEEXPIRE = 9, /* time of credential expired */
144 AUTH_TKT_FILE = 10, /* something wrong with ticket file */
145 AUTH_DECODE = 11, /* can't decode authenticator */
146 AUTH_NET_ADDR = 12, /* wrong net address in ticket */
147 #endif /* KERBEROS */
151 RPCSEC_GSS_CREDPROBLEM = 13,
152 RPCSEC_GSS_CTXPROBLEM = 14,
153 RPCSEC_GSS_NODISPATCH = 0x8000000
163 typedef union des_block des_block;
165 extern bool_t xdr_des_block(XDR *, des_block *);
169 * Authentication info. Opaque to client.
172 enum_t oa_flavor; /* flavor of auth */
173 caddr_t oa_base; /* address of more auth stuff */
174 u_int oa_length; /* not to exceed MAX_AUTH_BYTES */
179 * Auth handle, interface to client side authenticators.
182 typedef struct __auth {
183 struct opaque_auth ah_cred;
184 struct opaque_auth ah_verf;
185 union des_block ah_key;
187 void (*ah_nextverf) (struct __auth *);
188 /* nextverf & serialize */
189 int (*ah_marshal) (struct __auth *, uint32_t, XDR *,
191 /* validate verifier */
192 int (*ah_validate) (struct __auth *, uint32_t,
193 struct opaque_auth *, struct mbuf **);
194 /* refresh credentials */
195 int (*ah_refresh) (struct __auth *, void *);
196 /* destroy this structure */
197 void (*ah_destroy) (struct __auth *);
204 * Authentication ops.
205 * The ops and the auth handle provide the interface to the authenticators.
209 * struct opaque_auth verf;
211 #define AUTH_NEXTVERF(auth) \
212 ((*((auth)->ah_ops->ah_nextverf))(auth))
214 #define AUTH_MARSHALL(auth, xid, xdrs, args) \
215 ((*((auth)->ah_ops->ah_marshal))(auth, xid, xdrs, args))
217 #define AUTH_VALIDATE(auth, xid, verfp, resultsp) \
218 ((*((auth)->ah_ops->ah_validate))((auth), xid, verfp, resultsp))
220 #define AUTH_REFRESH(auth, msg) \
221 ((*((auth)->ah_ops->ah_refresh))(auth, msg))
223 #define AUTH_DESTROY(auth) \
224 ((*((auth)->ah_ops->ah_destroy))(auth))
227 extern struct opaque_auth _null_auth;
231 * These are the various implementations of client side authenticators.
235 * System style authentication
236 * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
246 extern AUTH *authunix_create(struct ucred *);
248 extern AUTH *authunix_create(char *, u_int, u_int, int, u_int *);
249 extern AUTH *authunix_create_default(void); /* takes no parameters */
251 extern AUTH *authnone_create(void); /* takes no parameters */
254 * DES style authentication
255 * AUTH *authsecdes_create(servername, window, timehost, ckey)
256 * char *servername; - network name of server
257 * u_int window; - time to live
258 * const char *timehost; - optional hostname to sync with
259 * des_block *ckey; - optional conversation key to use
262 extern AUTH *authdes_create (char *, u_int, struct sockaddr *, des_block *);
263 extern AUTH *authdes_seccreate (const char *, const u_int, const char *,
268 extern bool_t xdr_opaque_auth (XDR *, struct opaque_auth *);
271 #define authsys_create(c,i1,i2,i3,ip) authunix_create((c),(i1),(i2),(i3),(ip))
272 #define authsys_create_default() authunix_create_default()
275 * Netname manipulation routines.
278 extern int getnetname(char *);
279 extern int host2netname(char *, const char *, const char *);
280 extern int user2netname(char *, const uid_t, const char *);
281 extern int netname2user(char *, uid_t *, gid_t *, int *, gid_t *);
282 extern int netname2host(char *, char *, const int);
283 extern void passwd2des ( char *, char * );
288 * These routines interface to the keyserv daemon
292 extern int key_decryptsession(const char *, des_block *);
293 extern int key_encryptsession(const char *, des_block *);
294 extern int key_gendes(des_block *);
295 extern int key_setsecret(const char *);
296 extern int key_secretkey_is_set(void);
300 * Publickey routines.
303 extern int getpublickey (const char *, char *);
304 extern int getpublicandprivatekey (const char *, char *);
305 extern int getsecretkey (char *, char *, char *);
310 * Kerberos style authentication
311 * AUTH *authkerb_seccreate(service, srv_inst, realm, window, timehost, status)
312 * const char *service; - service name
313 * const char *srv_inst; - server instance
314 * const char *realm; - server realm
315 * const u_int window; - time to live
316 * const char *timehost; - optional hostname to sync with
317 * int *status; - kerberos status returned
320 extern AUTH *authkerb_seccreate(const char *, const char *, const char *,
321 const u_int, const char *, int *);
325 * Map a kerberos credential into a unix cred.
327 * authkerb_getucred(rqst, uid, gid, grouplen, groups)
328 * const struct svc_req *rqst; - request pointer
336 extern int authkerb_getucred(/* struct svc_req *, uid_t *, gid_t *,
339 #endif /* KERBEROS */
344 enum auth_stat _svcauth_null (struct svc_req *, struct rpc_msg *);
345 enum auth_stat _svcauth_short (struct svc_req *, struct rpc_msg *);
346 enum auth_stat _svcauth_unix (struct svc_req *, struct rpc_msg *);
349 #define AUTH_NONE 0 /* no authentication */
350 #define AUTH_NULL 0 /* backward compatibility */
351 #define AUTH_SYS 1 /* unix style (uid, gids) */
352 #define AUTH_UNIX AUTH_SYS
353 #define AUTH_SHORT 2 /* short hand unix style */
354 #define AUTH_DH 3 /* for Diffie-Hellman mechanism */
355 #define AUTH_DES AUTH_DH /* for backward compatibility */
356 #define AUTH_KERB 4 /* kerberos style */
357 #define RPCSEC_GSS 6 /* RPCSEC_GSS */
360 * Pseudo auth flavors for RPCSEC_GSS.
362 #define RPCSEC_GSS_KRB5 390003
363 #define RPCSEC_GSS_KRB5I 390004
364 #define RPCSEC_GSS_KRB5P 390005
366 #endif /* !_RPC_AUTH_H */