nsswitch/libwbclient/wbclient.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Winbind client API
   5
   6    Copyright (C) Gerald (Jerry) Carter 2007
   7
   8
   9    This library is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU Lesser General Public
  11    License as published by the Free Software Foundation; either
  12    version 3 of the License, or (at your option) any later version.
  13
  14    This library is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17    Library General Public License for more details.
  18
  19    You should have received a copy of the GNU Lesser General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 /* Required Headers */
  24
  25 #include "replace.h"
  26 #include "libwbclient.h"
  27
  28 /* From wb_common.c */
  29
  30 NSS_STATUS winbindd_request_response(int req_type,
  31                                      struct winbindd_request *request,
  32                                      struct winbindd_response *response);
  33 NSS_STATUS winbindd_priv_request_response(int req_type,
  34                                           struct winbindd_request *request,
  35                                           struct winbindd_response *response);
  36
  37 /*
  38  result == NSS_STATUS_UNAVAIL: winbind not around
  39  result == NSS_STATUS_NOTFOUND: winbind around, but domain missing
  40
  41  Due to a bad API NSS_STATUS_NOTFOUND is returned both when winbind_off
  42  and when winbind return WINBINDD_ERROR. So the semantics of this
  43  routine depends on winbind_on. Grepping for winbind_off I just
  44  found 3 places where winbind is turned off, and this does not conflict
  45  (as far as I have seen) with the callers of is_trusted_domains.
  46
  47  --Volker
  48 */
  49
  50 static wbcErr wbcRequestResponseInt(
  51         int cmd,
  52         struct winbindd_request *request,
  53         struct winbindd_response *response,
  54         NSS_STATUS (*fn)(int req_type,
  55                          struct winbindd_request *request,
  56                          struct winbindd_response *response))
  57 {
  58         wbcErr wbc_status = WBC_ERR_UNKNOWN_FAILURE;
  59         NSS_STATUS nss_status;
  60
  61         /* for some calls the request and/or response can be NULL */
  62
  63         nss_status = fn(cmd, request, response);
  64
  65         switch (nss_status) {
  66         case NSS_STATUS_SUCCESS:
  67                 wbc_status = WBC_ERR_SUCCESS;
  68                 break;
  69         case NSS_STATUS_UNAVAIL:
  70                 wbc_status = WBC_ERR_WINBIND_NOT_AVAILABLE;
  71                 break;
  72         case NSS_STATUS_NOTFOUND:
  73                 wbc_status = WBC_ERR_DOMAIN_NOT_FOUND;
  74                 break;
  75         default:
  76                 wbc_status = WBC_ERR_NSS_ERROR;
  77                 break;
  78         }
  79
  80         return wbc_status;
  81 }
  82
  83 /**
  84  * @brief Wrapper around Winbind's send/receive API call
  85  *
  86  * @param cmd       Winbind command operation to perform
  87  * @param request   Send structure
  88  * @param response  Receive structure
  89  *
  90  * @return #wbcErr
  91  */
  92 wbcErr wbcRequestResponse(int cmd,
  93                           struct winbindd_request *request,
  94                           struct winbindd_response *response)
  95 {
  96         return wbcRequestResponseInt(cmd, request, response,
  97                                      winbindd_request_response);
  98 }
  99
 100 wbcErr wbcRequestResponsePriv(int cmd,
 101                               struct winbindd_request *request,
 102                               struct winbindd_response *response)
 103 {
 104         return wbcRequestResponseInt(cmd, request, response,
 105                                      winbindd_priv_request_response);
 106 }
 107
 108 /** @brief Translate an error value into a string
 109  *
 110  * @param error
 111  *
 112  * @return a pointer to a static string
 113  **/
 114 const char *wbcErrorString(wbcErr error)
 115 {
 116         switch (error) {
 117         case WBC_ERR_SUCCESS:
 118                 return "WBC_ERR_SUCCESS";
 119         case WBC_ERR_NOT_IMPLEMENTED:
 120                 return "WBC_ERR_NOT_IMPLEMENTED";
 121         case WBC_ERR_UNKNOWN_FAILURE:
 122                 return "WBC_ERR_UNKNOWN_FAILURE";
 123         case WBC_ERR_NO_MEMORY:
 124                 return "WBC_ERR_NO_MEMORY";
 125         case WBC_ERR_INVALID_SID:
 126                 return "WBC_ERR_INVALID_SID";
 127         case WBC_ERR_INVALID_PARAM:
 128                 return "WBC_ERR_INVALID_PARAM";
 129         case WBC_ERR_WINBIND_NOT_AVAILABLE:
 130                 return "WBC_ERR_WINBIND_NOT_AVAILABLE";
 131         case WBC_ERR_DOMAIN_NOT_FOUND:
 132                 return "WBC_ERR_DOMAIN_NOT_FOUND";
 133         case WBC_ERR_INVALID_RESPONSE:
 134                 return "WBC_ERR_INVALID_RESPONSE";
 135         case WBC_ERR_NSS_ERROR:
 136                 return "WBC_ERR_NSS_ERROR";
 137         case WBC_ERR_UNKNOWN_USER:
 138                 return "WBC_ERR_UNKNOWN_USER";
 139         case WBC_ERR_UNKNOWN_GROUP:
 140                 return "WBC_ERR_UNKNOWN_GROUP";
 141         case WBC_ERR_AUTH_ERROR:
 142                 return "WBC_ERR_AUTH_ERROR";
 143         case WBC_ERR_PWD_CHANGE_FAILED:
 144                 return "WBC_ERR_PWD_CHANGE_FAILED";
 145         }
 146
 147         return "unknown wbcErr value";
 148 }
 149
 150 #define WBC_MAGIC (0x7a2b0e1e)
 151
 152 struct wbcMemPrefix {
 153         uint32_t magic;
 154         void (*destructor)(void *ptr);
 155 };
 156
 157 static size_t wbcPrefixLen(void)
 158 {
 159         size_t result = sizeof(struct wbcMemPrefix);
 160         return (result + 15) & ~15;
 161 }
 162
 163 static struct wbcMemPrefix *wbcMemToPrefix(void *ptr)
 164 {
 165         return (struct wbcMemPrefix *)(((char *)ptr) - wbcPrefixLen());
 166 }
 167
 168 void *wbcAllocateMemory(size_t nelem, size_t elsize,
 169                         void (*destructor)(void *ptr))
 170 {
 171         struct wbcMemPrefix *result;
 172
 173         if (nelem >= (2<<24)/elsize) {
 174                 /* basic protection against integer wrap */
 175                 return NULL;
 176         }
 177
 178         result = (struct wbcMemPrefix *)calloc(
 179                 1, nelem*elsize + wbcPrefixLen());
 180         if (result == NULL) {
 181                 return NULL;
 182         }
 183         result->magic = WBC_MAGIC;
 184         result->destructor = destructor;
 185         return ((char *)result) + wbcPrefixLen();
 186 }
 187
 188 /* Free library allocated memory */
 189 void wbcFreeMemory(void *p)
 190 {
 191         struct wbcMemPrefix *wbcMem;
 192
 193         if (p == NULL) {
 194                 return;
 195         }
 196         wbcMem = wbcMemToPrefix(p);
 197         if (wbcMem->magic != WBC_MAGIC) {
 198                 return;
 199         }
 200         if (wbcMem->destructor != NULL) {
 201                 wbcMem->destructor(p);
 202         }
 203         free(wbcMem);
 204         return;
 205 }
 206
 207 char *wbcStrDup(const char *str)
 208 {
 209         char *result;
 210         size_t len;
 211
 212         len = strlen(str);
 213         result = (char *)wbcAllocateMemory(len+1, sizeof(char), NULL);
 214         if (result == NULL) {
 215                 return NULL;
 216         }
 217         memcpy(result, str, len+1);
 218         return result;
 219 }
 220
 221 static void wbcStringArrayDestructor(void *ptr)
 222 {
 223         char **p = (char **)ptr;
 224         while (*p != NULL) {
 225                 free(*p);
 226                 p += 1;
 227         }
 228 }
 229
 230 const char **wbcAllocateStringArray(int num_strings)
 231 {
 232         return (const char **)wbcAllocateMemory(
 233                 num_strings + 1, sizeof(const char *),
 234                 wbcStringArrayDestructor);
 235 }
 236
 237 wbcErr wbcLibraryDetails(struct wbcLibraryDetails **_details)
 238 {
 239         struct wbcLibraryDetails *info;
 240
 241         info = (struct wbcLibraryDetails *)wbcAllocateMemory(
 242                 1, sizeof(struct wbcLibraryDetails), NULL);
 243
 244         if (info == NULL) {
 245                 return WBC_ERR_NO_MEMORY;
 246         }
 247
 248         info->major_version = WBCLIENT_MAJOR_VERSION;
 249         info->minor_version = WBCLIENT_MINOR_VERSION;
 250         info->vendor_version = WBCLIENT_VENDOR_VERSION;
 251
 252         *_details = info;
 253         return WBC_ERR_SUCCESS;
 254 }