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  NET_API_STATUS
  25 ****************************************************************/
  26 typedef enum {
  27         NET_API_STATUS_SUCCESS = 0
  28 } NET_API_STATUS;
  29
  30 #define ERROR_MORE_DATA ( 234L )
  31
  32 /****************************************************************
  33 ****************************************************************/
  34
  35 #ifndef _HEADER_misc
  36
  37 struct GUID {
  38         uint32_t time_low;
  39         uint16_t time_mid;
  40         uint16_t time_hi_and_version;
  41         uint8_t clock_seq[2];
  42         uint8_t node[6];
  43 };
  44
  45 #endif /* _HEADER_misc */
  46
  47 #ifndef _HEADER_libnetapi
  48
  49 #ifndef MAXSUBAUTHS
  50 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
  51 #endif
  52
  53 struct domsid {
  54         uint8_t   sid_rev_num;
  55         uint8_t   num_auths;
  56         uint8_t   id_auth[6];
  57         uint32_t  sub_auths[MAXSUBAUTHS];
  58 };
  59
  60 struct DOMAIN_CONTROLLER_INFO {
  61         const char * domain_controller_name;
  62         const char * domain_controller_address;
  63         uint32_t domain_controller_address_type;
  64         struct GUID domain_guid;
  65         const char * domain_name;
  66         const char * dns_forest_name;
  67         uint32_t flags;
  68         const char * dc_site_name;
  69         const char * client_site_name;
  70 };
  71
  72 #define FILTER_TEMP_DUPLICATE_ACCOUNT   ( 0x0001 )
  73 #define FILTER_NORMAL_ACCOUNT   ( 0x0002 )
  74 #define FILTER_INTERDOMAIN_TRUST_ACCOUNT        ( 0x0008 )
  75 #define FILTER_WORKSTATION_TRUST_ACCOUNT        ( 0x0010 )
  76 #define FILTER_SERVER_TRUST_ACCOUNT     ( 0x0020 )
  77
  78 struct SERVER_INFO_1005 {
  79         const char * sv1005_comment;
  80 };
  81
  82 struct USER_INFO_0 {
  83         const char * usri0_name;
  84 };
  85
  86 struct USER_INFO_1 {
  87         const char * usri1_name;
  88         const char * usri1_password;
  89         uint32_t usri1_password_age;
  90         uint32_t usri1_priv;
  91         const char * usri1_home_dir;
  92         const char * usri1_comment;
  93         uint32_t usri1_flags;
  94         const char * usri1_script_path;
  95 };
  96
  97 struct USER_INFO_2 {
  98         const char * usri2_name;
  99         const char * usri2_password;
 100         uint32_t usri2_password_age;
 101         uint32_t usri2_priv;
 102         const char * usri2_home_dir;
 103         const char * usri2_comment;
 104         uint32_t usri2_flags;
 105         const char * usri2_script_path;
 106         uint32_t usri2_auth_flags;
 107         const char * usri2_full_name;
 108         const char * usri2_usr_comment;
 109         const char * usri2_parms;
 110         const char * usri2_workstations;
 111         uint32_t usri2_last_logon;
 112         uint32_t usri2_last_logoff;
 113         uint32_t usri2_acct_expires;
 114         uint32_t usri2_max_storage;
 115         uint32_t usri2_units_per_week;
 116         uint8_t *usri2_logon_hours;/* [unique] */
 117         uint32_t usri2_bad_pw_count;
 118         uint32_t usri2_num_logons;
 119         const char * usri2_logon_server;
 120         uint32_t usri2_country_code;
 121         uint32_t usri2_code_page;
 122 };
 123
 124 struct USER_INFO_3 {
 125         const char * usri3_name;
 126         uint32_t usri3_password_age;
 127         uint32_t usri3_priv;
 128         const char * usri3_home_dir;
 129         const char * usri3_comment;
 130         uint32_t usri3_flags;
 131         const char * usri3_script_path;
 132         uint32_t usri3_auth_flags;
 133         const char * usri3_full_name;
 134         const char * usri3_usr_comment;
 135         const char * usri3_parms;
 136         const char * usri3_workstations;
 137         uint32_t usri3_last_logon;
 138         uint32_t usri3_last_logoff;
 139         uint32_t usri3_acct_expires;
 140         uint32_t usri3_max_storage;
 141         uint32_t usri3_units_per_week;
 142         uint8_t *usri3_logon_hours;/* [unique] */
 143         uint32_t usri3_bad_pw_count;
 144         uint32_t usri3_num_logons;
 145         const char * usri3_logon_server;
 146         uint32_t usri3_country_code;
 147         uint32_t usri3_code_page;
 148         uint32_t usri3_user_id;
 149         uint32_t usri3_primary_group_id;
 150         const char * usri3_profile;
 151         const char * usri3_home_dir_drive;
 152         uint32_t usri3_password_expired;
 153 };
 154
 155 struct USER_INFO_4 {
 156         const char * usri4_name;
 157         const char * usri4_password;
 158         uint32_t usri4_password_age;
 159         uint32_t usri4_priv;
 160         const char * usri4_home_dir;
 161         const char * usri4_comment;
 162         uint32_t usri4_flags;
 163         const char * usri4_script_path;
 164         uint32_t usri4_auth_flags;
 165         const char * usri4_full_name;
 166         const char * usri4_usr_comment;
 167         const char * usri4_parms;
 168         const char * usri4_workstations;
 169         uint32_t usri4_last_logon;
 170         uint32_t usri4_last_logoff;
 171         uint32_t usri4_acct_expires;
 172         uint32_t usri4_max_storage;
 173         uint32_t usri4_units_per_week;
 174         uint8_t *usri4_logon_hours;/* [unique] */
 175         uint32_t usri4_bad_pw_count;
 176         uint32_t usri4_num_logons;
 177         const char * usri4_logon_server;
 178         uint32_t usri4_country_code;
 179         uint32_t usri4_code_page;
 180         struct dom_sid *usri4_user_sid;/* [unique] */
 181         uint32_t usri4_primary_group_id;
 182         const char * usri4_profile;
 183         const char * usri4_home_dir_drive;
 184         uint32_t usri4_password_expired;
 185 };
 186
 187 struct USER_INFO_10 {
 188         const char * usri10_name;
 189         const char * usri10_comment;
 190         const char * usri10_usr_comment;
 191         const char * usri10_full_name;
 192 };
 193
 194 struct USER_INFO_11 {
 195         const char * usri11_name;
 196         const char * usri11_comment;
 197         const char * usri11_usr_comment;
 198         const char * usri11_full_name;
 199         uint32_t usri11_priv;
 200         uint32_t usri11_auth_flags;
 201         uint32_t usri11_password_age;
 202         const char * usri11_home_dir;
 203         const char * usri11_parms;
 204         uint32_t usri11_last_logon;
 205         uint32_t usri11_last_logoff;
 206         uint32_t usri11_bad_pw_count;
 207         uint32_t usri11_num_logons;
 208         const char * usri11_logon_server;
 209         uint32_t usri11_country_code;
 210         const char * usri11_workstations;
 211         uint32_t usri11_max_storage;
 212         uint32_t usri11_units_per_week;
 213         uint8_t *usri11_logon_hours;/* [unique] */
 214         uint32_t usri11_code_page;
 215 };
 216
 217 struct USER_INFO_20 {
 218         const char * usri20_name;
 219         const char * usri20_full_name;
 220         const char * usri20_comment;
 221         uint32_t usri20_flags;
 222         uint32_t usri20_user_id;
 223 };
 224
 225 struct USER_INFO_23 {
 226         const char * usri23_name;
 227         const char * usri23_full_name;
 228         const char * usri23_comment;
 229         uint32_t usri23_flags;
 230         struct domsid *usri23_user_sid;/* [unique] */
 231 };
 232
 233 struct USER_INFO_1007 {
 234         const char * usri1007_comment;
 235 };
 236
 237 struct NET_DISPLAY_USER {
 238         const char * usri1_name;
 239         const char * usri1_comment;
 240         uint32_t usri1_flags;
 241         const char * usri1_full_name;
 242         uint32_t usri1_user_id;
 243         uint32_t usri1_next_index;
 244 };
 245
 246 struct NET_DISPLAY_MACHINE {
 247         const char * usri2_name;
 248         const char * usri2_comment;
 249         uint32_t usri2_flags;
 250         uint32_t usri2_user_id;
 251         uint32_t usri2_next_index;
 252 };
 253
 254 struct NET_DISPLAY_GROUP {
 255         const char * grpi3_name;
 256         const char * grpi3_comment;
 257         uint32_t grpi3_group_id;
 258         uint32_t grpi3_attributes;
 259         uint32_t grpi3_next_index;
 260 };
 261
 262 struct GROUP_INFO_0 {
 263         const char * grpi0_name;
 264 };
 265
 266 struct GROUP_INFO_1 {
 267         const char * grpi1_name;
 268         const char * grpi1_comment;
 269 };
 270
 271 struct GROUP_INFO_2 {
 272         const char * grpi2_name;
 273         const char * grpi2_comment;
 274         uint32_t grpi2_group_id;
 275         uint32_t grpi2_attributes;
 276 };
 277
 278 struct GROUP_INFO_3 {
 279         const char * grpi3_name;
 280         const char * grpi3_comment;
 281         struct domsid * grpi3_group_sid;
 282         uint32_t grpi3_attributes;
 283 };
 284
 285 struct GROUP_INFO_1002 {
 286         const char * grpi1002_comment;
 287 };
 288
 289 struct GROUP_INFO_1005 {
 290         uint32_t grpi1005_attributes;
 291 };
 292
 293 struct GROUP_USERS_INFO_0 {
 294         const char * grui0_name;
 295 };
 296
 297 struct GROUP_USERS_INFO_1 {
 298         const char * grui1_name;
 299         uint32_t grui1_attributes;
 300 };
 301
 302 struct LOCALGROUP_INFO_0 {
 303         const char * lgrpi0_name;
 304 };
 305
 306 struct LOCALGROUP_INFO_1 {
 307         const char * lgrpi1_name;
 308         const char * lgrpi1_comment;
 309 };
 310
 311 struct LOCALGROUP_INFO_1002 {
 312         const char * lgrpi1002_comment;
 313 };
 314
 315 struct TIME_OF_DAY_INFO {
 316         uint32_t tod_elapsedt;
 317         uint32_t tod_msecs;
 318         uint32_t tod_hours;
 319         uint32_t tod_mins;
 320         uint32_t tod_secs;
 321         uint32_t tod_hunds;
 322         int32_t tod_timezone;
 323         uint32_t tod_tinterval;
 324         uint32_t tod_day;
 325         uint32_t tod_month;
 326         uint32_t tod_year;
 327         uint32_t tod_weekday;
 328 };
 329
 330 #endif /* _HEADER_libnetapi */
 331
 332 /****************************************************************
 333 ****************************************************************/
 334
 335 struct libnetapi_ctx {
 336         char *debuglevel;
 337         char *error_string;
 338         char *username;
 339         char *workgroup;
 340         char *password;
 341         char *krb5_cc_env;
 342         int use_kerberos;
 343         int disable_policy_handle_cache;
 344
 345         void *private_data;
 346 };
 347
 348 /****************************************************************
 349 ****************************************************************/
 350
 351 NET_API_STATUS libnetapi_init(struct libnetapi_ctx **ctx);
 352
 353 /****************************************************************
 354 ****************************************************************/
 355
 356 NET_API_STATUS libnetapi_free(struct libnetapi_ctx *ctx);
 357
 358 /****************************************************************
 359 ****************************************************************/
 360
 361 NET_API_STATUS libnetapi_getctx(struct libnetapi_ctx **ctx);
 362
 363 /****************************************************************
 364 ****************************************************************/
 365
 366 NET_API_STATUS libnetapi_set_debuglevel(struct libnetapi_ctx *ctx,
 367                                         const char *debuglevel);
 368
 369 /****************************************************************
 370 ****************************************************************/
 371
 372 NET_API_STATUS libnetapi_set_username(struct libnetapi_ctx *ctx,
 373                                       const char *username);
 374
 375 /****************************************************************
 376 ****************************************************************/
 377
 378 NET_API_STATUS libnetapi_set_password(struct libnetapi_ctx *ctx,
 379                                       const char *password);
 380
 381 /****************************************************************
 382 ****************************************************************/
 383
 384 NET_API_STATUS libnetapi_set_workgroup(struct libnetapi_ctx *ctx,
 385                                        const char *workgroup);
 386
 387 /****************************************************************
 388 ****************************************************************/
 389
 390 NET_API_STATUS libnetapi_set_use_kerberos(struct libnetapi_ctx *ctx);
 391
 392 /****************************************************************
 393 ****************************************************************/
 394
 395 const char *libnetapi_errstr(NET_API_STATUS status);
 396
 397 /****************************************************************
 398 ****************************************************************/
 399
 400 const char *libnetapi_get_error_string(struct libnetapi_ctx *ctx,
 401                                        NET_API_STATUS status);
 402
 403 /****************************************************************
 404  NetApiBufferAllocate
 405 ****************************************************************/
 406
 407 NET_API_STATUS NetApiBufferAllocate(uint32_t byte_count,
 408                                     void **buffer);
 409
 410 /****************************************************************
 411  NetApiBufferFree
 412 ****************************************************************/
 413
 414 NET_API_STATUS NetApiBufferFree(void *buffer);
 415
 416 /************************************************************//**
 417  *
 418  * ConvertSidToStringSid
 419  *
 420  * @brief Convert a domain sid into a string
 421  *
 422  * @param[in] sid A pointer to a sid structure
 423  * @param[in] sid_string A pointer that holds a pointer to a sid string. Caller
 424  * needs to free with free(3)
 425  * @return bool
 426  ***************************************************************/
 427
 428 int  ConvertSidToStringSid(const struct domsid *sid,
 429                            char **sid_string);
 430
 431 /************************************************************//**
 432  *
 433  * ConvertStringSidToSid
 434  *
 435  * @brief Convert a string into a domain sid
 436  *
 437  * @param[in] sid_string A pointer to a sid string.
 438  * @param[in] sid A pointer that holds a pointer to a sid structure.
 439  * Caller needs to free with free(3)
 440  * @return bool
 441  ***************************************************************/
 442
 443 int ConvertStringSidToSid(const char *sid_string,
 444                           struct domsid **sid);
 445
 446 /************************************************************//**
 447  *
 448  * NetJoinDomain
 449  *
 450  * @brief Join a computer to a domain or workgroup
 451  *
 452  * @param[in] server The server name to connect to
 453  * @param[in] domain The domain or workgroup to join
 454  * @param[in] account_ou The organizational Unit to create the computer account
 455  * in (AD only)
 456  * @param[in] account The domain account used for joining a domain
 457  * @param[in] password The domain account's password used for joining a domain
 458  * @param[in] join_flags Bitmask field to define specific join features
 459  * @return NET_API_STATUS
 460  *
 461  * example netdomjoin/netdomjoin.c
 462  ***************************************************************/
 463
 464 NET_API_STATUS NetJoinDomain(const char * server /* [in] */,
 465                              const char * domain /* [in] [ref] */,
 466                              const char * account_ou /* [in] */,
 467                              const char * account /* [in] */,
 468                              const char * password /* [in] */,
 469                              uint32_t join_flags /* [in] */);
 470
 471 /************************************************************//**
 472  *
 473  * NetUnjoinDomain
 474  *
 475  * @brief Unjoin a computer from a domain or workgroup
 476  *
 477  * @param[in] server_name The server name to connect to
 478  * @param[in] account The domain account used for unjoining a domain
 479  * @param[in] password The domain account's password used for unjoining a domain
 480  * @param[in] unjoin_flags Bitmask field to define specific unjoin features
 481  * @return NET_API_STATUS
 482  *
 483  ***************************************************************/
 484
 485 NET_API_STATUS NetUnjoinDomain(const char * server_name /* [in] */,
 486                                const char * account /* [in] */,
 487                                const char * password /* [in] */,
 488                                uint32_t unjoin_flags /* [in] */);
 489
 490 /************************************************************//**
 491  *
 492  * NetGetJoinInformation
 493  *
 494  * @brief Unjoin a computer from a domain or workgroup
 495  *
 496  * @param[in] server_name The server name to connect to
 497  * @param[out] name_buffer Returns the name of the workgroup or domain
 498  * @param[out] name_type  Returns the type of that name
 499  * @return NET_API_STATUS
 500  *
 501  * example netdomjoin-gui/netdomjoin-gui.c
 502  *
 503  ***************************************************************/
 504
 505 NET_API_STATUS NetGetJoinInformation(const char * server_name /* [in] */,
 506                                      const char * *name_buffer /* [out] [ref] */,
 507                                      uint16_t *name_type /* [out] [ref] */);
 508
 509 /************************************************************//**
 510  *
 511  * NetGetJoinableOUs
 512  *
 513  * @brief Query for the list of joinable organizational Units that can be used
 514  * for joining AD
 515  *
 516  * @param[in] server_name The server name to connect to
 517  * @param[in] domain The AD domain to query
 518  * @param[in] account The domain account used for the query
 519  * @param[in] password The domain account's password used for the query
 520  * @param[out] ou_count The number of ous returned
 521  * @param[out] ous Returned string array containing the ous
 522  * @return NET_API_STATUS
 523  *
 524  * example netdomjoin-gui/netdomjoin-gui.c
 525  *
 526  ***************************************************************/
 527
 528 NET_API_STATUS NetGetJoinableOUs(const char * server_name /* [in] */,
 529                                  const char * domain /* [in] [ref] */,
 530                                  const char * account /* [in] */,
 531                                  const char * password /* [in] */,
 532                                  uint32_t *ou_count /* [out] [ref] */,
 533                                  const char * **ous /* [out] [ref] */);
 534
 535 /************************************************************//**
 536  *
 537  * NetServerGetInfo
 538  *
 539  * @brief Get Information on a server
 540  *
 541  * @param[in] server_name The server name to connect to
 542  * @param[in] level The level to define which information is requested
 543  * @param[out] buffer The returned buffer carrying the SERVER_INFO structure
 544  * @return NET_API_STATUS
 545  *
 546  ***************************************************************/
 547
 548 NET_API_STATUS NetServerGetInfo(const char * server_name /* [in] */,
 549                                 uint32_t level /* [in] */,
 550                                 uint8_t **buffer /* [out] [ref] */);
 551
 552 /************************************************************//**
 553  *
 554  * NetServerSetInfo
 555  *
 556  * @brief Get Information on a server
 557  *
 558  * @param[in] server_name The server name to connect to
 559  * @param[in] level The level to define which information is set
 560  * @param[in] buffer The buffer carrying the SERVER_INFO structure
 561  * @param[out] parm_error On failure returns the invalid SERVER_INFO member
 562  * @return NET_API_STATUS
 563  *
 564  ***************************************************************/
 565
 566 NET_API_STATUS NetServerSetInfo(const char * server_name /* [in] */,
 567                                 uint32_t level /* [in] */,
 568                                 uint8_t *buffer /* [in] [ref] */,
 569                                 uint32_t *parm_error /* [out] [ref] */);
 570
 571 /************************************************************//**
 572  *
 573  * NetGetDCName
 574  *
 575  * @brief Query for the PDC for a given domain
 576  *
 577  * @param[in] server_name The server name to connect to
 578  * @param[in] domain_name The name of the domain to lookup
 579  * @param[out] buffer The name of the domain to lookup
 580  * @return NET_API_STATUS
 581  *
 582  * example getdc/getdc.c
 583  ***************************************************************/
 584
 585 NET_API_STATUS NetGetDCName(const char * server_name /* [in] */,
 586                             const char * domain_name /* [in] */,
 587                             uint8_t **buffer /* [out] [ref] */);
 588
 589 /************************************************************//**
 590  *
 591  * NetGetAnyDCName
 592  *
 593  * @brief Query for any DC for a given domain
 594  *
 595  * @param[in] server_name The server name to connect to
 596  * @param[in] domain_name The name of the domain to lookup
 597  * @param[out] buffer The name of the domain to lookup
 598  * @return NET_API_STATUS
 599  *
 600  * example getdc/getdc.c
 601  ***************************************************************/
 602
 603 NET_API_STATUS NetGetAnyDCName(const char * server_name /* [in] */,
 604                                const char * domain_name /* [in] */,
 605                                uint8_t **buffer /* [out] [ref] */);
 606
 607
 608 /************************************************************//**
 609  *
 610  * DsGetDcName
 611  *
 612  * @brief Lookup a DC for a given domain and return information structure
 613  *
 614  * @param[in] server_name The server name to connect to
 615  * @param[in] domain_name The name of the domain to lookup (cannot be NULL)
 616  * @param[in] domain_guid The GUID of the domain to lookup (optional)
 617  * @param[in] site_name The name of the site the DC should reside in
 618  * @param[in] flags A bitmask to request specific features supported by the DC
 619  * @param[out] dc_info Pointer to a DOMAIN_CONTROLLER_INFO structure
 620  * @return NET_API_STATUS
 621  *
 622  * example dsgetdc/dsgetdc.c
 623  ***************************************************************/
 624
 625 NET_API_STATUS DsGetDcName(const char * server_name /* [in] [unique] */,
 626                            const char * domain_name /* [in] [ref] */,
 627                            struct GUID *domain_guid /* [in] [unique] */,
 628                            const char * site_name /* [in] [unique] */,
 629                            uint32_t flags /* [in] */,
 630                            struct DOMAIN_CONTROLLER_INFO **dc_info /* [out] [ref] */);
 631
 632 /************************************************************//**
 633  *
 634  * NetUserAdd
 635  *
 636  * @brief Create a user on a given server
 637  *
 638  * @param[in] server_name The server name to connect to
 639  * @param[in] level The level of the USER_INFO structure passed in (Currently
 640  * only level 1 is supported)
 641  * @param[in] buffer The buffer carrying the USER_INFO structure
 642  * @param[out] parm_error In case of error returns the failing member of the
 643  * structure
 644  * @return NET_API_STATUS
 645  *
 646  * example user/user_add.c
 647  ***************************************************************/
 648
 649 NET_API_STATUS NetUserAdd(const char * server_name /* [in] */,
 650                           uint32_t level /* [in] */,
 651                           uint8_t *buffer /* [in] [ref] */,
 652                           uint32_t *parm_error /* [out] [ref] */);
 653
 654 /************************************************************//**
 655  *
 656  * NetUserDel
 657  *
 658  * @brief Delete a user on a given server
 659  *
 660  * @param[in] server_name The server name to connect to
 661  * @param[in] user_name The user account to delete
 662  * @return NET_API_STATUS
 663  *
 664  * example user/user_del.c
 665  ***************************************************************/
 666
 667 NET_API_STATUS NetUserDel(const char * server_name /* [in] */,
 668                           const char * user_name /* [in] */);
 669
 670 /************************************************************//**
 671  *
 672  * NetUserEnum
 673  *
 674  * @brief Enumerate accounts on a server
 675  *
 676  * @param[in] server_name The server name to connect to
 677  * @param[in] level The enumeration level used for the query (Currently only
 678  * level 0 is supported)
 679  * @param[in] filter The account flags filter used for the query
 680  * @param[out] buffer The returned enumeration buffer
 681  * @param[in] prefmaxlen The requested maximal buffer size
 682  * @param[out] entries_read The number of returned entries
 683  * @param[out] total_entries The number of total entries
 684  * @param[in,out] resume_handle A handle passed in and returned for resuming
 685  * operations
 686  * @return NET_API_STATUS
 687  *
 688  * example user/user_enum.c
 689  ***************************************************************/
 690
 691 NET_API_STATUS NetUserEnum(const char * server_name /* [in] */,
 692                            uint32_t level /* [in] */,
 693                            uint32_t filter /* [in] */,
 694                            uint8_t **buffer /* [out] [ref] */,
 695                            uint32_t prefmaxlen /* [in] */,
 696                            uint32_t *entries_read /* [out] [ref] */,
 697                            uint32_t *total_entries /* [out] [ref] */,
 698                            uint32_t *resume_handle /* [in,out] [ref] */);
 699
 700 /************************************************************//**
 701  *
 702  * NetUserChangePassword
 703  *
 704  * @brief Change the password for a user on a given server or in a given domain
 705  *
 706  * @param[in] domain_name The server or domain name to connect to
 707  * @param[in] user_name The user account to change the password for
 708  * @param[in] old_password The user account's old password
 709  * @param[in] new_password The user account's new password
 710  * @return NET_API_STATUS
 711  *
 712  * example user/user_chgpwd.c
 713  ***************************************************************/
 714
 715 NET_API_STATUS NetUserChangePassword(const char * domain_name /* [in] */,
 716                                      const char * user_name /* [in] */,
 717                                      const char * old_password /* [in] */,
 718                                      const char * new_password /* [in] */);
 719
 720 /************************************************************//**
 721  *
 722  * NetUserGetInfo
 723  *
 724  * @brief Get User Information
 725  *
 726  * @param[in] server_name The server name to connect to
 727  * @param[in] user_name The name of the user that is going to be queried
 728  * @param[in] level The level defining the requested USER_INFO_X structure
 729  * @param[out] buffer The buffer containing a USER_INFO_X structure
 730  * @return NET_API_STATUS
 731  *
 732  * example user/user_getinfo.c
 733  ***************************************************************/
 734
 735 NET_API_STATUS NetUserGetInfo(const char * server_name /* [in] */,
 736                               const char * user_name /* [in] */,
 737                               uint32_t level /* [in] */,
 738                               uint8_t **buffer /* [out] [ref] */);
 739
 740 /************************************************************//**
 741  *
 742  * NetUserSetInfo
 743  *
 744  * @brief Set User Information
 745  *
 746  * @param[in] server_name The server name to connect to
 747  * @param[in] user_name The name of the user that is going to be modified
 748  * @param[in] level The level defining the requested USER_INFO_X structure
 749  * @param[in] buf The buffer containing a USER_INFO_X structure
 750  * @param[out] parm_err The returned parameter error number if any
 751  * @return NET_API_STATUS
 752  *
 753  * example user/user_setinfo.c
 754  ***************************************************************/
 755
 756 NET_API_STATUS NetUserSetInfo(const char * server_name /* [in] */,
 757                               const char * user_name /* [in] */,
 758                               uint32_t level /* [in] */,
 759                               uint8_t *buffer /* [in] [ref] */,
 760                               uint32_t *parm_err /* [out] [ref] */);
 761
 762 /************************************************************//**
 763  *
 764  * NetQueryDisplayInformation
 765  *
 766  * @brief Enumerate accounts on a server
 767  *
 768  * @param[in] server_name The server name to connect to
 769  * @param[in] level The enumeration level used for the query
 770  * @param[in] idx The index to start the the display enumeration at
 771  * @param[in] entries_requested The number of entries requested
 772  * @param[in] prefmaxlen The requested maximal buffer size
 773  * @param[out] entries_read The number of returned entries
 774  * @param[out] buffer The returned display information buffer
 775  * @return NET_API_STATUS
 776  *
 777  * example user/user_dispinfo.c
 778  ***************************************************************/
 779
 780 NET_API_STATUS NetQueryDisplayInformation(const char * server_name /* [in] [unique] */,
 781                                           uint32_t level /* [in] */,
 782                                           uint32_t idx /* [in] */,
 783                                           uint32_t entries_requested /* [in] */,
 784                                           uint32_t prefmaxlen /* [in] */,
 785                                           uint32_t *entries_read /* [out] [ref] */,
 786                                           void **buffer /* [out] [noprint,ref] */);
 787
 788 /************************************************************//**
 789  *
 790  * NetGroupAdd
 791  *
 792  * @brief Create Domain Group
 793  *
 794  * @param[in] server_name The server name to connect to
 795  * @param[in] level The level used for the new group creation
 796  * @param[in] buf The buffer containing the group structure
 797  * @param[out] parm_err The returned parameter error number if any
 798  * @return NET_API_STATUS
 799  *
 800  * example group/group_add.c
 801  ***************************************************************/
 802
 803 NET_API_STATUS NetGroupAdd(const char * server_name /* [in] */,
 804                            uint32_t level /* [in] */,
 805                            uint8_t *buf /* [in] [ref] */,
 806                            uint32_t *parm_err /* [out] [ref] */);
 807
 808 /************************************************************//**
 809  *
 810  * NetGroupDel
 811  *
 812  * @brief Delete Domain Group
 813  *
 814  * @param[in] server_name The server name to connect to
 815  * @param[in] group_name The name of the group that is going to be deleted
 816  * @return NET_API_STATUS
 817  *
 818  * example group/group_del.c
 819  ***************************************************************/
 820
 821 NET_API_STATUS NetGroupDel(const char * server_name /* [in] */,
 822                            const char * group_name /* [in] */);
 823
 824 /************************************************************//**
 825  *
 826  * NetGroupEnum
 827  *
 828  * @brief Enumerate groups on a server
 829  *
 830  * @param[in] server_name The server name to connect to
 831  * @param[in] level The enumeration level used for the query (Currently only
 832  * level 0 is supported)
 833  * @param[out] buffer The returned enumeration buffer
 834  * @param[in] prefmaxlen The requested maximal buffer size
 835  * @param[out] entries_read The number of returned entries
 836  * @param[out] total_entries The number of total entries
 837  * @param[in,out] resume_handle A handle passed in and returned for resuming
 838  * operations
 839  * @return NET_API_STATUS
 840  *
 841  * example group/group_enum.c
 842  ***************************************************************/
 843
 844 NET_API_STATUS NetGroupEnum(const char * server_name /* [in] */,
 845                             uint32_t level /* [in] */,
 846                             uint8_t **buffer /* [out] [ref] */,
 847                             uint32_t prefmaxlen /* [in] */,
 848                             uint32_t *entries_read /* [out] [ref] */,
 849                             uint32_t *total_entries /* [out] [ref] */,
 850                             uint32_t *resume_handle /* [in,out] [ref] */);
 851
 852 /************************************************************//**
 853  *
 854  * NetGroupSetInfo
 855  *
 856  * @brief Set Domain Group Information
 857  *
 858  * @param[in] server_name The server name to connect to
 859  * @param[in] group_name The name of the group that is going to be modified
 860  * @param[in] level The level defining the structure type in buf
 861  * @param[in] buf The buffer containing a GROUP_INFO_X structure
 862  * @param[out] parm_err The returned parameter error number if any
 863  * @return NET_API_STATUS
 864  *
 865  * example group/group_setinfo.c
 866  ***************************************************************/
 867
 868 NET_API_STATUS NetGroupSetInfo(const char * server_name /* [in] */,
 869                                const char * group_name /* [in] */,
 870                                uint32_t level /* [in] */,
 871                                uint8_t *buf /* [in] [ref] */,
 872                                uint32_t *parm_err /* [out] [ref] */);
 873
 874 /************************************************************//**
 875  *
 876  * NetGroupGetInfo
 877  *
 878  * @brief Get Domain Group Information
 879  *
 880  * @param[in] server_name The server name to connect to
 881  * @param[in] group_name The name of the group that is going to be queried
 882  * @param[in] level The level defining the requested GROUP_INFO_X structure
 883  * @param[out] buf The buffer containing a GROUP_INFO_X structure
 884  * @return NET_API_STATUS
 885  *
 886  * example group/group_getinfo.c
 887  ***************************************************************/
 888
 889 NET_API_STATUS NetGroupGetInfo(const char * server_name /* [in] */,
 890                                const char * group_name /* [in] */,
 891                                uint32_t level /* [in] */,
 892                                uint8_t **buf /* [out] [ref] */);
 893
 894 /************************************************************//**
 895  *
 896  * NetGroupAddUser
 897  *
 898  * @brief Add existing User to existing Domain Group
 899  *
 900  * @param[in] server_name The server name to connect to
 901  * @param[in] group_name The name of the group that is going to be modified
 902  * @param[in] user_name The name of the user that is going to be added to the
 903  * group
 904  * @return NET_API_STATUS
 905  *
 906  * example group/group_adduser.c
 907  ***************************************************************/
 908
 909 NET_API_STATUS NetGroupAddUser(const char * server_name /* [in] */,
 910                                const char * group_name /* [in] */,
 911                                const char * user_name /* [in] */);
 912
 913 /************************************************************//**
 914  *
 915  * NetGroupDelUser
 916  *
 917  * @brief Remove User from Domain Group
 918  *
 919  * @param[in] server_name The server name to connect to
 920  * @param[in] group_name The name of the group that is going to be modified
 921  * @param[in] user_name The name of the user that is going to be removed from
 922  * the group
 923  * @return NET_API_STATUS
 924  *
 925  * example group/group_deluser.c
 926  ***************************************************************/
 927
 928 NET_API_STATUS NetGroupDelUser(const char * server_name /* [in] */,
 929                                const char * group_name /* [in] */,
 930                                const char * user_name /* [in] */);
 931
 932 /************************************************************//**
 933  *
 934  * NetGroupGetUsers
 935  *
 936  * @brief Get Users for a group on a server
 937  *
 938  * @param[in] server_name The server name to connect to
 939  * @param[in] group_name The group name to enumerate users for
 940  * @param[in] level The enumeration level used for the query
 941  * @param[out] buffer The returned enumeration buffer
 942  * @param[in] prefmaxlen The requested maximal buffer size
 943  * @param[out] entries_read The number of returned entries
 944  * @param[out] total_entries The number of total entries
 945  * @param[in,out] resume_handle A handle passed in and returned for resuming
 946  * operations
 947  * @return NET_API_STATUS
 948  *
 949  * example group/group_getusers.c
 950  ***************************************************************/
 951
 952 NET_API_STATUS NetGroupGetUsers(const char * server_name /* [in] */,
 953                                 const char * group_name /* [in] */,
 954                                 uint32_t level /* [in] */,
 955                                 uint8_t **buffer /* [out] [ref] */,
 956                                 uint32_t prefmaxlen /* [in] */,
 957                                 uint32_t *entries_read /* [out] [ref] */,
 958                                 uint32_t *total_entries /* [out] [ref] */,
 959                                 uint32_t *resume_handle /* [in,out] [ref] */);
 960
 961 /************************************************************//**
 962  *
 963  * NetLocalGroupAdd
 964  *
 965  * @brief Create Local Group
 966  *
 967  * @param[in] server_name The server name to connect to
 968  * @param[in] level The level used for the new group creation
 969  * @param[in] buf The buffer containing the group structure
 970  * @param[out] parm_err The returned parameter error number if any
 971  * @return NET_API_STATUS
 972  *
 973  * example localgroup/localgroup_add.c
 974  ***************************************************************/
 975
 976 NET_API_STATUS NetLocalGroupAdd(const char * server_name /* [in] */,
 977                                 uint32_t level /* [in] */,
 978                                 uint8_t *buf /* [in] [ref] */,
 979                                 uint32_t *parm_err /* [out] [ref] */);
 980
 981 /************************************************************//**
 982  *
 983  * NetLocalGroupDel
 984  *
 985  * @brief Delete Local Group
 986  *
 987  * @param[in] server_name The server name to connect to
 988  * @param[in] group_name The name of the group that is going to be deleted
 989  * @return NET_API_STATUS
 990  *
 991  * example localgroup/localgroup_del.c
 992  ***************************************************************/
 993
 994
 995 NET_API_STATUS NetLocalGroupDel(const char * server_name /* [in] */,
 996                                 const char * group_name /* [in] */);
 997
 998 /************************************************************//**
 999  *
1000  * NetLocalGroupGetInfo
1001  *
1002  * @brief Get Local Group Information
1003  *
1004  * @param[in] server_name The server name to connect to
1005  * @param[in] group_name The name of the group that is going to be queried
1006  * @param[in] level The level defining the requested LOCALGROUP_INFO_X structure
1007  * @param[out] buf The buffer containing a LOCALGROUP_INFO_X structure
1008  * @return NET_API_STATUS
1009  *
1010  * example localgroup/localgroup_getinfo.c
1011  ***************************************************************/
1012
1013 NET_API_STATUS NetLocalGroupGetInfo(const char * server_name /* [in] */,
1014                                     const char * group_name /* [in] */,
1015                                     uint32_t level /* [in] */,
1016                                     uint8_t **buf /* [out] [ref] */);
1017
1018 /************************************************************//**
1019  *
1020  * NetLocalGroupSetInfo
1021  *
1022  * @brief Set Local Group Information
1023  *
1024  * @param[in] server_name The server name to connect to
1025  * @param[in] group_name The name of the group that is going to be modified
1026  * @param[in] level The level defining the requested LOCALGROUP_INFO_X structure
1027  * @param[in] buf The buffer containing a LOCALGROUP_INFO_X structure
1028  * @param[out] parm_err The returned parameter error number if any
1029  * @return NET_API_STATUS
1030  *
1031  * example localgroup/localgroup_setinfo.c
1032  ***************************************************************/
1033
1034
1035 NET_API_STATUS NetLocalGroupSetInfo(const char * server_name /* [in] */,
1036                                     const char * group_name /* [in] */,
1037                                     uint32_t level /* [in] */,
1038                                     uint8_t *buf /* [in] [ref] */,
1039                                     uint32_t *parm_err /* [out] [ref] */);
1040
1041 /************************************************************//**
1042  *
1043  * NetLocalGroupEnum
1044  *
1045  * @brief Enumerate local groups on a server
1046  *
1047  * @param[in] server_name The server name to connect to
1048  * @param[in] level The enumeration level used for the query (Currently only
1049  * level 0 is supported)
1050  * @param[out] buffer The returned enumeration buffer
1051  * @param[in] prefmaxlen The requested maximal buffer size
1052  * @param[out] entries_read The number of returned entries
1053  * @param[out] total_entries The number of total entries
1054  * @param[in,out] resume_handle A handle passed in and returned for resuming
1055  * operations
1056  * @return NET_API_STATUS
1057  *
1058  * example localgroup/localgroup_enum.c
1059  ***************************************************************/
1060
1061 NET_API_STATUS NetLocalGroupEnum(const char * server_name /* [in] */,
1062                                  uint32_t level /* [in] */,
1063                                  uint8_t **buffer /* [out] [ref] */,
1064                                  uint32_t prefmaxlen /* [in] */,
1065                                  uint32_t *entries_read /* [out] [ref] */,
1066                                  uint32_t *total_entries /* [out] [ref] */,
1067                                  uint32_t *resume_handle /* [in,out] [ref] */);
1068
1069 /************************************************************//**
1070  *
1071  * NetRemoteTOD
1072  *
1073  * @brief Query remote Time of Day
1074  *
1075  * @param[in] server_name The server name to connect to
1076  * @param[out] buf The buffer containing a TIME_OF_DAY_INFO structure
1077  * @return NET_API_STATUS
1078  *
1079  * example server/remote_tod.c
1080  ***************************************************************/
1081
1082 NET_API_STATUS NetRemoteTOD(const char * server_name /* [in] */,
1083                             uint8_t **buf /* [out] [ref] */);
1084
1085 #endif