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 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 /* 27 * Additional API for Identity Mapping Service 28 */ 29 30 #ifndef _IDMAP_PRIV_H 31 #define _IDMAP_PRIV_H 32 33 #pragma ident "%Z%%M% %I% %E% SMI" 34 35 #include <libscf.h> 36 #include <syslog.h> 37 #include <resolv.h> 38 39 #include "idmap.h" 40 #include "idmap_prot.h" 41 42 #ifdef __cplusplus 43 extern "C" { 44 #endif 45 46 #define IDMAP_MAX_NAME_LEN 512 47 48 #define IDMAP_ERROR(rc) (rc != IDMAP_SUCCESS && rc != IDMAP_NEXT) 49 #define IDMAP_FATAL_ERROR(rc) (rc == IDMAP_ERR_MEMORY ||\ 50 rc == IDMAP_ERR_DB) 51 52 53 /* is_user values */ 54 55 #define IDMAP_YES 1 56 #define IDMAP_NO 0 57 #define IDMAP_UNKNOWN -1 58 59 /* Opaque handle to batch config add/remove operations */ 60 typedef struct idmap_udt_handle idmap_udt_handle_t; 61 62 /* Opaque iterator */ 63 typedef struct idmap_iter idmap_iter_t; 64 65 /* 66 * Update API 67 */ 68 69 /* Create handle for updates */ 70 extern idmap_stat idmap_udt_create(idmap_handle_t *, 71 idmap_udt_handle_t **); 72 73 /* Commit */ 74 extern idmap_stat idmap_udt_commit(idmap_udt_handle_t *); 75 76 /* Get index of the failed batch element */ 77 extern idmap_stat idmap_udt_get_error_index(idmap_udt_handle_t *, int64_t *); 78 79 /* Get the rule which caused the batch to failed */ 80 extern idmap_stat idmap_udt_get_error_rule(idmap_udt_handle_t *, char **, 81 char **, char **, boolean_t *, boolean_t *, boolean_t *, int *); 82 83 /* Get the rule which caused a conflict */ 84 extern idmap_stat idmap_udt_get_conflict_rule(idmap_udt_handle_t *, char **, 85 char **, char **, boolean_t *, boolean_t *, boolean_t *, int *); 86 87 /* Destroy the update handle */ 88 extern void idmap_udt_destroy(idmap_udt_handle_t *); 89 90 /* Add name-based mapping rule */ 91 extern idmap_stat idmap_udt_add_namerule(idmap_udt_handle_t *, const char *, 92 boolean_t, boolean_t, const char *, const char *, boolean_t, int); 93 94 /* Remove name-based mapping rule */ 95 extern idmap_stat idmap_udt_rm_namerule(idmap_udt_handle_t *, boolean_t, 96 boolean_t, const char *, const char *, const char *, int); 97 98 /* Flush name-based mapping rules */ 99 extern idmap_stat idmap_udt_flush_namerules(idmap_udt_handle_t *); 100 101 102 /* 103 * Iterator API 104 */ 105 106 /* Create a iterator to get SID to UID/GID mappings */ 107 extern idmap_stat idmap_iter_mappings(idmap_handle_t *, idmap_iter_t **, 108 int flag); 109 110 /* Iterate through the SID to UID/GID mappings */ 111 extern idmap_stat idmap_iter_next_mapping(idmap_iter_t *, char **, 112 idmap_rid_t *, uid_t *, char **, char **, char **, boolean_t *, 113 boolean_t *, int *, idmap_info *); 114 115 /* Create a iterator to get name-based mapping rules */ 116 extern idmap_stat idmap_iter_namerules(idmap_handle_t *, const char *, 117 boolean_t, boolean_t, const char *, const char *, idmap_iter_t **); 118 119 /* Iterate through the name-based mapping rules */ 120 extern idmap_stat idmap_iter_next_namerule(idmap_iter_t *, char **, 121 char **, char **, boolean_t *, boolean_t *, boolean_t *, int *); 122 123 /* Set the number of entries requested per batch */ 124 extern idmap_stat idmap_iter_set_limit(idmap_iter_t *, uint64_t); 125 126 /* Destroy the iterator */ 127 extern void idmap_iter_destroy(idmap_iter_t *); 128 129 130 /* 131 * Get mapping 132 */ 133 extern idmap_stat idmap_get_w2u_mapping(idmap_handle_t *, const char *, 134 idmap_rid_t *, const char *, const char *, int, int *, int *, 135 uid_t *, char **, int *, idmap_info *); 136 137 extern idmap_stat idmap_get_u2w_mapping(idmap_handle_t *, uid_t *, 138 const char *, int, int, int *, char **, idmap_rid_t *, char **, 139 char **, int *, idmap_info *); 140 141 142 /* 143 * Miscellaneous 144 */ 145 146 /* string to status */ 147 extern idmap_stat idmap_string2stat(const char *); 148 149 /* internal status to protocol status */ 150 extern idmap_stat idmap_stat4prot(idmap_stat); 151 152 /* copy idmap_namerule including strings */ 153 extern idmap_stat idmap_namerule_cpy(idmap_namerule *, idmap_namerule *); 154 155 /* copy idmap_info info including strings */ 156 extern idmap_stat idmap_info_cpy(idmap_info *to, idmap_info *from); 157 158 /* Move idmap_info info including strings */ 159 extern idmap_stat idmap_info_mov(idmap_info *to, idmap_info *from); 160 161 /* free idmap_info info from user supplied struct */ 162 extern void idmap_info_free(idmap_info *); 163 164 165 /* 166 * Extended API to batch SID to UID/GID mapping requests 167 */ 168 169 /* Given SID, get UID */ 170 extern idmap_stat idmap_getext_uidbysid(idmap_get_handle_t *, char *, 171 idmap_rid_t, int, uid_t *, idmap_info *, idmap_stat *); 172 173 /* Given SID, get GID */ 174 extern idmap_stat idmap_getext_gidbysid(idmap_get_handle_t *, char *, 175 idmap_rid_t, int, gid_t *, idmap_info *, idmap_stat *); 176 177 /* Given SID, get UID or GID */ 178 extern idmap_stat idmap_getext_pidbysid(idmap_get_handle_t *, char *, 179 idmap_rid_t, int, uid_t *, int *, idmap_info *, idmap_stat *); 180 181 /* Given UID, get SID */ 182 extern idmap_stat idmap_getext_sidbyuid(idmap_get_handle_t *, uid_t, int, 183 char **, idmap_rid_t *, idmap_info *, idmap_stat *); 184 185 /* Given GID, get SID */ 186 extern idmap_stat idmap_getext_sidbygid(idmap_get_handle_t *, gid_t, int, 187 char **, idmap_rid_t *, idmap_info *, idmap_stat *); 188 189 190 191 /* logging */ 192 extern void idmapdlog(int, const char *, ...); 193 194 /* 195 * The maximal priority to be logged to stderr: set to -1 to suppress 196 * stderr logging completely. 197 */ 198 extern void idmap_log_stderr(int); 199 200 /* write log messages to syslog? */ 201 extern void idmap_log_syslog(bool_t); 202 203 /* write log messages to syslog? */ 204 extern void idmap_log_degraded(bool_t); 205 206 #ifdef __cplusplus 207 } 208 #endif 209 210 #endif /* _IDMAP_PRIV_H */ 211