xref: /freebsd/include/rpc/auth_unix.h (revision 82725ba9bf1fd59746a4006a06f24d4d61d142f2)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2009, Sun Microsystems, Inc.
5  * All rights reserved.
6  *
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.
17  *
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.
29  *
30  *	from: @(#)auth_unix.h 1.8 88/02/08 SMI
31  *	from: @(#)auth_unix.h	2.2 88/07/29 4.0 RPCSRC
32  * $FreeBSD$
33  */
34 
35 /*
36  * auth_unix.h, Protocol for UNIX style authentication parameters for RPC
37  *
38  * Copyright (C) 1984, Sun Microsystems, Inc.
39  */
40 
41 /*
42  * The system is very weak.  The client uses no encryption for  it
43  * credentials and only sends null verifiers.  The server sends backs
44  * null verifiers or optionally a verifier that suggests a new short hand
45  * for the credentials.
46  */
47 
48 #ifndef _RPC_AUTH_UNIX_H
49 #define _RPC_AUTH_UNIX_H
50 #include <sys/cdefs.h>
51 
52 /* The machine name is part of a credential; it may not exceed 255 bytes */
53 #define MAX_MACHINE_NAME 255
54 
55 /* gids compose part of a credential; there may not be more than 16 of them */
56 #define NGRPS 16
57 
58 /*
59  * Unix style credentials.
60  */
61 struct authunix_parms {
62 	u_long	 aup_time;
63 	char	*aup_machname;
64 	u_int	 aup_uid;
65 	u_int	 aup_gid;
66 	u_int	 aup_len;
67 	u_int	*aup_gids;
68 };
69 
70 #define authsys_parms authunix_parms
71 
72 __BEGIN_DECLS
73 extern bool_t xdr_authunix_parms(XDR *, struct authunix_parms *);
74 __END_DECLS
75 
76 /*
77  * If a response verifier has flavor AUTH_SHORT,
78  * then the body of the response verifier encapsulates the following structure;
79  * again it is serialized in the obvious fashion.
80  */
81 struct short_hand_verf {
82 	struct opaque_auth new_cred;
83 };
84 
85 #endif /* !_RPC_AUTH_UNIX_H */
86