/* * Unix SMB/CIFS implementation. * NetApi Support * Copyright (C) Guenther Deschner 2007-2008 * * 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 . */ #ifndef __LIB_NETAPI_H__ #define __LIB_NETAPI_H__ #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ /**************************************************************** NET_API_STATUS ****************************************************************/ typedef enum { NET_API_STATUS_SUCCESS = 0 } NET_API_STATUS; #define ERROR_MORE_DATA ( 234L ) /**************************************************************** ****************************************************************/ #ifndef _HEADER_misc struct GUID { uint32_t time_low; uint16_t time_mid; uint16_t time_hi_and_version; uint8_t clock_seq[2]; uint8_t node[6]; }; #endif /* _HEADER_misc */ #ifndef _HEADER_libnetapi #ifndef MAXSUBAUTHS #define MAXSUBAUTHS 15 /* max sub authorities in a SID */ #endif struct domsid { uint8_t sid_rev_num; uint8_t num_auths; uint8_t id_auth[6]; uint32_t sub_auths[MAXSUBAUTHS]; }; struct DOMAIN_CONTROLLER_INFO { const char * domain_controller_name; const char * domain_controller_address; uint32_t domain_controller_address_type; struct GUID domain_guid; const char * domain_name; const char * dns_forest_name; uint32_t flags; const char * dc_site_name; const char * client_site_name; }; #define FILTER_TEMP_DUPLICATE_ACCOUNT ( 0x0001 ) #define FILTER_NORMAL_ACCOUNT ( 0x0002 ) #define FILTER_INTERDOMAIN_TRUST_ACCOUNT ( 0x0008 ) #define FILTER_WORKSTATION_TRUST_ACCOUNT ( 0x0010 ) #define FILTER_SERVER_TRUST_ACCOUNT ( 0x0020 ) #define TIMEQ_FOREVER ( (uint32_t)-1L ) struct SERVER_INFO_1005 { const char * sv1005_comment; }; struct USER_INFO_0 { const char * usri0_name; }; struct USER_INFO_1 { const char * usri1_name; const char * usri1_password; uint32_t usri1_password_age; uint32_t usri1_priv; const char * usri1_home_dir; const char * usri1_comment; uint32_t usri1_flags; const char * usri1_script_path; }; struct USER_INFO_2 { const char * usri2_name; const char * usri2_password; uint32_t usri2_password_age; uint32_t usri2_priv; const char * usri2_home_dir; const char * usri2_comment; uint32_t usri2_flags; const char * usri2_script_path; uint32_t usri2_auth_flags; const char * usri2_full_name; const char * usri2_usr_comment; const char * usri2_parms; const char * usri2_workstations; uint32_t usri2_last_logon; uint32_t usri2_last_logoff; uint32_t usri2_acct_expires; uint32_t usri2_max_storage; uint32_t usri2_units_per_week; uint8_t *usri2_logon_hours;/* [unique] */ uint32_t usri2_bad_pw_count; uint32_t usri2_num_logons; const char * usri2_logon_server; uint32_t usri2_country_code; uint32_t usri2_code_page; }; struct USER_INFO_3 { const char * usri3_name; uint32_t usri3_password_age; uint32_t usri3_priv; const char * usri3_home_dir; const char * usri3_comment; uint32_t usri3_flags; const char * usri3_script_path; uint32_t usri3_auth_flags; const char * usri3_full_name; const char * usri3_usr_comment; const char * usri3_parms; const char * usri3_workstations; uint32_t usri3_last_logon; uint32_t usri3_last_logoff; uint32_t usri3_acct_expires; uint32_t usri3_max_storage; uint32_t usri3_units_per_week; uint8_t *usri3_logon_hours;/* [unique] */ uint32_t usri3_bad_pw_count; uint32_t usri3_num_logons; const char * usri3_logon_server; uint32_t usri3_country_code; uint32_t usri3_code_page; uint32_t usri3_user_id; uint32_t usri3_primary_group_id; const char * usri3_profile; const char * usri3_home_dir_drive; uint32_t usri3_password_expired; }; struct USER_INFO_4 { const char * usri4_name; const char * usri4_password; uint32_t usri4_password_age; uint32_t usri4_priv; const char * usri4_home_dir; const char * usri4_comment; uint32_t usri4_flags; const char * usri4_script_path; uint32_t usri4_auth_flags; const char * usri4_full_name; const char * usri4_usr_comment; const char * usri4_parms; const char * usri4_workstations; uint32_t usri4_last_logon; uint32_t usri4_last_logoff; uint32_t usri4_acct_expires; uint32_t usri4_max_storage; uint32_t usri4_units_per_week; uint8_t *usri4_logon_hours;/* [unique] */ uint32_t usri4_bad_pw_count; uint32_t usri4_num_logons; const char * usri4_logon_server; uint32_t usri4_country_code; uint32_t usri4_code_page; struct dom_sid *usri4_user_sid;/* [unique] */ uint32_t usri4_primary_group_id; const char * usri4_profile; const char * usri4_home_dir_drive; uint32_t usri4_password_expired; }; struct USER_INFO_10 { const char * usri10_name; const char * usri10_comment; const char * usri10_usr_comment; const char * usri10_full_name; }; struct USER_INFO_11 { const char * usri11_name; const char * usri11_comment; const char * usri11_usr_comment; const char * usri11_full_name; uint32_t usri11_priv; uint32_t usri11_auth_flags; uint32_t usri11_password_age; const char * usri11_home_dir; const char * usri11_parms; uint32_t usri11_last_logon; uint32_t usri11_last_logoff; uint32_t usri11_bad_pw_count; uint32_t usri11_num_logons; const char * usri11_logon_server; uint32_t usri11_country_code; const char * usri11_workstations; uint32_t usri11_max_storage; uint32_t usri11_units_per_week; uint8_t *usri11_logon_hours;/* [unique] */ uint32_t usri11_code_page; }; struct USER_INFO_20 { const char * usri20_name; const char * usri20_full_name; const char * usri20_comment; uint32_t usri20_flags; uint32_t usri20_user_id; }; struct USER_INFO_21 { uint8_t *usri21_password; }; struct USER_INFO_22 { const char * usri22_name; uint8_t *usri22_password; uint32_t usri22_password_age; uint32_t usri22_priv; const char * usri22_home_dir; const char * usri22_comment; uint32_t usri22_flags; uint32_t usri22_script_path; uint32_t usri22_auth_flags; const char * usri22_full_name; const char * usri22_usr_comment; const char * usri22_parms; const char * usri22_workstations; uint32_t usri22_last_logon; uint32_t usri22_last_logoff; uint32_t usri22_acct_expires; uint32_t usri22_max_storage; uint32_t usri22_units_per_week; uint8_t *usri22_logon_hours;/* [unique] */ uint32_t usri22_bad_pw_count; uint32_t usri22_num_logons; const char * usri22_logon_server; uint32_t usri22_country_code; uint32_t usri22_code_page; }; struct USER_INFO_23 { const char * usri23_name; const char * usri23_full_name; const char * usri23_comment; uint32_t usri23_flags; struct domsid *usri23_user_sid;/* [unique] */ }; struct USER_INFO_1003 { const char * usri1003_password; }; struct USER_INFO_1005 { uint32_t usri1005_priv; }; struct USER_INFO_1006 { const char * usri1006_home_dir; }; struct USER_INFO_1007 { const char * usri1007_comment; }; struct USER_INFO_1008 { uint32_t usri1008_flags; }; struct USER_INFO_1009 { const char * usri1009_script_path; }; struct USER_INFO_1010 { uint32_t usri1010_auth_flags; }; struct USER_INFO_1011 { const char * usri1011_full_name; }; struct USER_INFO_1012 { const char * usri1012_usr_comment; }; struct USER_INFO_1013 { const char * usri1013_parms; }; struct USER_INFO_1014 { const char * usri1014_workstations; }; struct USER_INFO_1017 { uint32_t usri1017_acct_expires; }; struct USER_INFO_1018 { uint32_t usri1018_max_storage; }; struct USER_INFO_1020 { uint32_t usri1020_units_per_week; uint8_t *usri1020_logon_hours;/* [unique] */ }; struct USER_INFO_1023 { const char * usri1023_logon_server; }; struct USER_INFO_1024 { uint32_t usri1024_country_code; }; struct USER_INFO_1025 { uint32_t usri1025_code_page; }; struct USER_INFO_1051 { uint32_t usri1051_primary_group_id; }; struct USER_INFO_1052 { const char * usri1052_profile; }; struct USER_INFO_1053 { const char * usri1053_home_dir_drive; }; struct USER_MODALS_INFO_0 { uint32_t usrmod0_min_passwd_len; uint32_t usrmod0_max_passwd_age; uint32_t usrmod0_min_passwd_age; uint32_t usrmod0_force_logoff; uint32_t usrmod0_password_hist_len; }; struct USER_MODALS_INFO_1 { uint32_t usrmod1_role; const char * usrmod1_primary; }; struct USER_MODALS_INFO_2 { const char * usrmod2_domain_name; struct domsid *usrmod2_domain_id;/* [unique] */ }; struct USER_MODALS_INFO_3 { uint32_t usrmod3_lockout_duration; uint32_t usrmod3_lockout_observation_window; uint32_t usrmod3_lockout_threshold; }; struct USER_MODALS_INFO_1001 { uint32_t usrmod1001_min_passwd_len; }; struct USER_MODALS_INFO_1002 { uint32_t usrmod1002_max_passwd_age; }; struct USER_MODALS_INFO_1003 { uint32_t usrmod1003_min_passwd_age; }; struct USER_MODALS_INFO_1004 { uint32_t usrmod1004_force_logoff; }; struct USER_MODALS_INFO_1005 { uint32_t usrmod1005_password_hist_len; }; struct USER_MODALS_INFO_1006 { uint32_t usrmod1006_role; }; struct USER_MODALS_INFO_1007 { const char * usrmod1007_primary; }; struct NET_DISPLAY_USER { const char * usri1_name; const char * usri1_comment; uint32_t usri1_flags; const char * usri1_full_name; uint32_t usri1_user_id; uint32_t usri1_next_index; }; struct NET_DISPLAY_MACHINE { const char * usri2_name; const char * usri2_comment; uint32_t usri2_flags; uint32_t usri2_user_id; uint32_t usri2_next_index; }; struct NET_DISPLAY_GROUP { const char * grpi3_name; const char * grpi3_comment; uint32_t grpi3_group_id; uint32_t grpi3_attributes; uint32_t grpi3_next_index; }; struct GROUP_INFO_0 { const char * grpi0_name; }; struct GROUP_INFO_1 { const char * grpi1_name; const char * grpi1_comment; }; struct GROUP_INFO_2 { const char * grpi2_name; const char * grpi2_comment; uint32_t grpi2_group_id; uint32_t grpi2_attributes; }; struct GROUP_INFO_3 { const char * grpi3_name; const char * grpi3_comment; struct domsid * grpi3_group_sid; uint32_t grpi3_attributes; }; struct GROUP_INFO_1002 { const char * grpi1002_comment; }; struct GROUP_INFO_1005 { uint32_t grpi1005_attributes; }; struct GROUP_USERS_INFO_0 { const char * grui0_name; }; struct GROUP_USERS_INFO_1 { const char * grui1_name; uint32_t grui1_attributes; }; struct LOCALGROUP_INFO_0 { const char * lgrpi0_name; }; struct LOCALGROUP_INFO_1 { const char * lgrpi1_name; const char * lgrpi1_comment; }; struct LOCALGROUP_INFO_1002 { const char * lgrpi1002_comment; }; enum SID_NAME_USE { SidTypeUser=1, SidTypeGroup=2, SidTypeDomain=3, SidTypeAlias=4, SidTypeWellKnownGroup=5, SidTypeDeletedAccount=6, SidTypeInvalid=7, SidTypeUnknown=8, SidTypeComputer=9, SidTypeLabel=10 }; struct LOCALGROUP_MEMBERS_INFO_0 { struct domsid *lgrmi0_sid;/* [unique] */ }; struct LOCALGROUP_MEMBERS_INFO_1 { struct domsid *lgrmi1_sid;/* [unique] */ enum SID_NAME_USE lgrmi1_sidusage; const char * lgrmi1_name; }; struct LOCALGROUP_MEMBERS_INFO_2 { struct domsid *lgrmi2_sid;/* [unique] */ enum SID_NAME_USE lgrmi2_sidusage; const char * lgrmi2_domainandname; }; struct LOCALGROUP_MEMBERS_INFO_3 { const char * lgrmi3_domainandname; }; struct TIME_OF_DAY_INFO { uint32_t tod_elapsedt; uint32_t tod_msecs; uint32_t tod_hours; uint32_t tod_mins; uint32_t tod_secs; uint32_t tod_hunds; int32_t tod_timezone; uint32_t tod_tinterval; uint32_t tod_day; uint32_t tod_month; uint32_t tod_year; uint32_t tod_weekday; }; #endif /* _HEADER_libnetapi */ /**************************************************************** ****************************************************************/ struct libnetapi_ctx { char *debuglevel; char *error_string; char *username; char *workgroup; char *password; char *krb5_cc_env; int use_kerberos; int disable_policy_handle_cache; void *private_data; }; /**************************************************************** ****************************************************************/ NET_API_STATUS libnetapi_init(struct libnetapi_ctx **ctx); /**************************************************************** ****************************************************************/ NET_API_STATUS libnetapi_free(struct libnetapi_ctx *ctx); /**************************************************************** ****************************************************************/ NET_API_STATUS libnetapi_getctx(struct libnetapi_ctx **ctx); /**************************************************************** ****************************************************************/ NET_API_STATUS libnetapi_set_debuglevel(struct libnetapi_ctx *ctx, const char *debuglevel); /**************************************************************** ****************************************************************/ NET_API_STATUS libnetapi_set_username(struct libnetapi_ctx *ctx, const char *username); /**************************************************************** ****************************************************************/ NET_API_STATUS libnetapi_set_password(struct libnetapi_ctx *ctx, const char *password); /**************************************************************** ****************************************************************/ NET_API_STATUS libnetapi_set_workgroup(struct libnetapi_ctx *ctx, const char *workgroup); /**************************************************************** ****************************************************************/ NET_API_STATUS libnetapi_set_use_kerberos(struct libnetapi_ctx *ctx); /**************************************************************** ****************************************************************/ const char *libnetapi_errstr(NET_API_STATUS status); /**************************************************************** ****************************************************************/ const char *libnetapi_get_error_string(struct libnetapi_ctx *ctx, NET_API_STATUS status); /**************************************************************** NetApiBufferAllocate ****************************************************************/ NET_API_STATUS NetApiBufferAllocate(uint32_t byte_count, void **buffer); /**************************************************************** NetApiBufferFree ****************************************************************/ NET_API_STATUS NetApiBufferFree(void *buffer); /************************************************************//** * * ConvertSidToStringSid * * @brief Convert a domain sid into a string * * @param[in] sid A pointer to a sid structure * @param[in,out] sid_string A pointer that holds a pointer to a sid string. Caller * needs to free with free(3) * @return bool ***************************************************************/ int ConvertSidToStringSid(const struct domsid *sid, char **sid_string); /************************************************************//** * * ConvertStringSidToSid * * @brief Convert a string into a domain sid * * @param[in] sid_string A pointer to a sid string. * @param[in,out] sid A pointer that holds a pointer to a sid structure. * Caller needs to free with free(3) * @return bool ***************************************************************/ int ConvertStringSidToSid(const char *sid_string, struct domsid **sid); /************************************************************//** * * NetJoinDomain * * @brief Join a computer to a domain or workgroup * * @param[in] server The server name to connect to * @param[in] domain The domain or workgroup to join * @param[in] account_ou The organizational Unit to create the computer account * in (AD only) * @param[in] account The domain account used for joining a domain * @param[in] password The domain account's password used for joining a domain * @param[in] join_flags Bitmask field to define specific join features * @return NET_API_STATUS * * example netdomjoin/netdomjoin.c ***************************************************************/ NET_API_STATUS NetJoinDomain(const char * server /* [in] */, const char * domain /* [in] [ref] */, const char * account_ou /* [in] */, const char * account /* [in] */, const char * password /* [in] */, uint32_t join_flags /* [in] */); /************************************************************//** * * NetUnjoinDomain * * @brief Unjoin a computer from a domain or workgroup * * @param[in] server_name The server name to connect to * @param[in] account The domain account used for unjoining a domain * @param[in] password The domain account's password used for unjoining a domain * @param[in] unjoin_flags Bitmask field to define specific unjoin features * @return NET_API_STATUS * ***************************************************************/ NET_API_STATUS NetUnjoinDomain(const char * server_name /* [in] */, const char * account /* [in] */, const char * password /* [in] */, uint32_t unjoin_flags /* [in] */); /************************************************************//** * * NetGetJoinInformation * * @brief Unjoin a computer from a domain or workgroup * * @param[in] server_name The server name to connect to * @param[out] name_buffer Returns the name of the workgroup or domain * @param[out] name_type Returns the type of that name * @return NET_API_STATUS * * example netdomjoin-gui/netdomjoin-gui.c * ***************************************************************/ NET_API_STATUS NetGetJoinInformation(const char * server_name /* [in] */, const char * *name_buffer /* [out] [ref] */, uint16_t *name_type /* [out] [ref] */); /************************************************************//** * * NetGetJoinableOUs * * @brief Query for the list of joinable organizational Units that can be used * for joining AD * * @param[in] server_name The server name to connect to * @param[in] domain The AD domain to query * @param[in] account The domain account used for the query * @param[in] password The domain account's password used for the query * @param[out] ou_count The number of ous returned * @param[out] ous Returned string array containing the ous * @return NET_API_STATUS * * example netdomjoin-gui/netdomjoin-gui.c * ***************************************************************/ NET_API_STATUS NetGetJoinableOUs(const char * server_name /* [in] */, const char * domain /* [in] [ref] */, const char * account /* [in] */, const char * password /* [in] */, uint32_t *ou_count /* [out] [ref] */, const char * **ous /* [out] [ref] */); /************************************************************//** * * NetServerGetInfo * * @brief Get Information on a server * * @param[in] server_name The server name to connect to * @param[in] level The level to define which information is requested * @param[out] buffer The returned buffer carrying the SERVER_INFO structure * @return NET_API_STATUS * ***************************************************************/ NET_API_STATUS NetServerGetInfo(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t **buffer /* [out] [ref] */); /************************************************************//** * * NetServerSetInfo * * @brief Get Information on a server * * @param[in] server_name The server name to connect to * @param[in] level The level to define which information is set * @param[in] buffer The buffer carrying the SERVER_INFO structure * @param[out] parm_error On failure returns the invalid SERVER_INFO member * @return NET_API_STATUS * ***************************************************************/ NET_API_STATUS NetServerSetInfo(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t *buffer /* [in] [ref] */, uint32_t *parm_error /* [out] [ref] */); /************************************************************//** * * NetGetDCName * * @brief Query for the PDC for a given domain * * @param[in] server_name The server name to connect to * @param[in] domain_name The name of the domain to lookup * @param[out] buffer The name of the domain to lookup * @return NET_API_STATUS * * example getdc/getdc.c ***************************************************************/ NET_API_STATUS NetGetDCName(const char * server_name /* [in] */, const char * domain_name /* [in] */, uint8_t **buffer /* [out] [ref] */); /************************************************************//** * * NetGetAnyDCName * * @brief Query for any DC for a given domain * * @param[in] server_name The server name to connect to * @param[in] domain_name The name of the domain to lookup * @param[out] buffer The name of the domain to lookup * @return NET_API_STATUS * * example getdc/getdc.c ***************************************************************/ NET_API_STATUS NetGetAnyDCName(const char * server_name /* [in] */, const char * domain_name /* [in] */, uint8_t **buffer /* [out] [ref] */); /************************************************************//** * * DsGetDcName * * @brief Lookup a DC for a given domain and return information structure * * @param[in] server_name The server name to connect to * @param[in] domain_name The name of the domain to lookup (cannot be NULL) * @param[in] domain_guid The GUID of the domain to lookup (optional) * @param[in] site_name The name of the site the DC should reside in * @param[in] flags A bitmask to request specific features supported by the DC * @param[out] dc_info Pointer to a DOMAIN_CONTROLLER_INFO structure * @return NET_API_STATUS * * example dsgetdc/dsgetdc.c ***************************************************************/ NET_API_STATUS DsGetDcName(const char * server_name /* [in] [unique] */, const char * domain_name /* [in] [ref] */, struct GUID *domain_guid /* [in] [unique] */, const char * site_name /* [in] [unique] */, uint32_t flags /* [in] */, struct DOMAIN_CONTROLLER_INFO **dc_info /* [out] [ref] */); /************************************************************//** * * NetUserAdd * * @brief Create a user on a given server * * @param[in] server_name The server name to connect to * @param[in] level The level of the USER_INFO structure passed in (Currently * only level 1 is supported) * @param[in] buffer The buffer carrying the USER_INFO structure * @param[out] parm_error In case of error returns the failing member of the * structure * @return NET_API_STATUS * * example user/user_add.c ***************************************************************/ NET_API_STATUS NetUserAdd(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t *buffer /* [in] [ref] */, uint32_t *parm_error /* [out] [ref] */); /************************************************************//** * * NetUserDel * * @brief Delete a user on a given server * * @param[in] server_name The server name to connect to * @param[in] user_name The user account to delete * @return NET_API_STATUS * * example user/user_del.c ***************************************************************/ NET_API_STATUS NetUserDel(const char * server_name /* [in] */, const char * user_name /* [in] */); /************************************************************//** * * NetUserEnum * * @brief Enumerate accounts on a server * * @param[in] server_name The server name to connect to * @param[in] level The enumeration level used for the query (Currently only * level 0 is supported) * @param[in] filter The account flags filter used for the query * @param[out] buffer The returned enumeration buffer * @param[in] prefmaxlen The requested maximal buffer size * @param[out] entries_read The number of returned entries * @param[out] total_entries The number of total entries * @param[in,out] resume_handle A handle passed in and returned for resuming * operations * @return NET_API_STATUS * * example user/user_enum.c ***************************************************************/ NET_API_STATUS NetUserEnum(const char * server_name /* [in] */, uint32_t level /* [in] */, uint32_t filter /* [in] */, uint8_t **buffer /* [out] [ref] */, uint32_t prefmaxlen /* [in] */, uint32_t *entries_read /* [out] [ref] */, uint32_t *total_entries /* [out] [ref] */, uint32_t *resume_handle /* [in,out] [ref] */); /************************************************************//** * * NetUserChangePassword * * @brief Change the password for a user on a given server or in a given domain * * @param[in] domain_name The server or domain name to connect to * @param[in] user_name The user account to change the password for * @param[in] old_password The user account's old password * @param[in] new_password The user account's new password * @return NET_API_STATUS * * example user/user_chgpwd.c ***************************************************************/ NET_API_STATUS NetUserChangePassword(const char * domain_name /* [in] */, const char * user_name /* [in] */, const char * old_password /* [in] */, const char * new_password /* [in] */); /************************************************************//** * * NetUserGetInfo * * @brief Get User Information * * @param[in] server_name The server name to connect to * @param[in] user_name The name of the user that is going to be queried * @param[in] level The level defining the requested USER_INFO_X structure * @param[out] buffer The buffer containing a USER_INFO_X structure * @return NET_API_STATUS * * example user/user_getinfo.c ***************************************************************/ NET_API_STATUS NetUserGetInfo(const char * server_name /* [in] */, const char * user_name /* [in] */, uint32_t level /* [in] */, uint8_t **buffer /* [out] [ref] */); /************************************************************//** * * NetUserSetInfo * * @brief Set User Information * * @param[in] server_name The server name to connect to * @param[in] user_name The name of the user that is going to be modified * @param[in] level The level defining the requested USER_INFO_X structure * @param[in] buffer The buffer containing a USER_INFO_X structure * @param[out] parm_err The returned parameter error number if any * @return NET_API_STATUS * * example user/user_setinfo.c ***************************************************************/ NET_API_STATUS NetUserSetInfo(const char * server_name /* [in] */, const char * user_name /* [in] */, uint32_t level /* [in] */, uint8_t *buffer /* [in] [ref] */, uint32_t *parm_err /* [out] [ref] */); /************************************************************//** * * NetUserModalsGet * * @brief Get SAM domain and password information * * @param[in] server_name The server name to connect to * @param[in] level The level defining which USER_MODALS_INFO_X buffer to query * @param[out] buffer The returned USER_MODALS_INFO_X buffer * @return NET_API_STATUS * * example user/user_modalsget.c ***************************************************************/ NET_API_STATUS NetUserModalsGet(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t **buffer /* [out] [ref] */); /************************************************************//** * * NetUserModalsSet * * @brief Set SAM domain and password information * * @param[in] server_name The server name to connect to * @param[in] level The level defining which USER_MODALS_INFO_X buffer to query * @param[out] buffer The buffer conntaing a USER_MODALS_INFO_X structure * @param[out] parm_err The returned parameter error number if any * @return NET_API_STATUS * * example user/user_modalsset.c ***************************************************************/ NET_API_STATUS NetUserModalsSet(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t *buffer /* [in] [ref] */, uint32_t *parm_err /* [out] [ref] */); /************************************************************//** * * NetQueryDisplayInformation * * @brief Enumerate accounts on a server * * @param[in] server_name The server name to connect to * @param[in] level The enumeration level used for the query * @param[in] idx The index to start the the display enumeration at * @param[in] entries_requested The number of entries requested * @param[in] prefmaxlen The requested maximal buffer size * @param[out] entries_read The number of returned entries * @param[out] buffer The returned display information buffer * @return NET_API_STATUS * * example user/user_dispinfo.c ***************************************************************/ NET_API_STATUS NetQueryDisplayInformation(const char * server_name /* [in] [unique] */, uint32_t level /* [in] */, uint32_t idx /* [in] */, uint32_t entries_requested /* [in] */, uint32_t prefmaxlen /* [in] */, uint32_t *entries_read /* [out] [ref] */, void **buffer /* [out] [noprint,ref] */); /************************************************************//** * * NetGroupAdd * * @brief Create Domain Group * * @param[in] server_name The server name to connect to * @param[in] level The level used for the new group creation * @param[in] buf The buffer containing the group structure * @param[out] parm_err The returned parameter error number if any * @return NET_API_STATUS * * example group/group_add.c ***************************************************************/ NET_API_STATUS NetGroupAdd(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t *buf /* [in] [ref] */, uint32_t *parm_err /* [out] [ref] */); /************************************************************//** * * NetGroupDel * * @brief Delete Domain Group * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to be deleted * @return NET_API_STATUS * * example group/group_del.c ***************************************************************/ NET_API_STATUS NetGroupDel(const char * server_name /* [in] */, const char * group_name /* [in] */); /************************************************************//** * * NetGroupEnum * * @brief Enumerate groups on a server * * @param[in] server_name The server name to connect to * @param[in] level The enumeration level used for the query (Currently only * level 0 is supported) * @param[out] buffer The returned enumeration buffer * @param[in] prefmaxlen The requested maximal buffer size * @param[out] entries_read The number of returned entries * @param[out] total_entries The number of total entries * @param[in,out] resume_handle A handle passed in and returned for resuming * operations * @return NET_API_STATUS * * example group/group_enum.c ***************************************************************/ NET_API_STATUS NetGroupEnum(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t **buffer /* [out] [ref] */, uint32_t prefmaxlen /* [in] */, uint32_t *entries_read /* [out] [ref] */, uint32_t *total_entries /* [out] [ref] */, uint32_t *resume_handle /* [in,out] [ref] */); /************************************************************//** * * NetGroupSetInfo * * @brief Set Domain Group Information * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to be modified * @param[in] level The level defining the structure type in buf * @param[in] buf The buffer containing a GROUP_INFO_X structure * @param[out] parm_err The returned parameter error number if any * @return NET_API_STATUS * * example group/group_setinfo.c ***************************************************************/ NET_API_STATUS NetGroupSetInfo(const char * server_name /* [in] */, const char * group_name /* [in] */, uint32_t level /* [in] */, uint8_t *buf /* [in] [ref] */, uint32_t *parm_err /* [out] [ref] */); /************************************************************//** * * NetGroupGetInfo * * @brief Get Domain Group Information * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to be queried * @param[in] level The level defining the requested GROUP_INFO_X structure * @param[out] buf The buffer containing a GROUP_INFO_X structure * @return NET_API_STATUS * * example group/group_getinfo.c ***************************************************************/ NET_API_STATUS NetGroupGetInfo(const char * server_name /* [in] */, const char * group_name /* [in] */, uint32_t level /* [in] */, uint8_t **buf /* [out] [ref] */); /************************************************************//** * * NetGroupAddUser * * @brief Add existing User to existing Domain Group * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to be modified * @param[in] user_name The name of the user that is going to be added to the * group * @return NET_API_STATUS * * example group/group_adduser.c ***************************************************************/ NET_API_STATUS NetGroupAddUser(const char * server_name /* [in] */, const char * group_name /* [in] */, const char * user_name /* [in] */); /************************************************************//** * * NetGroupDelUser * * @brief Remove User from Domain Group * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to be modified * @param[in] user_name The name of the user that is going to be removed from * the group * @return NET_API_STATUS * * example group/group_deluser.c ***************************************************************/ NET_API_STATUS NetGroupDelUser(const char * server_name /* [in] */, const char * group_name /* [in] */, const char * user_name /* [in] */); /************************************************************//** * * NetGroupGetUsers * * @brief Get Users for a group on a server * * @param[in] server_name The server name to connect to * @param[in] group_name The group name to enumerate users for * @param[in] level The enumeration level used for the query * @param[out] buffer The returned enumeration buffer * @param[in] prefmaxlen The requested maximal buffer size * @param[out] entries_read The number of returned entries * @param[out] total_entries The number of total entries * @param[in,out] resume_handle A handle passed in and returned for resuming * operations * @return NET_API_STATUS * * example group/group_getusers.c ***************************************************************/ NET_API_STATUS NetGroupGetUsers(const char * server_name /* [in] */, const char * group_name /* [in] */, uint32_t level /* [in] */, uint8_t **buffer /* [out] [ref] */, uint32_t prefmaxlen /* [in] */, uint32_t *entries_read /* [out] [ref] */, uint32_t *total_entries /* [out] [ref] */, uint32_t *resume_handle /* [in,out] [ref] */); /************************************************************//** * * NetLocalGroupAdd * * @brief Create Local Group * * @param[in] server_name The server name to connect to * @param[in] level The level used for the new group creation * @param[in] buf The buffer containing the group structure * @param[out] parm_err The returned parameter error number if any * @return NET_API_STATUS * * example localgroup/localgroup_add.c ***************************************************************/ NET_API_STATUS NetLocalGroupAdd(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t *buf /* [in] [ref] */, uint32_t *parm_err /* [out] [ref] */); /************************************************************//** * * NetLocalGroupDel * * @brief Delete Local Group * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to be deleted * @return NET_API_STATUS * * example localgroup/localgroup_del.c ***************************************************************/ NET_API_STATUS NetLocalGroupDel(const char * server_name /* [in] */, const char * group_name /* [in] */); /************************************************************//** * * NetLocalGroupGetInfo * * @brief Get Local Group Information * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to be queried * @param[in] level The level defining the requested LOCALGROUP_INFO_X structure * @param[out] buf The buffer containing a LOCALGROUP_INFO_X structure * @return NET_API_STATUS * * example localgroup/localgroup_getinfo.c ***************************************************************/ NET_API_STATUS NetLocalGroupGetInfo(const char * server_name /* [in] */, const char * group_name /* [in] */, uint32_t level /* [in] */, uint8_t **buf /* [out] [ref] */); /************************************************************//** * * NetLocalGroupSetInfo * * @brief Set Local Group Information * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to be modified * @param[in] level The level defining the requested LOCALGROUP_INFO_X structure * @param[in] buf The buffer containing a LOCALGROUP_INFO_X structure * @param[out] parm_err The returned parameter error number if any * @return NET_API_STATUS * * example localgroup/localgroup_setinfo.c ***************************************************************/ NET_API_STATUS NetLocalGroupSetInfo(const char * server_name /* [in] */, const char * group_name /* [in] */, uint32_t level /* [in] */, uint8_t *buf /* [in] [ref] */, uint32_t *parm_err /* [out] [ref] */); /************************************************************//** * * NetLocalGroupEnum * * @brief Enumerate local groups on a server * * @param[in] server_name The server name to connect to * @param[in] level The enumeration level used for the query (Currently only * level 0 is supported) * @param[out] buffer The returned enumeration buffer * @param[in] prefmaxlen The requested maximal buffer size * @param[out] entries_read The number of returned entries * @param[out] total_entries The number of total entries * @param[in,out] resume_handle A handle passed in and returned for resuming * operations * @return NET_API_STATUS * * example localgroup/localgroup_enum.c ***************************************************************/ NET_API_STATUS NetLocalGroupEnum(const char * server_name /* [in] */, uint32_t level /* [in] */, uint8_t **buffer /* [out] [ref] */, uint32_t prefmaxlen /* [in] */, uint32_t *entries_read /* [out] [ref] */, uint32_t *total_entries /* [out] [ref] */, uint32_t *resume_handle /* [in,out] [ref] */); /************************************************************//** * * NetLocalGroupAddMembers * * @brief Add Members to a Local Group * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to modified * @param[in] level The level defining the LOCALGROUP_MEMBERS_INFO_X structure * @param[in] buffer The buffer containing a LOCALGROUP_MEMBERS_INFO_X structure * @param[in] total_entries The number of LOCALGROUP_MEMBERS_INFO_X entries in * the buffer * @return NET_API_STATUS * * example localgroup/localgroup_addmembers.c ***************************************************************/ NET_API_STATUS NetLocalGroupAddMembers(const char * server_name /* [in] */, const char * group_name /* [in] */, uint32_t level /* [in] */, uint8_t *buffer /* [in] [ref] */, uint32_t total_entries /* [in] */); /************************************************************//** * * NetLocalGroupDelMembers * * @brief Delete Members from a Local Group * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to modified * @param[in] level The level defining the LOCALGROUP_MEMBERS_INFO_X structure * @param[in] buffer The buffer containing a LOCALGROUP_MEMBERS_INFO_X structure * @param[in] total_entries The number of LOCALGROUP_MEMBERS_INFO_X entries in * the buffer * @return NET_API_STATUS * * example localgroup/localgroup_delmembers.c ***************************************************************/ NET_API_STATUS NetLocalGroupDelMembers(const char * server_name /* [in] */, const char * group_name /* [in] */, uint32_t level /* [in] */, uint8_t *buffer /* [in] [ref] */, uint32_t total_entries /* [in] */); /************************************************************//** * * NetLocalGroupGetMembers * * @brief Enumerate Members in a local group * * @param[in] server_name The server name to connect to * @param[in] local_group_name The localgroup that is going to be queried * @param[in] level The level defining the LOCALGROUP_MEMBERS_INFO_X structure * @param[out] buffer The buffer containing a LOCALGROUP_MEMBERS_INFO_X * structure * @param[in] prefmaxlen The requested maximal buffer size * @param[out] entries_read The number of LOCALGROUP_MEMBERS_INFO_X entries in the buffer * @param[out] total_entries The total number of LOCALGROUP_MEMBERS_INFO_X entries for that group * @param[in,out] resume_handle A handle passed in and returned for resuming * operations * @return NET_API_STATUS * * example localgroup/localgroup_getmembers.c ***************************************************************/ NET_API_STATUS NetLocalGroupGetMembers(const char * server_name /* [in] */, const char * local_group_name /* [in] */, uint32_t level /* [in] */, uint8_t **buffer /* [out] [ref] */, uint32_t prefmaxlen /* [in] */, uint32_t *entries_read /* [out] [ref] */, uint32_t *total_entries /* [out] [ref] */, uint32_t *resume_handle /* [in,out] [ref] */); /************************************************************//** * * NetLocalGroupSetMembers * * @brief Set Members in a Local Group * * @param[in] server_name The server name to connect to * @param[in] group_name The name of the group that is going to modified * @param[in] level The level defining the LOCALGROUP_MEMBERS_INFO_X structure * @param[in] buffer The buffer containing a LOCALGROUP_MEMBERS_INFO_X structure * @param[in] total_entries The number of LOCALGROUP_MEMBERS_INFO_X entries in * the buffer * @return NET_API_STATUS * * example localgroup/localgroup_setmembers.c ***************************************************************/ NET_API_STATUS NetLocalGroupSetMembers(const char * server_name /* [in] */, const char * group_name /* [in] */, uint32_t level /* [in] */, uint8_t *buffer /* [in] [ref] */, uint32_t total_entries /* [in] */); /************************************************************//** * * NetRemoteTOD * * @brief Query remote Time of Day * * @param[in] server_name The server name to connect to * @param[out] buf The buffer containing a TIME_OF_DAY_INFO structure * @return NET_API_STATUS * * example server/remote_tod.c ***************************************************************/ NET_API_STATUS NetRemoteTOD(const char * server_name /* [in] */, uint8_t **buf /* [out] [ref] */); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* __LIB_NETAPI_H__ */