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