xref: /freebsd/contrib/tcpdump/rpc_msg.h (revision 40a8ac8f62b535d30349faf28cf47106b7041b83)
1 /* @(#) $Header: /tcpdump/master/tcpdump/rpc_msg.h,v 1.2 2005-04-27 21:43:48 guy Exp $ (LBL) */
2 /*
3  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
4  * unrestricted use provided that this legend is included on all tape
5  * media and as a part of the software program in whole or part.  Users
6  * may copy or modify Sun RPC without charge, but are not authorized
7  * to license or distribute it to anyone else except as part of a product or
8  * program developed by the user.
9  *
10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
11  * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
13  *
14  * Sun RPC is provided with no support and without any obligation on the
15  * part of Sun Microsystems, Inc. to assist in its use, correction,
16  * modification or enhancement.
17  *
18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
20  * OR ANY PART THEREOF.
21  *
22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
23  * or profits or other special, indirect and consequential damages, even if
24  * Sun has been advised of the possibility of such damages.
25  *
26  * Sun Microsystems, Inc.
27  * 2550 Garcia Avenue
28  * Mountain View, California  94043
29  *
30  *	from: @(#)rpc_msg.h 1.7 86/07/16 SMI
31  *	from: @(#)rpc_msg.h	2.1 88/07/29 4.0 RPCSRC
32  * $FreeBSD$
33  * FreeBSD: src/include/rpc/rpc_msg.h,v 1.11.2.1 1999/08/29 14:39:07 peter Exp
34  */
35 
36 /*
37  * rpc_msg.h
38  * rpc message definition
39  *
40  * Copyright (C) 1984, Sun Microsystems, Inc.
41  */
42 
43 #define SUNRPC_MSG_VERSION	((u_int32_t) 2)
44 
45 /*
46  * Bottom up definition of an rpc message.
47  * NOTE: call and reply use the same overall stuct but
48  * different parts of unions within it.
49  */
50 
51 enum sunrpc_msg_type {
52 	SUNRPC_CALL=0,
53 	SUNRPC_REPLY=1
54 };
55 
56 enum sunrpc_reply_stat {
57 	SUNRPC_MSG_ACCEPTED=0,
58 	SUNRPC_MSG_DENIED=1
59 };
60 
61 enum sunrpc_accept_stat {
62 	SUNRPC_SUCCESS=0,
63 	SUNRPC_PROG_UNAVAIL=1,
64 	SUNRPC_PROG_MISMATCH=2,
65 	SUNRPC_PROC_UNAVAIL=3,
66 	SUNRPC_GARBAGE_ARGS=4,
67 	SUNRPC_SYSTEM_ERR=5
68 };
69 
70 enum sunrpc_reject_stat {
71 	SUNRPC_RPC_MISMATCH=0,
72 	SUNRPC_AUTH_ERROR=1
73 };
74 
75 /*
76  * Reply part of an rpc exchange
77  */
78 
79 /*
80  * Reply to an rpc request that was rejected by the server.
81  */
82 struct sunrpc_rejected_reply {
83 	u_int32_t		 rj_stat;	/* enum reject_stat */
84 	union {
85 		struct {
86 			u_int32_t low;
87 			u_int32_t high;
88 		} RJ_versions;
89 		u_int32_t RJ_why;  /* enum auth_stat - why authentication did not work */
90 	} ru;
91 #define	rj_vers	ru.RJ_versions
92 #define	rj_why	ru.RJ_why
93 };
94 
95 /*
96  * Body of a reply to an rpc request.
97  */
98 struct sunrpc_reply_body {
99 	u_int32_t	rp_stat;		/* enum reply_stat */
100 	struct sunrpc_rejected_reply rp_reject;	/* if rejected */
101 };
102 
103 /*
104  * Body of an rpc request call.
105  */
106 struct sunrpc_call_body {
107 	u_int32_t cb_rpcvers;	/* must be equal to two */
108 	u_int32_t cb_prog;
109 	u_int32_t cb_vers;
110 	u_int32_t cb_proc;
111 	struct sunrpc_opaque_auth cb_cred;
112 	/* followed by opaque verifier */
113 };
114 
115 /*
116  * The rpc message
117  */
118 struct sunrpc_msg {
119 	u_int32_t		rm_xid;
120 	u_int32_t		rm_direction;	/* enum msg_type */
121 	union {
122 		struct sunrpc_call_body RM_cmb;
123 		struct sunrpc_reply_body RM_rmb;
124 	} ru;
125 #define	rm_call		ru.RM_cmb
126 #define	rm_reply	ru.RM_rmb
127 };
128 #define	acpted_rply	ru.RM_rmb.ru.RP_ar
129 #define	rjcted_rply	ru.RM_rmb.ru.RP_dr
130