xref: /illumos-gate/usr/src/head/user_attr.h (revision 9e678d63)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
23  * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright 2020 OmniOS Community Edition (OmniOSce) Association.
25  */
26 
27 #ifndef	_USER_ATTR_H
28 #define	_USER_ATTR_H
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 
35 #include <sys/types.h>
36 #include <secdb.h>
37 
38 
39 struct __FILE;		/* structure tag for type FILE defined in stdio.h */
40 
41 /*
42  * Some macros used internally by the nsswitch code
43  */
44 #define	USERATTR_FILENAME		"/etc/user_attr"
45 #define	USERATTR_DB_NAME		"user_attr.org_dir"
46 #define	USERATTR_DB_NCOL		5	/* total columns */
47 #define	USERATTR_DB_NKEYCOL		2	/* total searchable columns */
48 #define	USERATTR_DB_TBL			"user_attr_tbl"
49 #define	USERATTR_NAME_DEFAULT_KW	"nobody"
50 
51 #define	USERATTR_COL0_KW		"name"
52 #define	USERATTR_COL1_KW		"qualifier"
53 #define	USERATTR_COL2_KW		"res1"
54 #define	USERATTR_COL3_KW		"res2"
55 #define	USERATTR_COL4_KW		"attr"
56 
57 #define	DEF_LIMITPRIV			"PRIV_LIMIT="
58 #define	DEF_DFLTPRIV			"PRIV_DEFAULT="
59 
60 /*
61  * indices of searchable columns
62  */
63 #define	USERATTR_KEYCOL0		0	/* name */
64 #define	USERATTR_KEYCOL1		1	/* qualifier */
65 
66 /*
67  * Key words used in the user_attr database
68  */
69 #define	USERATTR_LOCK_KW		"lock"
70 #define	USERATTR_LOCK_LOCKED_KW		"locked"
71 #define	USERATTR_LOCK_OPEN_KW		"open"
72 #define	USERATTR_LOCK_FIXED_KW		"fixed"
73 #define	USERATTR_GEN_KW			"gen"
74 #define	USERATTR_GEN_AUTOMATIC_KW	"automatic"
75 #define	USERATTR_GEN_MANUAL_KW		"manual"
76 #define	USERATTR_GEN_SYSDEF_KW		"sysdef"
77 #define	USERATTR_PROFILES_KW		"profiles"
78 #define	USERATTR_PROFILES_NONE_KW	"none"
79 #define	USERATTR_ROLES_KW		"roles"
80 #define	USERATTR_ROLES_NONE_KW		"none"
81 #define	USERATTR_DEFAULTPROJ_KW		"project"
82 #define	USERATTR_TYPE_KW		"type"
83 #define	USERATTR_TYPE_NORMAL_KW		"normal"
84 #define	USERATTR_TYPE_ADMIN_KW		"admin"
85 #define	USERATTR_TYPE_NONADMIN_KW	"role"
86 #define	USERATTR_AUTHS_KW		"auths"
87 #define	USERATTR_LIMPRIV_KW		"limitpriv"
88 #define	USERATTR_DFLTPRIV_KW		"defaultpriv"
89 #define	USERATTR_LOCK_AFTER_RETRIES_KW	"lock_after_retries"
90 #define	USERATTR_CLEARANCE		"clearance"
91 #define	USERATTR_LABELVIEW		"labelview"
92 #define	USERATTR_LABELVIEW_EXTERNAL	"external"
93 #define	USERATTR_LABELVIEW_HIDESL	"hidesl"
94 #define	USERATTR_HIDESL			USERATTR_LABELVIEW_HIDESL
95 #define	USERATTR_LABELVIEW_INTERNAL	"internal"
96 #define	USERATTR_LABELVIEW_SHOWSL	"showsl"
97 #define	USERATTR_LABELTRANS		"labeltrans"
98 #define	USERATTR_LOCK_NO		"no"
99 #define	USERATTR_LOCK_YES		"yes"
100 #define	USERATTR_MINLABEL		"min_label"
101 #define	USERATTR_PASSWD			"password"
102 #define	USERATTR_PASSWD_AUTOMATIC	"automatic"
103 #define	USERATTR_PASSWD_MANUAL		"manual"
104 #define	USERATTR_TYPE_ROLE		USERATTR_TYPE_NONADMIN_KW
105 #define	USERATTR_AUDIT_FLAGS_KW		"audit_flags"
106 #define	USERATTR_ROLEAUTH_KW		"roleauth"
107 #define	USERATTR_ROLEAUTH_USER		"user"
108 #define	USERATTR_ROLEAUTH_ROLE		"role"
109 
110 
111 /*
112  * Nsswitch representation of user attributes.
113  */
114 typedef struct userstr_s {
115 	char   *name;		/* user name */
116 	char   *qualifier;	/* reserved for future use */
117 	char   *res1;		/* reserved for future use */
118 	char   *res2;		/* reserved for future use */
119 	char   *attr;		/* string of key-value pair attributes */
120 } userstr_t;
121 
122 /*
123  * API representation of user attributes.
124  */
125 typedef struct userattr_s {
126 	char   *name;		/* user name */
127 	char   *qualifier;	/* reserved for future use */
128 	char   *res1;		/* reserved for future use */
129 	char   *res2;		/* reserved for future use */
130 	kva_t  *attr;		/* array of key-value pair attributes */
131 } userattr_t;
132 
133 extern userattr_t *getusernam(const char *);
134 extern userattr_t *getuseruid(uid_t uid);
135 extern userattr_t *getuserattr(void);
136 extern userattr_t *fgetuserattr(struct __FILE *);
137 extern void setuserattr(void);
138 extern void enduserattr(void);
139 extern void free_userattr(userattr_t *);
140 
141 #ifdef	__cplusplus
142 }
143 #endif
144 
145 #endif	/* _USER_ATTR_H */
146