source3/lib/netapi/netapi.h

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *  NetApi Support
   4  *  Copyright (C) Guenther Deschner 2007-2008
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef __LIB_NETAPI_H__
  21 #define __LIB_NETAPI_H__
  22
  23 /****************************************************************
  24  include some basic headers
  25 ****************************************************************/
  26
  27 #include <inttypes.h>
  28
  29 /****************************************************************
  30  NET_API_STATUS
  31 ****************************************************************/
  32
  33 #define NET_API_STATUS uint32_t
  34 #define NET_API_STATUS_SUCCESS 0
  35
  36 /****************************************************************
  37 ****************************************************************/
  38
  39 #define LIBNETAPI_LOCAL_SERVER(x) (!x || is_myname_or_ipaddr(x))
  40
  41 /****************************************************************
  42 ****************************************************************/
  43
  44 struct libnetapi_ctx {
  45         char *debuglevel;
  46         char *error_string;
  47         char *username;
  48         char *workgroup;
  49         char *password;
  50         char *krb5_cc_env;
  51 };
  52
  53 /****************************************************************
  54 ****************************************************************/
  55
  56 NET_API_STATUS libnetapi_init(struct libnetapi_ctx **ctx);
  57 NET_API_STATUS libnetapi_getctx(struct libnetapi_ctx **ctx);
  58 NET_API_STATUS libnetapi_free(struct libnetapi_ctx *ctx);
  59 NET_API_STATUS libnetapi_set_debuglevel(struct libnetapi_ctx *ctx, const char *debuglevel);
  60 NET_API_STATUS libnetapi_get_debuglevel(struct libnetapi_ctx *ctx, char **debuglevel);
  61 NET_API_STATUS libnetapi_set_username(struct libnetapi_ctx *ctx, const char *username);
  62 NET_API_STATUS libnetapi_set_password(struct libnetapi_ctx *ctx, const char *password);
  63 NET_API_STATUS libnetapi_set_workgroup(struct libnetapi_ctx *ctx, const char *workgroup);
  64 const char *libnetapi_errstr(NET_API_STATUS status);
  65 NET_API_STATUS libnetapi_set_error_string(struct libnetapi_ctx *ctx, const char *format, ...);
  66 const char *libnetapi_get_error_string(struct libnetapi_ctx *ctx, NET_API_STATUS status);
  67
  68
  69 /****************************************************************
  70  NetApiBufferFree
  71 ****************************************************************/
  72
  73 NET_API_STATUS NetApiBufferFree(void *buffer);
  74
  75 /****************************************************************
  76  NetJoinDomain
  77 ****************************************************************/
  78
  79 NET_API_STATUS NetJoinDomain(const char *server,
  80                              const char *domain,
  81                              const char *account_ou,
  82                              const char *account,
  83                              const char *password,
  84                              uint32_t join_options);
  85
  86 /****************************************************************
  87  NetUnjoinDomain
  88 ****************************************************************/
  89
  90 NET_API_STATUS NetUnjoinDomain(const char *server_name,
  91                                const char *account,
  92                                const char *password,
  93                                uint32_t unjoin_flags);
  94
  95 /****************************************************************
  96  NetGetJoinInformation
  97 ****************************************************************/
  98
  99 NET_API_STATUS NetGetJoinInformation(const char *server_name,
 100                                      const char **name_buffer,
 101                                      uint16_t *name_type);
 102
 103 /****************************************************************
 104  NetGetJoinableOUs
 105 ****************************************************************/
 106
 107 NET_API_STATUS NetGetJoinableOUs(const char *server_name,
 108                                  const char *domain,
 109                                  const char *account,
 110                                  const char *password,
 111                                  uint32_t *ou_count,
 112                                  const char ***ous);
 113
 114 /****************************************************************
 115  NetServerGetInfo
 116 ****************************************************************/
 117
 118 NET_API_STATUS NetServerGetInfo(const char *server_name,
 119                                 uint32_t level,
 120                                 uint8_t **buffer);
 121
 122 /****************************************************************
 123  NetServerSetInfo
 124 ****************************************************************/
 125
 126 NET_API_STATUS NetServerSetInfo(const char *server_name,
 127                                 uint32_t level,
 128                                 uint8_t *buffer,
 129                                 uint32_t *parm_error);
 130
 131 /****************************************************************
 132  NetGetDCName
 133 ****************************************************************/
 134
 135 NET_API_STATUS NetGetDCName(const char *server_name,
 136                             const char *domain_name,
 137                             uint8_t **buffer);
 138
 139 /****************************************************************
 140  NetGetAnyDCName
 141 ****************************************************************/
 142
 143 NET_API_STATUS NetGetAnyDCName(const char *server_name,
 144                                const char *domain_name,
 145                                uint8_t **buffer);
 146
 147 #endif