usr/src/lib/nsswitch/ldap/common/ldap_common.h

   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) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
  23  */
  24
  25 #ifndef _LDAP_COMMON_H
  26 #define _LDAP_COMMON_H
  27
  28 #ifdef  __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 #include <ctype.h>
  33 #include <nss_dbdefs.h>
  34 #include <stdlib.h>
  35 #include <string.h>
  36 #include <strings.h>
  37 #include <signal.h>
  38 #include <lber.h>
  39 #include <ldap.h>
  40 #include <pwd.h>
  41 #include "ns_sldap.h"
  42
  43 #define _ALIASES                "aliases"
  44 #define _AUTOMOUNT              "automount"
  45 #define _AUTHATTR               "auth_attr"
  46 #define _AUUSER                 "audit_user"
  47 #define _BOOTPARAMS             "bootparams"
  48 #define _DEFAULT                "default"
  49 #define _ETHERS                 "ethers"
  50 #define _EXECATTR               "exec_attr"
  51 #define _GROUP                  "group"
  52 #define _PROJECT                "project"
  53 #define _HOSTS                  "hosts"
  54 #define _HOSTS6                 "hosts"
  55 #define _NETGROUP               "netgroup"
  56 #define _NETMASKS               "netmasks"
  57 #define _NETWORKS               "networks"
  58 #define _PASSWD                 "passwd"
  59 #define _PRINTERS               "printers"
  60 #define _PROFATTR               "prof_attr"
  61 #define _PROTOCOLS              "protocols"
  62 #define _PUBLICKEY              "publickey"
  63 #define _RPC                    "rpc"
  64 #define _SERVICES               "services"
  65 #define _SHADOW                 "shadow"
  66 #define _USERATTR               "user_attr"
  67
  68 #define NSS_STR_PARSE_NO_ADDR   (NSS_STR_PARSE_ERANGE + 100)
  69 #define NSS_STR_PARSE_NO_RESULT (NSS_STR_PARSE_ERANGE + 101)
  70
  71 #define DOTTEDSUBDOMAIN(string) \
  72         ((string != NULL) && (strchr(string, '.') != NULL))
  73 #define SEARCHFILTERLEN         256
  74
  75 #define _NO_VALUE               ""
  76
  77 #define TEST_AND_ADJUST(len, buffer, buflen, label) \
  78             /* Use '>=' to ensure there is at least one byte left for '\0' */ \
  79             if (len >= buflen || len < 0) { \
  80                 nss_result = NSS_STR_PARSE_ERANGE; \
  81                 goto label; \
  82             } \
  83             /* Adjust pointer and available buffer length */ \
  84             buffer += len; \
  85             buflen -= len;
  86
  87 /*
  88  * We need to use UID_NOBODY and GID_NOBODY as strings. Therefore we use
  89  * snprintf to convert [U|G]ID_NOBODY into a string. The target buffer
  90  * size was chosen as 21 to allow the largest 64-bit number to be stored
  91  * as string in it. Right now uid_t and gid_t are 32-bit so we don't
  92  * really need 21 characters but it does allow for future expansion
  93  * without having to modify this code.
  94  */
  95 #define NOBODY_STR_LEN  21
  96
  97
  98 /*
  99  * Superset the nss_backend_t abstract data type. This ADT has
 100  * been extended to include ldap associated data structures.
 101  */
 102
 103 typedef struct ldap_backend *ldap_backend_ptr;
 104 typedef nss_status_t (*ldap_backend_op_t)(ldap_backend_ptr, void *);
 105 typedef int (*fnf)(ldap_backend_ptr be, nss_XbyY_args_t *argp);
 106
 107 typedef enum {
 108         NSS_LDAP_DB_NONE        = 0,
 109         NSS_LDAP_DB_PUBLICKEY   = 1,
 110         NSS_LDAP_DB_ETHERS      = 2
 111 } nss_ldap_db_type_t;
 112
 113 struct ldap_backend {
 114         ldap_backend_op_t       *ops;
 115         nss_dbop_t              nops;
 116         char                    *tablename;
 117         void                    *enumcookie;
 118         char                    *filter;
 119         char                    *sortattr;
 120         int                     setcalled;
 121         const char              **attrs;
 122         ns_ldap_result_t        *result;
 123         fnf                     ldapobj2str;
 124         void                    *netgroup_cookie;
 125         void                    *services_cookie;
 126         char                    *toglue;
 127         char                    *buffer;
 128         int                     buflen;
 129         nss_ldap_db_type_t      db_type;
 130 };
 131
 132 extern nss_status_t     _nss_ldap_destr(ldap_backend_ptr be, void *a);
 133 extern nss_status_t     _nss_ldap_endent(ldap_backend_ptr be, void *a);
 134 extern nss_status_t     _nss_ldap_setent(ldap_backend_ptr be, void *a);
 135 extern nss_status_t     _nss_ldap_getent(ldap_backend_ptr be, void *a);
 136 nss_backend_t           *_nss_ldap_constr(ldap_backend_op_t ops[], int nops,
 137                         char *tablename, const char **attrs, fnf ldapobj2str);
 138 extern nss_status_t     _nss_ldap_nocb_lookup(ldap_backend_ptr be,
 139                         nss_XbyY_args_t *argp, char *database,
 140                         char *searchfilter, char *domain,
 141                         int (*init_filter_cb)(
 142                                 const ns_ldap_search_desc_t *desc,
 143                                 char **realfilter, const void *userdata),
 144                         const void *userdata);
 145 extern nss_status_t     _nss_ldap_lookup(ldap_backend_ptr be,
 146                         nss_XbyY_args_t *argp, char *database,
 147                         char *searchfilter, char *domain,
 148                         int (*init_filter_cb)(
 149                                 const ns_ldap_search_desc_t *desc,
 150                                 char **realfilter, const void *userdata),
 151                         const void *userdata);
 152 extern void             _clean_ldap_backend(ldap_backend_ptr be);
 153
 154 extern ns_ldap_attr_t *getattr(ns_ldap_result_t *result, int i);
 155 extern const char *_strip_quotes(char *ipaddress);
 156 extern int __nss2herrno(nss_status_t nsstat);
 157 extern int propersubdomain(char *domain, char *subdomain);
 158 extern int chophostdomain(char *string, char *host, char *domain);
 159 extern char *_get_domain_name(char *cdn);
 160 extern int _merge_SSD_filter(const ns_ldap_search_desc_t *desc,
 161         char **realfilter, const void *userdata);
 162 extern int _ldap_filter_name(char *filter_name, const char *name,
 163         int filter_name_size);
 164
 165 extern void _nss_services_cookie_free(void **cookieP);
 166 extern nss_status_t switch_err(int rc, ns_ldap_error_t *error);
 167
 168 #ifdef DEBUG
 169 extern int printresult(ns_ldap_result_t *result);
 170 #endif /* DEBUG */
 171
 172 #ifdef  __cplusplus
 173 }
 174 #endif
 175
 176 #endif  /* _LDAP_COMMON_H */