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