/usr/include/sss_nss_idmap.h is in libsss-nss-idmap-dev 1.16.1-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 | /*
SSSD
NSS Responder ID-mapping interface
Authors:
Sumit Bose <sbose@redhat.com>
Copyright (C) 2013 Red Hat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef SSS_NSS_IDMAP_H_
#define SSS_NSS_IDMAP_H_
#include <stdint.h>
#include <sys/types.h>
#include <pwd.h>
#include <grp.h>
/**
* Object types
*/
enum sss_id_type {
SSS_ID_TYPE_NOT_SPECIFIED = 0,
SSS_ID_TYPE_UID,
SSS_ID_TYPE_GID,
SSS_ID_TYPE_BOTH /* used for user or magic private groups */
};
struct sss_nss_kv {
char *key;
char *value;
};
/**
* @brief Find SID by fully qualified name
*
* @param[in] fq_name Fully qualified name of a user or a group
* @param[out] sid String representation of the SID of the requested user
* or group, must be freed by the caller
* @param[out] type Type of the object related to the given name
*
* @return
* - 0 (EOK): success, sid contains the requested SID
* - ENOENT: requested object was not found in the domain extracted from the given name
* - ENETUNREACH: SSSD does not know how to handle the domain extracted from the given name
* - ENOSYS: this call is not supported by the configured provider
* - EINVAL: input cannot be parsed
* - EIO: remote servers cannot be reached
* - EFAULT: any other error
*/
int sss_nss_getsidbyname(const char *fq_name, char **sid,
enum sss_id_type *type);
/**
* @brief Find SID by a POSIX UID or GID
*
* @param[in] id POSIX UID or GID
* @param[out] sid String representation of the SID of the requested user
* or group, must be freed by the caller
* @param[out] type Type of the object related to the given ID
*
* @return
* - see #sss_nss_getsidbyname
*/
int sss_nss_getsidbyid(uint32_t id, char **sid, enum sss_id_type *type);
/**
* @brief Return the fully qualified name for the given SID
*
* @param[in] sid String representation of the SID
* @param[out] fq_name Fully qualified name of a user or a group,
* must be freed by the caller
* @param[out] type Type of the object related to the SID
*
* @return
* - see #sss_nss_getsidbyname
*/
int sss_nss_getnamebysid(const char *sid, char **fq_name,
enum sss_id_type *type);
/**
* @brief Return the POSIX ID for the given SID
*
* @param[in] sid String representation of the SID
* @param[out] id POSIX ID related to the SID
* @param[out] id_type Type of the object related to the SID
*
* @return
* - see #sss_nss_getsidbyname
*/
int sss_nss_getidbysid(const char *sid, uint32_t *id,
enum sss_id_type *id_type);
/**
* @brief Find original data by fully qualified name
*
* @param[in] fq_name Fully qualified name of a user or a group
* @param[out] kv_list A NULL terminate list of key-value pairs where the key
* is the attribute name in the cache of SSSD,
* must be freed by the caller with sss_nss_free_kv()
* @param[out] type Type of the object related to the given name
*
* @return
* - 0 (EOK): success, sid contains the requested SID
* - ENOENT: requested object was not found in the domain extracted from the given name
* - ENETUNREACH: SSSD does not know how to handle the domain extracted from the given name
* - ENOSYS: this call is not supported by the configured provider
* - EINVAL: input cannot be parsed
* - EIO: remote servers cannot be reached
* - EFAULT: any other error
*/
int sss_nss_getorigbyname(const char *fq_name, struct sss_nss_kv **kv_list,
enum sss_id_type *type);
/**
* @brief Return the fully qualified name for the given base64 encoded
* X.509 certificate in DER format
*
* @param[in] cert base64 encoded certificate
* @param[out] fq_name Fully qualified name of a user or a group,
* must be freed by the caller
* @param[out] type Type of the object related to the cert
*
* @return
* - see #sss_nss_getsidbyname
*/
int sss_nss_getnamebycert(const char *cert, char **fq_name,
enum sss_id_type *type);
/**
* @brief Return a list of fully qualified names for the given base64 encoded
* X.509 certificate in DER format
*
* @param[in] cert base64 encoded certificate
* @param[out] fq_name List of fully qualified name of users or groups,
* must be freed by the caller
* @param[out] type List of types of the objects related to the cert
*
* @return
* - see #sss_nss_getsidbyname
*/
int sss_nss_getlistbycert(const char *cert, char ***fq_name,
enum sss_id_type **type);
/**
* @brief Free key-value list returned by sss_nss_getorigbyname()
*
* @param[in] kv_list Key-value list returned by sss_nss_getorigbyname().
*/
void sss_nss_free_kv(struct sss_nss_kv *kv_list);
/**
* Flags to control the behavior and the results for sss_*_ex() calls
*/
#define SSS_NSS_EX_FLAG_NO_FLAGS 0
/** Always request data from the server side, client must be privileged to do
* so, see nss_trusted_users option in man sssd.conf for details.
* This flag cannot be used together with SSS_NSS_EX_FLAG_INVALIDATE_CACHE */
#define SSS_NSS_EX_FLAG_NO_CACHE (1 << 0)
/** Invalidate the data in the caches, client must be privileged to do
* so, see nss_trusted_users option in man sssd.conf for details.
* This flag cannot be used together with SSS_NSS_EX_FLAG_NO_CACHE */
#define SSS_NSS_EX_FLAG_INVALIDATE_CACHE (1 << 1)
#ifdef IPA_389DS_PLUGIN_HELPER_CALLS
/**
* @brief Return user information based on the user name
*
* @param[in] name same as for getpwnam_r(3)
* @param[in] pwd same as for getpwnam_r(3)
* @param[in] buffer same as for getpwnam_r(3)
* @param[in] buflen same as for getpwnam_r(3)
* @param[out] result same as for getpwnam_r(3)
* @param[in] flags flags to control the behavior and the results of the
* call
* @param[in] timeout timeout in milliseconds
*
* @return
* - 0:
* - ENOENT: no user with the given name found
* - ERANGE: Insufficient buffer space supplied
* - ETIME: request timed out but was send to SSSD
* - ETIMEDOUT: request timed out but was not send to SSSD
*/
int sss_nss_getpwnam_timeout(const char *name, struct passwd *pwd,
char *buffer, size_t buflen,
struct passwd **result,
uint32_t flags, unsigned int timeout);
/**
* @brief Return user information based on the user uid
*
* @param[in] uid same as for getpwuid_r(3)
* @param[in] pwd same as for getpwuid_r(3)
* @param[in] buffer same as for getpwuid_r(3)
* @param[in] buflen same as for getpwuid_r(3)
* @param[out] result same as for getpwuid_r(3)
* @param[in] flags flags to control the behavior and the results of the
* call
* @param[in] timeout timeout in milliseconds
*
* @return
* - 0:
* - ENOENT: no user with the given uid found
* - ERANGE: Insufficient buffer space supplied
* - ETIME: request timed out but was send to SSSD
* - ETIMEDOUT: request timed out but was not send to SSSD
*/
int sss_nss_getpwuid_timeout(uid_t uid, struct passwd *pwd,
char *buffer, size_t buflen,
struct passwd **result,
uint32_t flags, unsigned int timeout);
/**
* @brief Return group information based on the group name
*
* @param[in] name same as for getgrnam_r(3)
* @param[in] pwd same as for getgrnam_r(3)
* @param[in] buffer same as for getgrnam_r(3)
* @param[in] buflen same as for getgrnam_r(3)
* @param[out] result same as for getgrnam_r(3)
* @param[in] flags flags to control the behavior and the results of the
* call
* @param[in] timeout timeout in milliseconds
*
* @return
* - 0:
* - ENOENT: no group with the given name found
* - ERANGE: Insufficient buffer space supplied
* - ETIME: request timed out but was send to SSSD
* - ETIMEDOUT: request timed out but was not send to SSSD
*/
int sss_nss_getgrnam_timeout(const char *name, struct group *grp,
char *buffer, size_t buflen, struct group **result,
uint32_t flags, unsigned int timeout);
/**
* @brief Return group information based on the group gid
*
* @param[in] gid same as for getgrgid_r(3)
* @param[in] pwd same as for getgrgid_r(3)
* @param[in] buffer same as for getgrgid_r(3)
* @param[in] buflen same as for getgrgid_r(3)
* @param[out] result same as for getgrgid_r(3)
* @param[in] flags flags to control the behavior and the results of the
* call
* @param[in] timeout timeout in milliseconds
*
* @return
* - 0:
* - ENOENT: no group with the given gid found
* - ERANGE: Insufficient buffer space supplied
* - ETIME: request timed out but was send to SSSD
* - ETIMEDOUT: request timed out but was not send to SSSD
*/
int sss_nss_getgrgid_timeout(gid_t gid, struct group *grp,
char *buffer, size_t buflen, struct group **result,
uint32_t flags, unsigned int timeout);
/**
* @brief Return a list of groups to which a user belongs
*
* @param[in] name name of the user
* @param[in] group same as second argument of getgrouplist(3)
* @param[in] groups array of gid_t of size ngroups, will be filled
* with GIDs of groups the user belongs to
* @param[in,out] ngroups size of the groups array on input. On output it
* will contain the actual number of groups the
* user belongs to. With a return value of 0 the
* groups array was large enough to hold all group.
* With a return valu of ERANGE the array was not
* large enough and ngroups will have the needed
* size.
* @param[in] flags flags to control the behavior and the results of
* the call
* @param[in] timeout timeout in milliseconds
*
* @return
* - 0: success
* - ENOENT: no user with the given name found
* - ERANGE: Insufficient buffer space supplied
* - ETIME: request timed out but was send to SSSD
* - ETIMEDOUT: request timed out but was not send to SSSD
*/
int sss_nss_getgrouplist_timeout(const char *name, gid_t group,
gid_t *groups, int *ngroups,
uint32_t flags, unsigned int timeout);
/**
* @brief Find SID by fully qualified name with timeout
*
* @param[in] fq_name Fully qualified name of a user or a group
* @param[in] timeout timeout in milliseconds
* @param[out] sid String representation of the SID of the requested user
* or group, must be freed by the caller
* @param[out] type Type of the object related to the given name
*
* @return
* - 0 (EOK): success, sid contains the requested SID
* - ENOENT: requested object was not found in the domain extracted from the given name
* - ENETUNREACH: SSSD does not know how to handle the domain extracted from the given name
* - ENOSYS: this call is not supported by the configured provider
* - EINVAL: input cannot be parsed
* - EIO: remote servers cannot be reached
* - EFAULT: any other error
* - ETIME: request timed out but was send to SSSD
* - ETIMEDOUT: request timed out but was not send to SSSD
*/
int sss_nss_getsidbyname_timeout(const char *fq_name, unsigned int timeout,
char **sid, enum sss_id_type *type);
/**
* @brief Find SID by a POSIX UID or GID with timeout
*
* @param[in] id POSIX UID or GID
* @param[in] timeout timeout in milliseconds
* @param[out] sid String representation of the SID of the requested user
* or group, must be freed by the caller
* @param[out] type Type of the object related to the given ID
*
* @return
* - see #sss_nss_getsidbyname_timeout
*/
int sss_nss_getsidbyid_timeout(uint32_t id, unsigned int timeout,
char **sid, enum sss_id_type *type);
/**
* @brief Return the fully qualified name for the given SID with timeout
*
* @param[in] sid String representation of the SID
* @param[in] timeout timeout in milliseconds
* @param[out] fq_name Fully qualified name of a user or a group,
* must be freed by the caller
* @param[out] type Type of the object related to the SID
*
* @return
* - see #sss_nss_getsidbyname_timeout
*/
int sss_nss_getnamebysid_timeout(const char *sid, unsigned int timeout,
char **fq_name, enum sss_id_type *type);
/**
* @brief Return the POSIX ID for the given SID with timeout
*
* @param[in] sid String representation of the SID
* @param[in] timeout timeout in milliseconds
* @param[out] id POSIX ID related to the SID
* @param[out] id_type Type of the object related to the SID
*
* @return
* - see #sss_nss_getsidbyname_timeout
*/
int sss_nss_getidbysid_timeout(const char *sid, unsigned int timeout,
uint32_t *id, enum sss_id_type *id_type);
/**
* @brief Find original data by fully qualified name with timeout
*
* @param[in] fq_name Fully qualified name of a user or a group
* @param[in] timeout timeout in milliseconds
* @param[out] kv_list A NULL terminate list of key-value pairs where the key
* is the attribute name in the cache of SSSD,
* must be freed by the caller with sss_nss_free_kv()
* @param[out] type Type of the object related to the given name
*
* @return
* - 0 (EOK): success, sid contains the requested SID
* - ENOENT: requested object was not found in the domain extracted from the given name
* - ENETUNREACH: SSSD does not know how to handle the domain extracted from the given name
* - ENOSYS: this call is not supported by the configured provider
* - EINVAL: input cannot be parsed
* - EIO: remote servers cannot be reached
* - EFAULT: any other error
* - ETIME: request timed out but was send to SSSD
* - ETIMEDOUT: request timed out but was not send to SSSD
*/
int sss_nss_getorigbyname_timeout(const char *fq_name, unsigned int timeout,
struct sss_nss_kv **kv_list,
enum sss_id_type *type);
/**
* @brief Return the fully qualified name for the given base64 encoded
* X.509 certificate in DER format with timeout
*
* @param[in] cert base64 encoded certificate
* @param[in] timeout timeout in milliseconds
* @param[out] fq_name Fully qualified name of a user or a group,
* must be freed by the caller
* @param[out] type Type of the object related to the cert
*
* @return
* - see #sss_nss_getsidbyname_timeout
*/
int sss_nss_getnamebycert_timeout(const char *cert, unsigned int timeout,
char **fq_name, enum sss_id_type *type);
/**
* @brief Return a list of fully qualified names for the given base64 encoded
* X.509 certificate in DER format with timeout
*
* @param[in] cert base64 encoded certificate
* @param[in] timeout timeout in milliseconds
* @param[out] fq_name List of fully qualified name of users or groups,
* must be freed by the caller
* @param[out] type List of types of the objects related to the cert
*
* @return
* - see #sss_nss_getsidbyname_timeout
*/
int sss_nss_getlistbycert_timeout(const char *cert, unsigned int timeout,
char ***fq_name, enum sss_id_type **type);
#endif /* IPA_389DS_PLUGIN_HELPER_CALLS */
#endif /* SSS_NSS_IDMAP_H_ */
|