2 Unix SMB/CIFS implementation.
6 Copyright (C) Gerald (Jerry) Carter 2007
8 This library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Lesser General Public
10 License as published by the Free Software Foundation; either
11 version 3 of the License, or (at your option) any later version.
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Library General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 /* Define error types */
31 * @brief Status codes returned from wbc functions
35 WBC_ERR_SUCCESS = 0, /**< Successful completion **/
36 WBC_ERR_NOT_IMPLEMENTED,/**< Function not implemented **/
37 WBC_ERR_UNKNOWN_FAILURE,/**< General failure **/
38 WBC_ERR_NO_MEMORY, /**< Memory allocation error **/
39 WBC_ERR_INVALID_SID, /**< Invalid SID format **/
40 WBC_ERR_INVALID_PARAM, /**< An Invalid parameter was supplied **/
41 WBC_ERR_WINBIND_NOT_AVAILABLE, /**< Winbind daemon is not available **/
42 WBC_ERR_DOMAIN_NOT_FOUND, /**< Domain is not trusted or cannot be found **/
43 WBC_ERR_INVALID_RESPONSE, /**< Winbind returned an invalid response **/
44 WBC_ERR_NSS_ERROR, /**< NSS_STATUS error **/
45 WBC_ERR_AUTH_ERROR, /**< Authentication failed **/
46 WBC_ERR_UNKNOWN_USER, /**< User account cannot be found */
47 WBC_ERR_UNKNOWN_GROUP, /**< Group account cannot be found */
48 WBC_ERR_PWD_CHANGE_FAILED /**< Password Change has failed */
51 typedef enum _wbcErrType wbcErr;
53 #define WBC_ERROR_IS_OK(x) ((x) == WBC_ERR_SUCCESS)
55 const char *wbcErrorString(wbcErr error);
58 * @brief Some useful details about the wbclient library
60 * 0.1: Initial version
61 * 0.2: Added wbcRemoveUidMapping()
62 * Added wbcRemoveGidMapping()
63 * 0.3: Added wbcGetpwsid()
64 * Added wbcGetSidAliases()
65 * 0.4: Added wbcSidTypeString()
67 #define WBCLIENT_MAJOR_VERSION 0
68 #define WBCLIENT_MINOR_VERSION 4
69 #define WBCLIENT_VENDOR_VERSION "Samba libwbclient"
70 struct wbcLibraryDetails {
71 uint16_t major_version;
72 uint16_t minor_version;
73 const char *vendor_version;
77 * @brief Some useful details about the running winbindd
80 struct wbcInterfaceDetails {
81 uint32_t interface_version;
82 const char *winbind_version;
83 char winbind_separator;
84 const char *netbios_name;
85 const char *netbios_domain;
86 const char *dns_domain;
90 * Data types used by the Winbind Client API
93 #ifndef WBC_MAXSUBAUTHS
94 #define WBC_MAXSUBAUTHS 15 /* max sub authorities in a SID */
98 * @brief Windows Security Identifier
102 struct wbcDomainSid {
106 uint32_t sub_auths[WBC_MAXSUBAUTHS];
110 * @brief Security Identifier type
114 WBC_SID_NAME_USE_NONE=0,
116 WBC_SID_NAME_DOM_GRP=2,
117 WBC_SID_NAME_DOMAIN=3,
118 WBC_SID_NAME_ALIAS=4,
119 WBC_SID_NAME_WKN_GRP=5,
120 WBC_SID_NAME_DELETED=6,
121 WBC_SID_NAME_INVALID=7,
122 WBC_SID_NAME_UNKNOWN=8,
123 WBC_SID_NAME_COMPUTER=9
127 * @brief Security Identifier with attributes
130 struct wbcSidWithAttr {
131 struct wbcDomainSid sid;
135 /* wbcSidWithAttr->attributes */
137 #define WBC_SID_ATTR_GROUP_MANDATORY 0x00000001
138 #define WBC_SID_ATTR_GROUP_ENABLED_BY_DEFAULT 0x00000002
139 #define WBC_SID_ATTR_GROUP_ENABLED 0x00000004
140 #define WBC_SID_ATTR_GROUP_OWNER 0x00000008
141 #define WBC_SID_ATTR_GROUP_USEFOR_DENY_ONLY 0x00000010
142 #define WBC_SID_ATTR_GROUP_RESOURCE 0x20000000
143 #define WBC_SID_ATTR_GROUP_LOGON_ID 0xC0000000
146 * @brief Windows GUID
153 uint16_t time_hi_and_version;
154 uint8_t clock_seq[2];
159 * @brief Domain Information
162 struct wbcDomainInfo {
165 struct wbcDomainSid sid;
166 uint32_t domain_flags;
167 uint32_t trust_flags;
171 /* wbcDomainInfo->domain_flags */
173 #define WBC_DOMINFO_DOMAIN_UNKNOWN 0x00000000
174 #define WBC_DOMINFO_DOMAIN_NATIVE 0x00000001
175 #define WBC_DOMINFO_DOMAIN_AD 0x00000002
176 #define WBC_DOMINFO_DOMAIN_PRIMARY 0x00000004
177 #define WBC_DOMINFO_DOMAIN_OFFLINE 0x00000008
179 /* wbcDomainInfo->trust_flags */
181 #define WBC_DOMINFO_TRUST_TRANSITIVE 0x00000001
182 #define WBC_DOMINFO_TRUST_INCOMING 0x00000002
183 #define WBC_DOMINFO_TRUST_OUTGOING 0x00000004
185 /* wbcDomainInfo->trust_type */
187 #define WBC_DOMINFO_TRUSTTYPE_NONE 0x00000000
188 #define WBC_DOMINFO_TRUSTTYPE_FOREST 0x00000001
189 #define WBC_DOMINFO_TRUSTTYPE_IN_FOREST 0x00000002
190 #define WBC_DOMINFO_TRUSTTYPE_EXTERNAL 0x00000003
194 * @brief Auth User Parameters
197 struct wbcAuthUserParams {
198 const char *account_name;
199 const char *domain_name;
200 const char *workstation_name;
204 uint32_t parameter_control;
206 enum wbcAuthUserLevel {
207 WBC_AUTH_USER_LEVEL_PLAIN = 1,
208 WBC_AUTH_USER_LEVEL_HASH = 2,
209 WBC_AUTH_USER_LEVEL_RESPONSE = 3
212 const char *plaintext;
218 uint8_t challenge[8];
228 * @brief Generic Blob
240 struct wbcNamedBlob {
247 * @brief Logon User Parameters
250 struct wbcLogonUserParams {
251 const char *username;
252 const char *password;
254 struct wbcNamedBlob *blobs;
258 * @brief ChangePassword Parameters
261 struct wbcChangePasswordParams {
262 const char *account_name;
263 const char *domain_name;
267 enum wbcChangePasswordLevel {
268 WBC_CHANGE_PASSWORD_LEVEL_PLAIN = 1,
269 WBC_CHANGE_PASSWORD_LEVEL_RESPONSE = 2
273 const char *plaintext;
275 uint32_t old_nt_hash_enc_length;
276 uint8_t *old_nt_hash_enc_data;
277 uint32_t old_lm_hash_enc_length;
278 uint8_t *old_lm_hash_enc_data;
282 const char *plaintext;
292 /* wbcAuthUserParams->parameter_control */
294 #define WBC_MSV1_0_CLEARTEXT_PASSWORD_ALLOWED 0x00000002
295 #define WBC_MSV1_0_UPDATE_LOGON_STATISTICS 0x00000004
296 #define WBC_MSV1_0_RETURN_USER_PARAMETERS 0x00000008
297 #define WBC_MSV1_0_ALLOW_SERVER_TRUST_ACCOUNT 0x00000020
298 #define WBC_MSV1_0_RETURN_PROFILE_PATH 0x00000200
299 #define WBC_MSV1_0_ALLOW_WORKSTATION_TRUST_ACCOUNT 0x00000800
301 /* wbcAuthUserParams->flags */
303 #define WBC_AUTH_PARAM_FLAGS_INTERACTIVE_LOGON 0x00000001
306 * @brief Auth User Information
308 * Some of the strings are maybe NULL
311 struct wbcAuthUserInfo {
315 char *user_principal;
318 char *dns_domain_name;
321 uint8_t user_session_key[16];
322 uint8_t lm_session_key[8];
324 uint16_t logon_count;
325 uint16_t bad_password_count;
328 uint64_t logoff_time;
329 uint64_t kickoff_time;
330 uint64_t pass_last_set_time;
331 uint64_t pass_can_change_time;
332 uint64_t pass_must_change_time;
337 char *home_directory;
341 * the 1st one is the account sid
342 * the 2nd one is the primary_group sid
343 * followed by the rest of the groups
346 struct wbcSidWithAttr *sids;
350 * @brief Logon User Information
352 * Some of the strings are maybe NULL
355 struct wbcLogonUserInfo {
356 struct wbcAuthUserInfo *info;
358 struct wbcNamedBlob *blobs;
361 /* wbcAuthUserInfo->user_flags */
363 #define WBC_AUTH_USER_INFO_GUEST 0x00000001
364 #define WBC_AUTH_USER_INFO_NOENCRYPTION 0x00000002
365 #define WBC_AUTH_USER_INFO_CACHED_ACCOUNT 0x00000004
366 #define WBC_AUTH_USER_INFO_USED_LM_PASSWORD 0x00000008
367 #define WBC_AUTH_USER_INFO_EXTRA_SIDS 0x00000020
368 #define WBC_AUTH_USER_INFO_SUBAUTH_SESSION_KEY 0x00000040
369 #define WBC_AUTH_USER_INFO_SERVER_TRUST_ACCOUNT 0x00000080
370 #define WBC_AUTH_USER_INFO_NTLMV2_ENABLED 0x00000100
371 #define WBC_AUTH_USER_INFO_RESOURCE_GROUPS 0x00000200
372 #define WBC_AUTH_USER_INFO_PROFILE_PATH_RETURNED 0x00000400
373 #define WBC_AUTH_USER_INFO_GRACE_LOGON 0x01000000
375 /* wbcAuthUserInfo->acct_flags */
377 #define WBC_ACB_DISABLED 0x00000001 /* 1 User account disabled */
378 #define WBC_ACB_HOMDIRREQ 0x00000002 /* 1 Home directory required */
379 #define WBC_ACB_PWNOTREQ 0x00000004 /* 1 User password not required */
380 #define WBC_ACB_TEMPDUP 0x00000008 /* 1 Temporary duplicate account */
381 #define WBC_ACB_NORMAL 0x00000010 /* 1 Normal user account */
382 #define WBC_ACB_MNS 0x00000020 /* 1 MNS logon user account */
383 #define WBC_ACB_DOMTRUST 0x00000040 /* 1 Interdomain trust account */
384 #define WBC_ACB_WSTRUST 0x00000080 /* 1 Workstation trust account */
385 #define WBC_ACB_SVRTRUST 0x00000100 /* 1 Server trust account */
386 #define WBC_ACB_PWNOEXP 0x00000200 /* 1 User password does not expire */
387 #define WBC_ACB_AUTOLOCK 0x00000400 /* 1 Account auto locked */
388 #define WBC_ACB_ENC_TXT_PWD_ALLOWED 0x00000800 /* 1 Encryped text password is allowed */
389 #define WBC_ACB_SMARTCARD_REQUIRED 0x00001000 /* 1 Smart Card required */
390 #define WBC_ACB_TRUSTED_FOR_DELEGATION 0x00002000 /* 1 Trusted for Delegation */
391 #define WBC_ACB_NOT_DELEGATED 0x00004000 /* 1 Not delegated */
392 #define WBC_ACB_USE_DES_KEY_ONLY 0x00008000 /* 1 Use DES key only */
393 #define WBC_ACB_DONT_REQUIRE_PREAUTH 0x00010000 /* 1 Preauth not required */
394 #define WBC_ACB_PW_EXPIRED 0x00020000 /* 1 Password Expired */
395 #define WBC_ACB_NO_AUTH_DATA_REQD 0x00080000 /* 1 = No authorization data required */
397 struct wbcAuthErrorInfo {
401 char *display_string;
405 * @brief User Password Policy Information
408 /* wbcUserPasswordPolicyInfo->password_properties */
410 #define WBC_DOMAIN_PASSWORD_COMPLEX 0x00000001
411 #define WBC_DOMAIN_PASSWORD_NO_ANON_CHANGE 0x00000002
412 #define WBC_DOMAIN_PASSWORD_NO_CLEAR_CHANGE 0x00000004
413 #define WBC_DOMAIN_PASSWORD_LOCKOUT_ADMINS 0x00000008
414 #define WBC_DOMAIN_PASSWORD_STORE_CLEARTEXT 0x00000010
415 #define WBC_DOMAIN_REFUSE_PASSWORD_CHANGE 0x00000020
417 struct wbcUserPasswordPolicyInfo {
418 uint32_t min_length_password;
419 uint32_t password_history;
420 uint32_t password_properties;
422 uint64_t min_passwordage;
426 * @brief Change Password Reject Reason
429 enum wbcPasswordChangeRejectReason {
430 WBC_PWD_CHANGE_NO_ERROR=0,
431 WBC_PWD_CHANGE_PASSWORD_TOO_SHORT=1,
432 WBC_PWD_CHANGE_PWD_IN_HISTORY=2,
433 WBC_PWD_CHANGE_USERNAME_IN_PASSWORD=3,
434 WBC_PWD_CHANGE_FULLNAME_IN_PASSWORD=4,
435 WBC_PWD_CHANGE_NOT_COMPLEX=5,
436 WBC_PWD_CHANGE_MACHINE_NOT_DEFAULT=6,
437 WBC_PWD_CHANGE_FAILED_BY_FILTER=7,
438 WBC_PWD_CHANGE_PASSWORD_TOO_LONG=8
441 /* Note: this defines exist for compatibility reasons with existing code */
442 #define WBC_PWD_CHANGE_REJECT_OTHER WBC_PWD_CHANGE_NO_ERROR
443 #define WBC_PWD_CHANGE_REJECT_TOO_SHORT WBC_PWD_CHANGE_PASSWORD_TOO_SHORT
444 #define WBC_PWD_CHANGE_REJECT_IN_HISTORY WBC_PWD_CHANGE_PWD_IN_HISTORY
445 #define WBC_PWD_CHANGE_REJECT_COMPLEXITY WBC_PWD_CHANGE_NOT_COMPLEX
448 * @brief Logoff User Parameters
451 struct wbcLogoffUserParams {
452 const char *username;
454 struct wbcNamedBlob *blobs;
457 /** @brief Credential cache log-on parameters
461 struct wbcCredentialCacheParams {
462 const char *account_name;
463 const char *domain_name;
464 enum wbcCredentialCacheLevel {
465 WBC_CREDENTIAL_CACHE_LEVEL_NTLMSSP = 1
468 struct wbcNamedBlob *blobs;
472 /** @brief Info returned by credential cache auth
476 struct wbcCredentialCacheInfo {
478 struct wbcNamedBlob *blobs;
482 * DomainControllerInfo struct
484 struct wbcDomainControllerInfo {
489 * DomainControllerInfoEx struct
491 struct wbcDomainControllerInfoEx {
493 const char *dc_address;
494 uint16_t dc_address_type;
495 struct wbcGuid *domain_guid;
496 const char *domain_name;
497 const char *forest_name;
499 const char *dc_site_name;
500 const char *client_site_name;
503 /**********************************************************
505 **********************************************************/
508 * @brief Free library allocated memory
510 * @param * Pointer to free
514 void wbcFreeMemory(void*);
518 * Utility functions for dealing with SIDs
522 * @brief Get a string representation of the SID type
524 * @param type type of the SID
526 * @return string representation of the SID type
528 const char* wbcSidTypeString(enum wbcSidType type);
531 * @brief Convert a binary SID to a character string
533 * @param sid Binary Security Identifier
534 * @param **sid_string Resulting character string
538 wbcErr wbcSidToString(const struct wbcDomainSid *sid,
542 * @brief Convert a character string to a binary SID
544 * @param *sid_string Character string in the form of S-...
545 * @param sid Resulting binary SID
549 wbcErr wbcStringToSid(const char *sid_string,
550 struct wbcDomainSid *sid);
553 * Utility functions for dealing with GUIDs
557 * @brief Convert a binary GUID to a character string
559 * @param guid Binary Guid
560 * @param **guid_string Resulting character string
564 wbcErr wbcGuidToString(const struct wbcGuid *guid,
568 * @brief Convert a character string to a binary GUID
570 * @param *guid_string Character string
571 * @param guid Resulting binary GUID
575 wbcErr wbcStringToGuid(const char *guid_string,
576 struct wbcGuid *guid);
579 * @brief Ping winbindd to see if the daemon is running
583 wbcErr wbcPing(void);
585 wbcErr wbcLibraryDetails(struct wbcLibraryDetails **details);
587 wbcErr wbcInterfaceDetails(struct wbcInterfaceDetails **details);
589 /**********************************************************
590 * Name/SID conversion
591 **********************************************************/
594 * @brief Convert a domain and name to SID
596 * @param dom_name Domain name (possibly "")
597 * @param name User or group name
598 * @param *sid Pointer to the resolved domain SID
599 * @param *name_type Pointer to the SID type
603 wbcErr wbcLookupName(const char *dom_name,
605 struct wbcDomainSid *sid,
606 enum wbcSidType *name_type);
609 * @brief Convert a SID to a domain and name
611 * @param *sid Pointer to the domain SID to be resolved
612 * @param domain Resolved Domain name (possibly "")
613 * @param name Resolved User or group name
614 * @param *name_type Pointer to the resolved SID type
618 wbcErr wbcLookupSid(const struct wbcDomainSid *sid,
621 enum wbcSidType *name_type);
624 * @brief Translate a collection of RIDs within a domain to names
626 wbcErr wbcLookupRids(struct wbcDomainSid *dom_sid,
629 const char **domain_name,
631 enum wbcSidType **types);
634 * @brief Get the groups a user belongs to
636 wbcErr wbcLookupUserSids(const struct wbcDomainSid *user_sid,
637 bool domain_groups_only,
639 struct wbcDomainSid **sids);
642 * @brief Get alias membership for sids
644 wbcErr wbcGetSidAliases(const struct wbcDomainSid *dom_sid,
645 struct wbcDomainSid *sids,
647 uint32_t **alias_rids,
648 uint32_t *num_alias_rids);
653 wbcErr wbcListUsers(const char *domain_name,
655 const char ***users);
658 * @brief Lists Groups
660 wbcErr wbcListGroups(const char *domain_name,
661 uint32_t *num_groups,
662 const char ***groups);
664 wbcErr wbcGetDisplayName(const struct wbcDomainSid *sid,
667 enum wbcSidType *pname_type);
669 /**********************************************************
670 * SID/uid/gid Mappings
671 **********************************************************/
674 * @brief Convert a Windows SID to a Unix uid, allocating an uid if needed
676 * @param *sid Pointer to the domain SID to be resolved
677 * @param *puid Pointer to the resolved uid_t value
682 wbcErr wbcSidToUid(const struct wbcDomainSid *sid,
686 * @brief Convert a Windows SID to a Unix uid if there already is a mapping
688 * @param *sid Pointer to the domain SID to be resolved
689 * @param *puid Pointer to the resolved uid_t value
694 wbcErr wbcQuerySidToUid(const struct wbcDomainSid *sid,
698 * @brief Convert a Unix uid to a Windows SID, allocating a SID if needed
700 * @param uid Unix uid to be resolved
701 * @param *sid Pointer to the resolved domain SID
706 wbcErr wbcUidToSid(uid_t uid,
707 struct wbcDomainSid *sid);
710 * @brief Convert a Unix uid to a Windows SID if there already is a mapping
712 * @param uid Unix uid to be resolved
713 * @param *sid Pointer to the resolved domain SID
718 wbcErr wbcQueryUidToSid(uid_t uid,
719 struct wbcDomainSid *sid);
722 * @brief Convert a Windows SID to a Unix gid, allocating a gid if needed
724 * @param *sid Pointer to the domain SID to be resolved
725 * @param *pgid Pointer to the resolved gid_t value
730 wbcErr wbcSidToGid(const struct wbcDomainSid *sid,
734 * @brief Convert a Windows SID to a Unix gid if there already is a mapping
736 * @param *sid Pointer to the domain SID to be resolved
737 * @param *pgid Pointer to the resolved gid_t value
742 wbcErr wbcQuerySidToGid(const struct wbcDomainSid *sid,
746 * @brief Convert a Unix gid to a Windows SID, allocating a SID if needed
748 * @param gid Unix gid to be resolved
749 * @param *sid Pointer to the resolved domain SID
754 wbcErr wbcGidToSid(gid_t gid,
755 struct wbcDomainSid *sid);
758 * @brief Convert a Unix gid to a Windows SID if there already is a mapping
760 * @param gid Unix gid to be resolved
761 * @param *sid Pointer to the resolved domain SID
766 wbcErr wbcQueryGidToSid(gid_t gid,
767 struct wbcDomainSid *sid);
770 * @brief Obtain a new uid from Winbind
772 * @param *puid *pointer to the allocated uid
776 wbcErr wbcAllocateUid(uid_t *puid);
779 * @brief Obtain a new gid from Winbind
781 * @param *pgid Pointer to the allocated gid
785 wbcErr wbcAllocateGid(gid_t *pgid);
788 * @brief Set an user id mapping
790 * @param uid Uid of the desired mapping.
791 * @param *sid Pointer to the sid of the diresired mapping.
795 wbcErr wbcSetUidMapping(uid_t uid, const struct wbcDomainSid *sid);
798 * @brief Set a group id mapping
800 * @param gid Gid of the desired mapping.
801 * @param *sid Pointer to the sid of the diresired mapping.
805 wbcErr wbcSetGidMapping(gid_t gid, const struct wbcDomainSid *sid);
808 * @brief Remove a user id mapping
810 * @param uid Uid of the mapping to remove.
811 * @param *sid Pointer to the sid of the mapping to remove.
815 wbcErr wbcRemoveUidMapping(uid_t uid, const struct wbcDomainSid *sid);
818 * @brief Remove a group id mapping
820 * @param gid Gid of the mapping to remove.
821 * @param *sid Pointer to the sid of the mapping to remove.
825 wbcErr wbcRemoveGidMapping(gid_t gid, const struct wbcDomainSid *sid);
828 * @brief Set the highwater mark for allocated uids.
830 * @param uid_hwm The new uid highwater mark value
834 wbcErr wbcSetUidHwm(uid_t uid_hwm);
837 * @brief Set the highwater mark for allocated gids.
839 * @param gid_hwm The new gid highwater mark value
843 wbcErr wbcSetGidHwm(gid_t gid_hwm);
845 /**********************************************************
846 * NSS Lookup User/Group details
847 **********************************************************/
850 * @brief Fill in a struct passwd* for a domain user based
853 * @param *name Username to lookup
854 * @param **pwd Pointer to resulting struct passwd* from the query.
858 wbcErr wbcGetpwnam(const char *name, struct passwd **pwd);
861 * @brief Fill in a struct passwd* for a domain user based
864 * @param uid Uid to lookup
865 * @param **pwd Pointer to resulting struct passwd* from the query.
869 wbcErr wbcGetpwuid(uid_t uid, struct passwd **pwd);
872 * @brief Fill in a struct passwd* for a domain user based
875 * @param sid Sid to lookup
876 * @param **pwd Pointer to resulting struct passwd* from the query.
880 wbcErr wbcGetpwsid(struct wbcDomainSid * sid, struct passwd **pwd);
883 * @brief Fill in a struct passwd* for a domain user based
886 * @param *name Username to lookup
887 * @param **grp Pointer to resulting struct group* from the query.
891 wbcErr wbcGetgrnam(const char *name, struct group **grp);
894 * @brief Fill in a struct passwd* for a domain user based
897 * @param gid Uid to lookup
898 * @param **grp Pointer to resulting struct group* from the query.
902 wbcErr wbcGetgrgid(gid_t gid, struct group **grp);
905 * @brief Reset the passwd iterator
909 wbcErr wbcSetpwent(void);
912 * @brief Close the passwd iterator
916 wbcErr wbcEndpwent(void);
919 * @brief Return the next struct passwd* entry from the pwent iterator
921 * @param **pwd Pointer to resulting struct passwd* from the query.
925 wbcErr wbcGetpwent(struct passwd **pwd);
928 * @brief Reset the group iterator
932 wbcErr wbcSetgrent(void);
935 * @brief Close the group iterator
939 wbcErr wbcEndgrent(void);
942 * @brief Return the next struct group* entry from the pwent iterator
944 * @param **grp Pointer to resulting struct group* from the query.
948 wbcErr wbcGetgrent(struct group **grp);
951 * @brief Return the next struct group* entry from the pwent iterator
953 * This is similar to #wbcGetgrent, just that the member list is empty
955 * @param **grp Pointer to resulting struct group* from the query.
959 wbcErr wbcGetgrlist(struct group **grp);
962 * @brief Return the unix group array belonging to the given user
964 * @param *account The given user name
965 * @param *num_groups Number of elements returned in the groups array
966 * @param **_groups Pointer to resulting gid_t array.
970 wbcErr wbcGetGroups(const char *account,
971 uint32_t *num_groups,
975 /**********************************************************
976 * Lookup Domain information
977 **********************************************************/
980 * @brief Lookup the current status of a trusted domain
982 * @param domain Domain to query
983 * @param *info Pointer to returned domain_info struct
987 wbcErr wbcDomainInfo(const char *domain,
988 struct wbcDomainInfo **info);
991 * @brief Enumerate the domain trusts known by Winbind
993 * @param **domains Pointer to the allocated domain list array
994 * @param *num_domains Pointer to number of domains returned
998 wbcErr wbcListTrusts(struct wbcDomainInfo **domains,
999 size_t *num_domains);
1001 /* Flags for wbcLookupDomainController */
1003 #define WBC_LOOKUP_DC_FORCE_REDISCOVERY 0x00000001
1004 #define WBC_LOOKUP_DC_DS_REQUIRED 0x00000010
1005 #define WBC_LOOKUP_DC_DS_PREFERRED 0x00000020
1006 #define WBC_LOOKUP_DC_GC_SERVER_REQUIRED 0x00000040
1007 #define WBC_LOOKUP_DC_PDC_REQUIRED 0x00000080
1008 #define WBC_LOOKUP_DC_BACKGROUND_ONLY 0x00000100
1009 #define WBC_LOOKUP_DC_IP_REQUIRED 0x00000200
1010 #define WBC_LOOKUP_DC_KDC_REQUIRED 0x00000400
1011 #define WBC_LOOKUP_DC_TIMESERV_REQUIRED 0x00000800
1012 #define WBC_LOOKUP_DC_WRITABLE_REQUIRED 0x00001000
1013 #define WBC_LOOKUP_DC_GOOD_TIMESERV_PREFERRED 0x00002000
1014 #define WBC_LOOKUP_DC_AVOID_SELF 0x00004000
1015 #define WBC_LOOKUP_DC_ONLY_LDAP_NEEDED 0x00008000
1016 #define WBC_LOOKUP_DC_IS_FLAT_NAME 0x00010000
1017 #define WBC_LOOKUP_DC_IS_DNS_NAME 0x00020000
1018 #define WBC_LOOKUP_DC_TRY_NEXTCLOSEST_SITE 0x00040000
1019 #define WBC_LOOKUP_DC_DS_6_REQUIRED 0x00080000
1020 #define WBC_LOOKUP_DC_RETURN_DNS_NAME 0x40000000
1021 #define WBC_LOOKUP_DC_RETURN_FLAT_NAME 0x80000000
1024 * @brief Enumerate the domain trusts known by Winbind
1026 * @param domain Name of the domain to query for a DC
1027 * @param flags Bit flags used to control the domain location query
1028 * @param *dc_info Pointer to the returned domain controller information
1032 wbcErr wbcLookupDomainController(const char *domain,
1034 struct wbcDomainControllerInfo **dc_info);
1037 * @brief Get extended domain controller information
1039 * @param domain Name of the domain to query for a DC
1040 * @param guid Guid of the domain to query for a DC
1041 * @param site Site of the domain to query for a DC
1042 * @param flags Bit flags used to control the domain location query
1043 * @param *dc_info Pointer to the returned extended domain controller information
1047 wbcErr wbcLookupDomainControllerEx(const char *domain,
1048 struct wbcGuid *guid,
1051 struct wbcDomainControllerInfoEx **dc_info);
1053 /**********************************************************
1054 * Athenticate functions
1055 **********************************************************/
1058 * @brief Authenticate a username/password pair
1060 * @param username Name of user to authenticate
1061 * @param password Clear text password os user
1065 wbcErr wbcAuthenticateUser(const char *username,
1066 const char *password);
1069 * @brief Authenticate with more detailed information
1071 * @param params Input parameters, WBC_AUTH_USER_LEVEL_HASH
1072 * is not supported yet
1073 * @param info Output details on WBC_ERR_SUCCESS
1074 * @param error Output details on WBC_ERR_AUTH_ERROR
1078 wbcErr wbcAuthenticateUserEx(const struct wbcAuthUserParams *params,
1079 struct wbcAuthUserInfo **info,
1080 struct wbcAuthErrorInfo **error);
1083 * @brief Logon a User
1085 * @param[in] params Pointer to a wbcLogonUserParams structure
1086 * @param[out] info Pointer to a pointer to a wbcLogonUserInfo structure
1087 * @param[out] error Pointer to a pointer to a wbcAuthErrorInfo structure
1088 * @param[out] policy Pointer to a pointer to a wbcUserPasswordPolicyInfo structure
1092 wbcErr wbcLogonUser(const struct wbcLogonUserParams *params,
1093 struct wbcLogonUserInfo **info,
1094 struct wbcAuthErrorInfo **error,
1095 struct wbcUserPasswordPolicyInfo **policy);
1098 * @brief Trigger a logoff notification to Winbind for a specific user
1100 * @param username Name of user to remove from Winbind's list of
1102 * @param uid Uid assigned to the username
1103 * @param ccfilename Absolute path to the Krb5 credentials cache to
1108 wbcErr wbcLogoffUser(const char *username,
1110 const char *ccfilename);
1113 * @brief Trigger an extended logoff notification to Winbind for a specific user
1115 * @param params A wbcLogoffUserParams structure
1116 * @param error User output details on error
1120 wbcErr wbcLogoffUserEx(const struct wbcLogoffUserParams *params,
1121 struct wbcAuthErrorInfo **error);
1124 * @brief Change a password for a user
1126 * @param username Name of user to authenticate
1127 * @param old_password Old clear text password of user
1128 * @param new_password New clear text password of user
1132 wbcErr wbcChangeUserPassword(const char *username,
1133 const char *old_password,
1134 const char *new_password);
1137 * @brief Change a password for a user with more detailed information upon
1140 * @param params Input parameters
1141 * @param error User output details on WBC_ERR_PWD_CHANGE_FAILED
1142 * @param reject_reason New password reject reason on WBC_ERR_PWD_CHANGE_FAILED
1143 * @param policy Password policy output details on WBC_ERR_PWD_CHANGE_FAILED
1147 wbcErr wbcChangeUserPasswordEx(const struct wbcChangePasswordParams *params,
1148 struct wbcAuthErrorInfo **error,
1149 enum wbcPasswordChangeRejectReason *reject_reason,
1150 struct wbcUserPasswordPolicyInfo **policy);
1153 * @brief Authenticate a user with cached credentials
1155 * @param *params Pointer to a wbcCredentialCacheParams structure
1156 * @param **info Pointer to a pointer to a wbcCredentialCacheInfo structure
1157 * @param **error Pointer to a pointer to a wbcAuthErrorInfo structure
1161 wbcErr wbcCredentialCache(struct wbcCredentialCacheParams *params,
1162 struct wbcCredentialCacheInfo **info,
1163 struct wbcAuthErrorInfo **error);
1165 /**********************************************************
1167 **********************************************************/
1170 * @brief Resolve a NetbiosName via WINS
1172 * @param name Name to resolve
1173 * @param *ip Pointer to the ip address string
1177 wbcErr wbcResolveWinsByName(const char *name, char **ip);
1180 * @brief Resolve an IP address via WINS into a NetbiosName
1182 * @param ip The ip address string
1183 * @param *name Pointer to the name
1188 wbcErr wbcResolveWinsByIP(const char *ip, char **name);
1190 /**********************************************************
1191 * Trusted domain functions
1192 **********************************************************/
1195 * @brief Trigger a verification of the trust credentials of a specific domain
1197 * @param *domain The name of the domain.
1198 * @param error Output details on WBC_ERR_AUTH_ERROR
1202 wbcErr wbcCheckTrustCredentials(const char *domain,
1203 struct wbcAuthErrorInfo **error);
1206 * @brief Trigger a change of the trust credentials for a specific domain
1208 * @param *domain The name of the domain.
1209 * @param error Output details on WBC_ERR_AUTH_ERROR
1213 wbcErr wbcChangeTrustCredentials(const char *domain,
1214 struct wbcAuthErrorInfo **error);
1216 /**********************************************************
1218 **********************************************************/
1221 * @brief Initialize a named blob and add to list of blobs
1223 * @param[in,out] num_blobs Pointer to the number of blobs
1224 * @param[in,out] blobs Pointer to an array of blobs
1225 * @param[in] name Name of the new named blob
1226 * @param[in] flags Flags of the new named blob
1227 * @param[in] data Blob data of new blob
1228 * @param[in] length Blob data length of new blob
1232 wbcErr wbcAddNamedBlob(size_t *num_blobs,
1233 struct wbcNamedBlob **blobs,
1239 #endif /* _WBCLIENT_H */