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 (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. 23 */ 24 25 /* 26 * Header File for Clients of Native Identity Mapping Service 27 */ 28 29 #ifndef _IDMAP_H 30 #define _IDMAP_H 31 32 33 #include <stdlib.h> 34 #include <ctype.h> 35 #include <sys/param.h> 36 #include <sys/types.h> 37 #include <sys/stat.h> 38 #include <sys/idmap.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* Status */ 45 typedef int32_t idmap_stat; 46 47 typedef uint32_t idmap_rid_t; 48 49 /* Opaque client handle */ 50 typedef struct idmap_handle idmap_handle_t; 51 52 /* Opaque "get-mapping" handle */ 53 typedef struct idmap_get_handle idmap_get_handle_t; 54 55 /* Logger prototype which is based on syslog */ 56 typedef void (*idmap_logger_t)(int, const char *, ...); 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 * Supported flag values for mapping requests. 76 * These flag values are applicable to the batch API and the 77 * Windows Name API below. 78 */ 79 /* Use the libidmap cache */ 80 #define IDMAP_REQ_FLG_USE_CACHE 0x00000010 81 82 /* 83 * API to batch SID to UID/GID mapping requests 84 */ 85 /* Create handle */ 86 extern idmap_stat idmap_get_create(idmap_handle_t *, idmap_get_handle_t **); 87 88 /* Given SID, get UID */ 89 extern idmap_stat idmap_get_uidbysid(idmap_get_handle_t *, char *, 90 idmap_rid_t, int, uid_t *, idmap_stat *); 91 92 /* Given SID, get GID */ 93 extern idmap_stat idmap_get_gidbysid(idmap_get_handle_t *, char *, 94 idmap_rid_t, int, gid_t *, idmap_stat *); 95 96 /* Given SID, get UID or GID */ 97 extern idmap_stat idmap_get_pidbysid(idmap_get_handle_t *, char *, 98 idmap_rid_t, int, uid_t *, int *, idmap_stat *); 99 100 /* Given UID, get SID */ 101 extern idmap_stat idmap_get_sidbyuid(idmap_get_handle_t *, uid_t, int, 102 char **, idmap_rid_t *, idmap_stat *); 103 104 /* Given GID, get SID */ 105 extern idmap_stat idmap_get_sidbygid(idmap_get_handle_t *, gid_t, int, 106 char **, idmap_rid_t *, idmap_stat *); 107 108 /* Process the batched requests */ 109 extern idmap_stat idmap_get_mappings(idmap_get_handle_t *); 110 111 /* Destroy the handle */ 112 extern void idmap_get_destroy(idmap_get_handle_t *); 113 114 115 /* 116 * API to get Windows name by UID/GID and vice-versa 117 */ 118 /* Given UID, get Windows name */ 119 extern idmap_stat idmap_getwinnamebyuid(uid_t, int, char **, char **); 120 121 /* Given GID, get Windows name */ 122 extern idmap_stat idmap_getwinnamebygid(gid_t, int, char **, char **); 123 124 /* Given Windows name, get UID */ 125 extern idmap_stat idmap_getuidbywinname(const char *, const char *, 126 int, uid_t *); 127 128 /* Given Windows name, get GID */ 129 extern idmap_stat idmap_getgidbywinname(const char *, const char *, 130 int, gid_t *); 131 132 133 /* Logger */ 134 extern void idmap_set_logger(idmap_logger_t funct); 135 136 #ifdef __cplusplus 137 } 138 #endif 139 140 #endif /* _IDMAP_H */ 141