xref: /titanic_51/usr/src/lib/libidmap/common/idmap.h (revision 4e9cfc9a015e8ca7d41f7d018c74dc8a692305b3)
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 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*
27  * Header File for Clients of Native Identity Mapping Service
28  */
29 
30 #ifndef _IDMAP_H
31 #define	_IDMAP_H
32 
33 #pragma ident	"%Z%%M%	%I%	%E% SMI"
34 
35 #include <stdlib.h>
36 #include <ctype.h>
37 #include <sys/param.h>
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 #include <sys/idmap.h>
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 /* Status */
47 typedef int32_t	idmap_stat;
48 
49 typedef uint32_t	idmap_rid_t;
50 
51 /* Opaque client handle */
52 typedef struct idmap_handle idmap_handle_t;
53 
54 /* Opaque "get-mapping" handle */
55 typedef struct idmap_get_handle idmap_get_handle_t;
56 
57 
58 /*
59  * Setup API
60  */
61 /* Create/Init handle for userland clients */
62 extern idmap_stat idmap_init(idmap_handle_t **);
63 
64 /* Finalize/close handle */
65 extern idmap_stat idmap_fini(idmap_handle_t *);
66 
67 /* Status code to string */
68 extern const char *idmap_stat2string(idmap_handle_t *, idmap_stat);
69 
70 /* Free memory allocated by the API */
71 extern void idmap_free(void *);
72 
73 
74 /*
75  * API to batch SID to UID/GID mapping requests
76  */
77 /* Create handle */
78 extern idmap_stat idmap_get_create(idmap_handle_t *, idmap_get_handle_t **);
79 
80 /* Given SID, get UID */
81 extern idmap_stat idmap_get_uidbysid(idmap_get_handle_t *, char *,
82 	idmap_rid_t, int, uid_t *, idmap_stat *);
83 
84 /* Given SID, get GID */
85 extern idmap_stat idmap_get_gidbysid(idmap_get_handle_t *, char *,
86 	idmap_rid_t, int, gid_t *, idmap_stat *);
87 
88 /* Given SID, get UID or GID */
89 extern idmap_stat idmap_get_pidbysid(idmap_get_handle_t *, char *,
90 	idmap_rid_t, int, uid_t *, int *, idmap_stat *);
91 
92 /* Given UID, get SID */
93 extern idmap_stat idmap_get_sidbyuid(idmap_get_handle_t *, uid_t, int,
94 	char **, idmap_rid_t *, idmap_stat *);
95 
96 /* Given GID, get SID */
97 extern idmap_stat idmap_get_sidbygid(idmap_get_handle_t *, gid_t, int,
98 	char **, idmap_rid_t *, idmap_stat *);
99 
100 /* Process the batched requests */
101 extern idmap_stat idmap_get_mappings(idmap_get_handle_t *);
102 
103 /* Destroy the handle */
104 extern void idmap_get_destroy(idmap_get_handle_t *);
105 
106 
107 /*
108  * API to get Windows name by UID/GID and vice-versa
109  */
110 /* Given UID, get Windows name */
111 extern idmap_stat idmap_getwinnamebyuid(uid_t, char **, char **);
112 
113 /* Given GID, get Windows name */
114 extern idmap_stat idmap_getwinnamebygid(gid_t, char **, char **);
115 
116 /* Given Windows name, get UID */
117 extern idmap_stat idmap_getuidbywinname(const char *, const char *, uid_t *);
118 
119 /* Given Windows name, get GID */
120 extern idmap_stat idmap_getgidbywinname(const char *, const char *, gid_t *);
121 
122 
123 #ifdef __cplusplus
124 }
125 #endif
126 
127 #endif /* _IDMAP_H */
128