1 /* $NetBSD: auth.h,v 1.15 2000/06/02 22:57:55 fvdl Exp $ */
4 * Copyright (c) 2009, Sun Microsystems, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * - Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 * - Neither the name of Sun Microsystems, Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
30 * from: @(#)auth.h 1.17 88/02/08 SMI
31 * from: @(#)auth.h 2.3 88/08/07 4.0 RPCSRC
32 * from: @(#)auth.h 1.43 98/02/02 SMI
33 * $NetBSD: auth.h,v 1.15 2000/06/02 22:57:55 fvdl Exp $
34 * $FreeBSD: src/include/rpc/auth.h,v 1.21 2006/02/28 16:02:26 deischen Exp $
35 * $DragonFly: src/include/rpc/auth.h,v 1.4 2004/02/26 13:58:26 joerg Exp $
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 */
157 typedef union des_block des_block
;
159 bool_t
xdr_des_block(XDR
*, des_block
*);
163 * Authentication info. Opaque to client.
166 enum_t oa_flavor
; /* flavor of auth */
167 caddr_t oa_base
; /* address of more auth stuff */
168 u_int oa_length
; /* not to exceed MAX_AUTH_BYTES */
173 * Auth handle, interface to client side authenticators.
175 typedef struct __auth
{
176 struct opaque_auth ah_cred
;
177 struct opaque_auth ah_verf
;
178 union des_block ah_key
;
180 void (*ah_nextverf
) (struct __auth
*);
181 /* nextverf & serialize */
182 int (*ah_marshal
) (struct __auth
*, XDR
*);
183 /* validate verifier */
184 int (*ah_validate
) (struct __auth
*,
185 struct opaque_auth
*);
186 /* refresh credentials */
187 int (*ah_refresh
) (struct __auth
*, void *);
188 /* destroy this structure */
189 void (*ah_destroy
) (struct __auth
*);
196 * Authentication ops.
197 * The ops and the auth handle provide the interface to the authenticators.
201 * struct opaque_auth verf;
203 #define AUTH_NEXTVERF(auth) \
204 ((*((auth)->ah_ops->ah_nextverf))(auth))
205 #define auth_nextverf(auth) \
206 ((*((auth)->ah_ops->ah_nextverf))(auth))
208 #define AUTH_MARSHALL(auth, xdrs) \
209 ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
210 #define auth_marshall(auth, xdrs) \
211 ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
213 #define AUTH_VALIDATE(auth, verfp) \
214 ((*((auth)->ah_ops->ah_validate))((auth), verfp))
215 #define auth_validate(auth, verfp) \
216 ((*((auth)->ah_ops->ah_validate))((auth), verfp))
218 #define AUTH_REFRESH(auth, msg) \
219 ((*((auth)->ah_ops->ah_refresh))(auth, msg))
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))
225 #define auth_destroy(auth) \
226 ((*((auth)->ah_ops->ah_destroy))(auth))
230 extern struct opaque_auth _null_auth
;
234 * These are the various implementations of client side authenticators.
238 * System style authentication
239 * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
247 AUTH
*authunix_create(char *, int, int, int, int *);
248 AUTH
*authunix_create_default(void);
249 AUTH
*authnone_create(void);
252 * DES style authentication
253 * AUTH *authsecdes_create(servername, window, timehost, ckey)
254 * char *servername; - network name of server
255 * u_int window; - time to live
256 * const char *timehost; - optional hostname to sync with
257 * des_block *ckey; - optional conversation key to use
260 AUTH
*authdes_create(char *, u_int
, struct sockaddr
*, des_block
*);
261 AUTH
*authdes_seccreate(const char *, const u_int
, const char *,
266 bool_t
xdr_opaque_auth(XDR
*, struct opaque_auth
*);
269 #define authsys_create(c,i1,i2,i3,ip) authunix_create((c),(i1),(i2),(i3),(ip))
270 #define authsys_create_default() authunix_create_default()
273 * Netname manipulation routines.
276 int getnetname(char *);
277 int host2netname(char *, const char *, const char *);
278 int user2netname(char *, const uid_t
, const char *);
279 int netname2user(char *, uid_t
*, gid_t
*, int *, gid_t
*);
280 int netname2host(char *, char *, const int);
281 void passwd2des(char *, char *);
286 * These routines interface to the keyserv daemon
290 int key_decryptsession(const char *, des_block
*);
291 int key_encryptsession(const char *, des_block
*);
292 int key_gendes(des_block
*);
293 int key_setsecret(const char *);
294 int key_secretkey_is_set(void);
298 * Publickey routines.
301 int getpublickey(const char *, char *);
302 int getpublicandprivatekey(const char *, char *);
303 int getsecretkey(char *, char *, char *);
308 * Kerberos style authentication
309 * AUTH *authkerb_seccreate(service, srv_inst, realm, window, timehost, status)
310 * const char *service; - service name
311 * const char *srv_inst; - server instance
312 * const char *realm; - server realm
313 * const u_int window; - time to live
314 * const char *timehost; - optional hostname to sync with
315 * int *status; - kerberos status returned
318 AUTH
*authkerb_seccreate(const char *, const char *, const char *,
319 const u_int
, const char *, int *);
323 * Map a kerberos credential into a unix cred.
325 * authkerb_getucred(rqst, uid, gid, grouplen, groups)
326 * const struct svc_req *rqst; - request pointer
334 int authkerb_getucred(/* struct svc_req *, uid_t *, gid_t *,
337 #endif /* KERBEROS */
342 enum auth_stat
_svcauth_null (struct svc_req
*, struct rpc_msg
*);
343 enum auth_stat
_svcauth_short (struct svc_req
*, struct rpc_msg
*);
344 enum auth_stat
_svcauth_unix (struct svc_req
*, struct rpc_msg
*);
347 #define AUTH_NONE 0 /* no authentication */
348 #define AUTH_NULL 0 /* backward compatibility */
349 #define AUTH_SYS 1 /* unix style (uid, gids) */
350 #define AUTH_UNIX AUTH_SYS
351 #define AUTH_SHORT 2 /* short hand unix style */
352 #define AUTH_DH 3 /* for Diffie-Hellman mechanism */
353 #define AUTH_DES AUTH_DH /* for backward compatibility */
354 #define AUTH_KERB 4 /* kerberos style */
356 #endif /* !_RPC_AUTH_H */