1/* $NetBSD: auth.h,v 1.15 2000/06/02 22:57:55 fvdl Exp $ */
2
3/*
4 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5 * unrestricted use provided that this legend is included on all tape
6 * media and as a part of the software program in whole or part. Users
7 * may copy or modify Sun RPC without charge, but are not authorized
8 * to license or distribute it to anyone else except as part of a product or
9 * program developed by the user.
10 *
11 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
12 * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
13 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
14 *
15 * Sun RPC is provided with no support and without any obligation on the
16 * part of Sun Microsystems, Inc. to assist in its use, correction,
17 * modification or enhancement.
18 *
19 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
20 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
21 * OR ANY PART THEREOF.
22 *
23 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
24 * or profits or other special, indirect and consequential damages, even if
25 * Sun has been advised of the possibility of such damages.
26 *
27 * Sun Microsystems, Inc.
28 * 2550 Garcia Avenue
29 * Mountain View, California 94043
30 *
31 * from: @(#)auth.h 1.17 88/02/08 SMI
32 * from: @(#)auth.h 2.3 88/08/07 4.0 RPCSRC
33 * from: @(#)auth.h 1.43 98/02/02 SMI
|
34 * $FreeBSD: head/include/rpc/auth.h 74472 2001-03-19 19:36:11Z alfred $
|
| 34 * $FreeBSD: head/include/rpc/auth.h 90271 2002-02-05 23:43:43Z alfred $ |
35 */
36
37/*
38 * auth.h, Authentication interface.
39 *
40 * Copyright (C) 1984, Sun Microsystems, Inc.
41 *
42 * The data structures are completely opaque to the client. The client
43 * is required to pass a AUTH * to routines that create rpc
44 * "sessions".
45 */
46
47#ifndef _RPC_AUTH_H
48#define _RPC_AUTH_H
49#include <rpc/xdr.h>
50#include <rpc/clnt_stat.h>
51#include <sys/cdefs.h>
52#include <sys/socket.h>
53
54#define MAX_AUTH_BYTES 400
55#define MAXNETNAMELEN 255 /* maximum length of network user's name */
56
57/*
58 * Client side authentication/security data
59 */
60
61typedef struct sec_data {
62 u_int secmod; /* security mode number e.g. in nfssec.conf */
63 u_int rpcflavor; /* rpc flavors:AUTH_UNIX,AUTH_DES,RPCSEC_GSS */
64 int flags; /* AUTH_F_xxx flags */
65 caddr_t data; /* opaque data per flavor */
66} sec_data_t;
67
68#ifdef _SYSCALL32_IMPL
69struct sec_data32 {
70 uint32_t secmod; /* security mode number e.g. in nfssec.conf */
71 uint32_t rpcflavor; /* rpc flavors:AUTH_UNIX,AUTH_DES,RPCSEC_GSS */
72 int32_t flags; /* AUTH_F_xxx flags */
73 caddr32_t data; /* opaque data per flavor */
74};
75#endif /* _SYSCALL32_IMPL */
76
77/*
78 * AUTH_DES flavor specific data from sec_data opaque data field.
79 * AUTH_KERB has the same structure.
80 */
81typedef struct des_clnt_data {
82 struct netbuf syncaddr; /* time sync addr */
83 struct knetconfig *knconf; /* knetconfig info that associated */
84 /* with the syncaddr. */
85 char *netname; /* server's netname */
86 int netnamelen; /* server's netname len */
87} dh_k4_clntdata_t;
88
89#ifdef _SYSCALL32_IMPL
90struct des_clnt_data32 {
91 struct netbuf32 syncaddr; /* time sync addr */
92 caddr32_t knconf; /* knetconfig info that associated */
93 /* with the syncaddr. */
94 caddr32_t netname; /* server's netname */
95 int32_t netnamelen; /* server's netname len */
96};
97#endif /* _SYSCALL32_IMPL */
98
99#ifdef KERBEROS
100/*
101 * flavor specific data to hold the data for AUTH_DES/AUTH_KERB(v4)
102 * in sec_data->data opaque field.
103 */
104typedef struct krb4_svc_data {
105 int window; /* window option value */
106} krb4_svcdata_t;
107
108typedef struct krb4_svc_data des_svcdata_t;
109#endif /* KERBEROS */
110
111/*
112 * authentication/security specific flags
113 */
114#define AUTH_F_RPCTIMESYNC 0x001 /* use RPC to do time sync */
115#define AUTH_F_TRYNONE 0x002 /* allow fall back to AUTH_NONE */
116
117
118/*
119 * Status returned from authentication check
120 */
121enum auth_stat {
122 AUTH_OK=0,
123 /*
124 * failed at remote end
125 */
126 AUTH_BADCRED=1, /* bogus credentials (seal broken) */
127 AUTH_REJECTEDCRED=2, /* client should begin new session */
128 AUTH_BADVERF=3, /* bogus verifier (seal broken) */
129 AUTH_REJECTEDVERF=4, /* verifier expired or was replayed */
130 AUTH_TOOWEAK=5, /* rejected due to security reasons */
131 /*
132 * failed locally
133 */
134 AUTH_INVALIDRESP=6, /* bogus response verifier */
135 AUTH_FAILED=7 /* some unknown reason */
136#ifdef KERBEROS
137 /*
138 * kerberos errors
139 */
140 ,
141 AUTH_KERB_GENERIC = 8, /* kerberos generic error */
142 AUTH_TIMEEXPIRE = 9, /* time of credential expired */
143 AUTH_TKT_FILE = 10, /* something wrong with ticket file */
144 AUTH_DECODE = 11, /* can't decode authenticator */
145 AUTH_NET_ADDR = 12 /* wrong net address in ticket */
146#endif /* KERBEROS */
147};
148
149union des_block {
150 struct {
151 uint32_t high;
152 uint32_t low;
153 } key;
154 char c[8];
155};
156typedef union des_block des_block;
157__BEGIN_DECLS
158#ifdef __STDC__
159extern bool_t xdr_des_block(XDR *, des_block *);
160#else
161extern bool_t xdr_des_block();
162#endif
163__END_DECLS
164
165/*
166 * Authentication info. Opaque to client.
167 */
168struct opaque_auth {
169 enum_t oa_flavor; /* flavor of auth */
170 caddr_t oa_base; /* address of more auth stuff */
171 u_int oa_length; /* not to exceed MAX_AUTH_BYTES */
172};
173
174
175/*
176 * Auth handle, interface to client side authenticators.
177 */
178typedef struct __auth {
179 struct opaque_auth ah_cred;
180 struct opaque_auth ah_verf;
181 union des_block ah_key;
182 struct auth_ops {
183 void (*ah_nextverf) (struct __auth *);
184 /* nextverf & serialize */
185 int (*ah_marshal) (struct __auth *, XDR *);
186 /* validate verifier */
187 int (*ah_validate) (struct __auth *,
188 struct opaque_auth *);
189 /* refresh credentials */
190 int (*ah_refresh) (struct __auth *, void *);
191 /* destroy this structure */
192 void (*ah_destroy) (struct __auth *);
193 } *ah_ops;
194 void *ah_private;
195} AUTH;
196
197
198/*
199 * Authentication ops.
200 * The ops and the auth handle provide the interface to the authenticators.
201 *
202 * AUTH *auth;
203 * XDR *xdrs;
204 * struct opaque_auth verf;
205 */
206#define AUTH_NEXTVERF(auth) \
207 ((*((auth)->ah_ops->ah_nextverf))(auth))
208#define auth_nextverf(auth) \
209 ((*((auth)->ah_ops->ah_nextverf))(auth))
210
211#define AUTH_MARSHALL(auth, xdrs) \
212 ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
213#define auth_marshall(auth, xdrs) \
214 ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
215
216#define AUTH_VALIDATE(auth, verfp) \
217 ((*((auth)->ah_ops->ah_validate))((auth), verfp))
218#define auth_validate(auth, verfp) \
219 ((*((auth)->ah_ops->ah_validate))((auth), verfp))
220
221#define AUTH_REFRESH(auth, msg) \
222 ((*((auth)->ah_ops->ah_refresh))(auth, msg))
223#define auth_refresh(auth, msg) \
224 ((*((auth)->ah_ops->ah_refresh))(auth, msg))
225
226#define AUTH_DESTROY(auth) \
227 ((*((auth)->ah_ops->ah_destroy))(auth))
228#define auth_destroy(auth) \
229 ((*((auth)->ah_ops->ah_destroy))(auth))
230
231
232__BEGIN_DECLS
233extern struct opaque_auth _null_auth;
234__END_DECLS
235
236/*
237 * These are the various implementations of client side authenticators.
238 */
239
240/*
241 * System style authentication
242 * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
243 * char *machname;
244 * int uid;
245 * int gid;
246 * int len;
247 * int *aup_gids;
248 */
249__BEGIN_DECLS
250extern AUTH *authunix_create(char *, int, int, int,
251 int *);
252extern AUTH *authunix_create_default(void); /* takes no parameters */
253extern AUTH *authnone_create(void); /* takes no parameters */
254__END_DECLS
255/*
256 * DES style authentication
257 * AUTH *authsecdes_create(servername, window, timehost, ckey)
258 * char *servername; - network name of server
259 * u_int window; - time to live
260 * const char *timehost; - optional hostname to sync with
261 * des_block *ckey; - optional conversation key to use
262 */
263__BEGIN_DECLS
264extern AUTH *authdes_create (char *, u_int, struct sockaddr *, des_block *);
265extern AUTH *authdes_seccreate (const char *, const u_int, const char *,
266 const des_block *);
267__END_DECLS
268
269__BEGIN_DECLS
|
270extern bool_t xdr_opaque_auth __P((XDR *, struct opaque_auth *));
|
| 270extern bool_t xdr_opaque_auth (XDR *, struct opaque_auth *); |
271__END_DECLS
272
273#define authsys_create(c,i1,i2,i3,ip) authunix_create((c),(i1),(i2),(i3),(ip))
274#define authsys_create_default() authunix_create_default()
275
276/*
277 * Netname manipulation routines.
278 */
279__BEGIN_DECLS
280extern int getnetname(char *);
281extern int host2netname(char *, const char *, const char *);
282extern int user2netname(char *, const uid_t, const char *);
283extern int netname2user(char *, uid_t *, gid_t *, int *, gid_t *);
284extern int netname2host(char *, char *, const int);
285extern void passwd2des ( char *, char * );
286__END_DECLS
287
288/*
289 *
290 * These routines interface to the keyserv daemon
291 *
292 */
293__BEGIN_DECLS
294extern int key_decryptsession(const char *, des_block *);
295extern int key_encryptsession(const char *, des_block *);
296extern int key_gendes(des_block *);
297extern int key_setsecret(const char *);
298extern int key_secretkey_is_set(void);
299__END_DECLS
300
|
301/*
302 * Publickey routines.
303 */
304__BEGIN_DECLS
305extern int getpublickey (const char *, char *);
306extern int getpublicandprivatekey (char *, char *);
307extern int getsecretkey (char *, char *, char *);
308__END_DECLS
309 |
310#ifdef KERBEROS
311/*
312 * Kerberos style authentication
313 * AUTH *authkerb_seccreate(service, srv_inst, realm, window, timehost, status)
314 * const char *service; - service name
315 * const char *srv_inst; - server instance
316 * const char *realm; - server realm
317 * const u_int window; - time to live
318 * const char *timehost; - optional hostname to sync with
319 * int *status; - kerberos status returned
320 */
321__BEGIN_DECLS
322extern AUTH *authkerb_seccreate(const char *, const char *, const char *,
323 const u_int, const char *, int *);
324__END_DECLS
325
326/*
327 * Map a kerberos credential into a unix cred.
328 *
329 * authkerb_getucred(rqst, uid, gid, grouplen, groups)
330 * const struct svc_req *rqst; - request pointer
331 * uid_t *uid;
332 * gid_t *gid;
333 * short *grouplen;
334 * int *groups;
335 *
336 */
337__BEGIN_DECLS
338extern int authkerb_getucred(/* struct svc_req *, uid_t *, gid_t *,
339 short *, int * */);
340__END_DECLS
341#endif /* KERBEROS */
342
343__BEGIN_DECLS
344struct svc_req;
345struct rpc_msg;
|
337enum auth_stat _svcauth_null __P((struct svc_req *, struct rpc_msg *));
338enum auth_stat _svcauth_short __P((struct svc_req *, struct rpc_msg *));
339enum auth_stat _svcauth_unix __P((struct svc_req *, struct rpc_msg *));
|
346enum auth_stat _svcauth_null (struct svc_req *, struct rpc_msg *);
347enum auth_stat _svcauth_short (struct svc_req *, struct rpc_msg *);
348enum auth_stat _svcauth_unix (struct svc_req *, struct rpc_msg *); |
349__END_DECLS
350
351#define AUTH_NONE 0 /* no authentication */
352#define AUTH_NULL 0 /* backward compatibility */
353#define AUTH_SYS 1 /* unix style (uid, gids) */
354#define AUTH_UNIX AUTH_SYS
355#define AUTH_SHORT 2 /* short hand unix style */
356#define AUTH_DH 3 /* for Diffie-Hellman mechanism */
357#define AUTH_DES AUTH_DH /* for backward compatibility */
358#define AUTH_KERB 4 /* kerberos style */
359
360#endif /* !_RPC_AUTH_H */
|