2 Unix SMB/CIFS implementation.
4 Winbind client asynchronous API, utility functions
6 Copyright (C) Gerald (Jerry) Carter 2007-2008
9 This library is free software; you can redistribute it and/or
10 modify it under the terms of the GNU Lesser General Public
11 License as published by the Free Software Foundation; either
12 version 3 of the License, or (at your option) any later version.
14 This library is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Library General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 /* Required Headers */
26 #include "libwbclient.h"
27 #include "../winbind_client.h"
29 /** @brief Ping winbindd to see if the daemon is running
35 struct winbindd_request request
;
36 struct winbindd_response response
;
38 /* Initialize request */
41 ZERO_STRUCT(response
);
43 return wbcRequestResponse(WINBINDD_PING
, &request
, &response
);
46 static void wbcInterfaceDetailsDestructor(void *ptr
)
48 struct wbcInterfaceDetails
*i
= (struct wbcInterfaceDetails
*)ptr
;
49 free(i
->winbind_version
);
50 free(i
->netbios_name
);
51 free(i
->netbios_domain
);
56 * @brief Query useful information about the winbind service
58 * @param *_details pointer to hold the struct wbcInterfaceDetails
63 wbcErr
wbcInterfaceDetails(struct wbcInterfaceDetails
**_details
)
65 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
66 struct wbcInterfaceDetails
*info
;
67 struct wbcDomainInfo
*domain
= NULL
;
68 struct winbindd_request request
;
69 struct winbindd_response response
;
71 /* Initialize request */
74 ZERO_STRUCT(response
);
76 info
= (struct wbcInterfaceDetails
*)wbcAllocateMemory(
77 1, sizeof(struct wbcInterfaceDetails
),
78 wbcInterfaceDetailsDestructor
);
79 BAIL_ON_PTR_ERROR(info
, wbc_status
);
81 /* first the interface version */
82 wbc_status
= wbcRequestResponse(WINBINDD_INTERFACE_VERSION
, NULL
, &response
);
83 BAIL_ON_WBC_ERROR(wbc_status
);
84 info
->interface_version
= response
.data
.interface_version
;
86 /* then the samba version and the winbind separator */
87 wbc_status
= wbcRequestResponse(WINBINDD_INFO
, NULL
, &response
);
88 BAIL_ON_WBC_ERROR(wbc_status
);
90 info
->winbind_version
= strdup(response
.data
.info
.samba_version
);
91 BAIL_ON_PTR_ERROR(info
->winbind_version
, wbc_status
);
92 info
->winbind_separator
= response
.data
.info
.winbind_separator
;
94 /* then the local netbios name */
95 wbc_status
= wbcRequestResponse(WINBINDD_NETBIOS_NAME
, NULL
, &response
);
96 BAIL_ON_WBC_ERROR(wbc_status
);
98 info
->netbios_name
= strdup(response
.data
.netbios_name
);
99 BAIL_ON_PTR_ERROR(info
->netbios_name
, wbc_status
);
101 /* then the local workgroup name */
102 wbc_status
= wbcRequestResponse(WINBINDD_DOMAIN_NAME
, NULL
, &response
);
103 BAIL_ON_WBC_ERROR(wbc_status
);
105 info
->netbios_domain
= strdup(response
.data
.domain_name
);
106 BAIL_ON_PTR_ERROR(info
->netbios_domain
, wbc_status
);
108 wbc_status
= wbcDomainInfo(info
->netbios_domain
, &domain
);
109 if (wbc_status
== WBC_ERR_DOMAIN_NOT_FOUND
) {
110 /* maybe it's a standalone server */
112 wbc_status
= WBC_ERR_SUCCESS
;
114 BAIL_ON_WBC_ERROR(wbc_status
);
118 info
->dns_domain
= strdup(domain
->dns_name
);
119 wbcFreeMemory(domain
);
120 BAIL_ON_PTR_ERROR(info
->dns_domain
, wbc_status
);
122 info
->dns_domain
= NULL
;
128 wbc_status
= WBC_ERR_SUCCESS
;
135 static void wbcDomainInfoDestructor(void *ptr
)
137 struct wbcDomainInfo
*i
= (struct wbcDomainInfo
*)ptr
;
142 /** @brief Lookup the current status of a trusted domain, sync wrapper
144 * @param domain Domain to query
145 * @param *dinfo Pointer to returned struct wbcDomainInfo
150 wbcErr
wbcDomainInfo(const char *domain
, struct wbcDomainInfo
**dinfo
)
152 struct winbindd_request request
;
153 struct winbindd_response response
;
154 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
155 struct wbcDomainInfo
*info
= NULL
;
157 if (!domain
|| !dinfo
) {
158 wbc_status
= WBC_ERR_INVALID_PARAM
;
159 BAIL_ON_WBC_ERROR(wbc_status
);
162 /* Initialize request */
164 ZERO_STRUCT(request
);
165 ZERO_STRUCT(response
);
167 strncpy(request
.domain_name
, domain
,
168 sizeof(request
.domain_name
)-1);
170 wbc_status
= wbcRequestResponse(WINBINDD_DOMAIN_INFO
,
173 BAIL_ON_WBC_ERROR(wbc_status
);
175 info
= (struct wbcDomainInfo
*)wbcAllocateMemory(
176 1, sizeof(struct wbcDomainInfo
), wbcDomainInfoDestructor
);
177 BAIL_ON_PTR_ERROR(info
, wbc_status
);
179 info
->short_name
= strdup(response
.data
.domain_info
.name
);
180 BAIL_ON_PTR_ERROR(info
->short_name
, wbc_status
);
182 info
->dns_name
= strdup(response
.data
.domain_info
.alt_name
);
183 BAIL_ON_PTR_ERROR(info
->dns_name
, wbc_status
);
185 wbc_status
= wbcStringToSid(response
.data
.domain_info
.sid
,
187 BAIL_ON_WBC_ERROR(wbc_status
);
189 if (response
.data
.domain_info
.native_mode
)
190 info
->domain_flags
|= WBC_DOMINFO_DOMAIN_NATIVE
;
191 if (response
.data
.domain_info
.active_directory
)
192 info
->domain_flags
|= WBC_DOMINFO_DOMAIN_AD
;
193 if (response
.data
.domain_info
.primary
)
194 info
->domain_flags
|= WBC_DOMINFO_DOMAIN_PRIMARY
;
199 wbc_status
= WBC_ERR_SUCCESS
;
206 /* Get the list of current DCs */
207 wbcErr
wbcDcInfo(const char *domain
, size_t *num_dcs
,
208 const char ***dc_names
, const char ***dc_ips
)
210 struct winbindd_request request
;
211 struct winbindd_response response
;
212 const char **names
= NULL
;
213 const char **ips
= NULL
;
214 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
219 /* Initialise request */
221 ZERO_STRUCT(request
);
222 ZERO_STRUCT(response
);
224 if (domain
!= NULL
) {
225 strncpy(request
.domain_name
, domain
,
226 sizeof(request
.domain_name
) - 1);
229 wbc_status
= wbcRequestResponse(WINBINDD_DC_INFO
,
230 &request
, &response
);
231 BAIL_ON_WBC_ERROR(wbc_status
);
233 names
= wbcAllocateStringArray(response
.data
.num_entries
);
234 BAIL_ON_PTR_ERROR(names
, wbc_status
);
236 ips
= wbcAllocateStringArray(response
.data
.num_entries
);
237 BAIL_ON_PTR_ERROR(ips
, wbc_status
);
239 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
241 p
= (char *)response
.extra_data
.data
;
243 if (response
.length
< (sizeof(struct winbindd_response
)+1)) {
247 extra_len
= response
.length
- sizeof(struct winbindd_response
);
249 if (p
[extra_len
-1] != '\0') {
253 for (i
=0; i
<response
.data
.num_entries
; i
++) {
260 names
[i
] = strndup(p
, q
-p
);
261 BAIL_ON_PTR_ERROR(names
[i
], wbc_status
);
268 ips
[i
] = strndup(p
, q
-p
);
269 BAIL_ON_PTR_ERROR(ips
[i
], wbc_status
);
276 wbc_status
= WBC_ERR_SUCCESS
;
278 if (response
.extra_data
.data
)
279 free(response
.extra_data
.data
);
281 if (WBC_ERROR_IS_OK(wbc_status
)) {
282 *num_dcs
= response
.data
.num_entries
;
288 wbcFreeMemory(names
);
293 /* Resolve a NetbiosName via WINS */
294 wbcErr
wbcResolveWinsByName(const char *name
, char **ip
)
296 struct winbindd_request request
;
297 struct winbindd_response response
;
298 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
301 ZERO_STRUCT(request
);
302 ZERO_STRUCT(response
);
306 strncpy(request
.data
.winsreq
, name
,
307 sizeof(request
.data
.winsreq
)-1);
309 wbc_status
= wbcRequestResponse(WINBINDD_WINS_BYNAME
,
312 BAIL_ON_WBC_ERROR(wbc_status
);
314 /* Display response */
316 ipaddr
= wbcStrDup(response
.data
.winsresp
);
317 BAIL_ON_PTR_ERROR(ipaddr
, wbc_status
);
320 wbc_status
= WBC_ERR_SUCCESS
;
326 /* Resolve an IP address via WINS into a NetbiosName */
327 wbcErr
wbcResolveWinsByIP(const char *ip
, char **name
)
329 struct winbindd_request request
;
330 struct winbindd_response response
;
331 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
334 ZERO_STRUCT(request
);
335 ZERO_STRUCT(response
);
339 strncpy(request
.data
.winsreq
, ip
,
340 sizeof(request
.data
.winsreq
)-1);
342 wbc_status
= wbcRequestResponse(WINBINDD_WINS_BYIP
,
345 BAIL_ON_WBC_ERROR(wbc_status
);
347 /* Display response */
349 name_str
= wbcStrDup(response
.data
.winsresp
);
350 BAIL_ON_PTR_ERROR(name_str
, wbc_status
);
353 wbc_status
= WBC_ERR_SUCCESS
;
362 static wbcErr
process_domain_info_string(struct wbcDomainInfo
*info
,
365 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
372 if ((s
= strchr(r
, '\\')) == NULL
) {
373 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
374 BAIL_ON_WBC_ERROR(wbc_status
);
379 info
->short_name
= strdup(r
);
380 BAIL_ON_PTR_ERROR(info
->short_name
, wbc_status
);
385 if ((s
= strchr(r
, '\\')) == NULL
) {
386 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
387 BAIL_ON_WBC_ERROR(wbc_status
);
392 info
->dns_name
= strdup(r
);
393 BAIL_ON_PTR_ERROR(info
->dns_name
, wbc_status
);
397 if ((s
= strchr(r
, '\\')) == NULL
) {
398 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
399 BAIL_ON_WBC_ERROR(wbc_status
);
404 wbc_status
= wbcStringToSid(r
, &info
->sid
);
405 BAIL_ON_WBC_ERROR(wbc_status
);
409 if ((s
= strchr(r
, '\\')) == NULL
) {
410 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
411 BAIL_ON_WBC_ERROR(wbc_status
);
416 if (strcmp(r
, "None") == 0) {
417 info
->trust_type
= WBC_DOMINFO_TRUSTTYPE_NONE
;
418 } else if (strcmp(r
, "External") == 0) {
419 info
->trust_type
= WBC_DOMINFO_TRUSTTYPE_EXTERNAL
;
420 } else if (strcmp(r
, "Forest") == 0) {
421 info
->trust_type
= WBC_DOMINFO_TRUSTTYPE_FOREST
;
422 } else if (strcmp(r
, "In Forest") == 0) {
423 info
->trust_type
= WBC_DOMINFO_TRUSTTYPE_IN_FOREST
;
425 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
426 BAIL_ON_WBC_ERROR(wbc_status
);
431 if ((s
= strchr(r
, '\\')) == NULL
) {
432 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
433 BAIL_ON_WBC_ERROR(wbc_status
);
438 if (strcmp(r
, "Yes") == 0) {
439 info
->trust_flags
|= WBC_DOMINFO_TRUST_TRANSITIVE
;
444 if ((s
= strchr(r
, '\\')) == NULL
) {
445 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
446 BAIL_ON_WBC_ERROR(wbc_status
);
451 if (strcmp(r
, "Yes") == 0) {
452 info
->trust_flags
|= WBC_DOMINFO_TRUST_INCOMING
;
457 if ((s
= strchr(r
, '\\')) == NULL
) {
458 wbc_status
= WBC_ERR_INVALID_RESPONSE
;
459 BAIL_ON_WBC_ERROR(wbc_status
);
464 if (strcmp(r
, "Yes") == 0) {
465 info
->trust_flags
|= WBC_DOMINFO_TRUST_OUTGOING
;
468 /* Online/Offline status */
470 if ( strcmp(r
, "Offline") == 0) {
471 info
->domain_flags
|= WBC_DOMINFO_DOMAIN_OFFLINE
;
474 wbc_status
= WBC_ERR_SUCCESS
;
480 static void wbcDomainInfoListDestructor(void *ptr
)
482 struct wbcDomainInfo
*i
= (struct wbcDomainInfo
*)ptr
;
484 while (i
->short_name
!= NULL
) {
491 /* Enumerate the domain trusts known by Winbind */
492 wbcErr
wbcListTrusts(struct wbcDomainInfo
**domains
, size_t *num_domains
)
494 struct winbindd_response response
;
495 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
497 char *extra_data
= NULL
;
498 struct wbcDomainInfo
*d_list
= NULL
;
504 ZERO_STRUCT(response
);
508 wbc_status
= wbcRequestResponse(WINBINDD_LIST_TRUSTDOM
,
511 BAIL_ON_WBC_ERROR(wbc_status
);
513 /* Decode the response */
515 p
= (char *)response
.extra_data
.data
;
517 if ((p
== NULL
) || (strlen(p
) == 0)) {
518 /* We should always at least get back our
521 wbc_status
= WBC_ERR_DOMAIN_NOT_FOUND
;
522 BAIL_ON_WBC_ERROR(wbc_status
);
525 d_list
= (struct wbcDomainInfo
*)wbcAllocateMemory(
526 response
.data
.num_entries
+ 1,sizeof(struct wbcDomainInfo
),
527 wbcDomainInfoListDestructor
);
528 BAIL_ON_PTR_ERROR(d_list
, wbc_status
);
530 extra_data
= strdup((char*)response
.extra_data
.data
);
531 BAIL_ON_PTR_ERROR(extra_data
, wbc_status
);
535 /* Outer loop processes the list of domain information */
537 for (i
=0; i
<response
.data
.num_entries
&& p
; i
++) {
538 char *next
= strchr(p
, '\n');
545 wbc_status
= process_domain_info_string(&d_list
[i
], p
);
546 BAIL_ON_WBC_ERROR(wbc_status
);
556 winbindd_free_response(&response
);
557 wbcFreeMemory(d_list
);
562 static void wbcDomainControllerInfoDestructor(void *ptr
)
564 struct wbcDomainControllerInfo
*i
=
565 (struct wbcDomainControllerInfo
*)ptr
;
569 /* Enumerate the domain trusts known by Winbind */
570 wbcErr
wbcLookupDomainController(const char *domain
,
572 struct wbcDomainControllerInfo
**dc_info
)
574 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
575 struct winbindd_request request
;
576 struct winbindd_response response
;
577 struct wbcDomainControllerInfo
*dc
= NULL
;
579 /* validate input params */
581 if (!domain
|| !dc_info
) {
582 wbc_status
= WBC_ERR_INVALID_PARAM
;
583 BAIL_ON_WBC_ERROR(wbc_status
);
586 ZERO_STRUCT(request
);
587 ZERO_STRUCT(response
);
589 strncpy(request
.data
.dsgetdcname
.domain_name
, domain
,
590 sizeof(request
.data
.dsgetdcname
.domain_name
)-1);
592 request
.flags
= flags
;
594 dc
= (struct wbcDomainControllerInfo
*)wbcAllocateMemory(
595 1, sizeof(struct wbcDomainControllerInfo
),
596 wbcDomainControllerInfoDestructor
);
597 BAIL_ON_PTR_ERROR(dc
, wbc_status
);
601 wbc_status
= wbcRequestResponse(WINBINDD_DSGETDCNAME
,
604 BAIL_ON_WBC_ERROR(wbc_status
);
606 dc
->dc_name
= strdup(response
.data
.dsgetdcname
.dc_unc
);
607 BAIL_ON_PTR_ERROR(dc
->dc_name
, wbc_status
);
617 static void wbcDomainControllerInfoExDestructor(void *ptr
)
619 struct wbcDomainControllerInfoEx
*i
=
620 (struct wbcDomainControllerInfoEx
*)ptr
;
621 free(discard_const_p(char, i
->dc_unc
));
622 free(discard_const_p(char, i
->dc_address
));
623 free(discard_const_p(char, i
->domain_guid
));
624 free(discard_const_p(char, i
->domain_name
));
625 free(discard_const_p(char, i
->forest_name
));
626 free(discard_const_p(char, i
->dc_site_name
));
627 free(discard_const_p(char, i
->client_site_name
));
630 static wbcErr
wbc_create_domain_controller_info_ex(const struct winbindd_response
*resp
,
631 struct wbcDomainControllerInfoEx
**_i
)
633 wbcErr wbc_status
= WBC_ERR_SUCCESS
;
634 struct wbcDomainControllerInfoEx
*i
;
637 i
= (struct wbcDomainControllerInfoEx
*)wbcAllocateMemory(
638 1, sizeof(struct wbcDomainControllerInfoEx
),
639 wbcDomainControllerInfoExDestructor
);
640 BAIL_ON_PTR_ERROR(i
, wbc_status
);
642 i
->dc_unc
= strdup(resp
->data
.dsgetdcname
.dc_unc
);
643 BAIL_ON_PTR_ERROR(i
->dc_unc
, wbc_status
);
645 i
->dc_address
= strdup(resp
->data
.dsgetdcname
.dc_address
);
646 BAIL_ON_PTR_ERROR(i
->dc_address
, wbc_status
);
648 i
->dc_address_type
= resp
->data
.dsgetdcname
.dc_address_type
;
650 wbc_status
= wbcStringToGuid(resp
->data
.dsgetdcname
.domain_guid
, &guid
);
651 if (WBC_ERROR_IS_OK(wbc_status
)) {
652 i
->domain_guid
= (struct wbcGuid
*)malloc(
653 sizeof(struct wbcGuid
));
654 BAIL_ON_PTR_ERROR(i
->domain_guid
, wbc_status
);
656 *i
->domain_guid
= guid
;
659 i
->domain_name
= strdup(resp
->data
.dsgetdcname
.domain_name
);
660 BAIL_ON_PTR_ERROR(i
->domain_name
, wbc_status
);
662 if (resp
->data
.dsgetdcname
.forest_name
[0] != '\0') {
663 i
->forest_name
= strdup(resp
->data
.dsgetdcname
.forest_name
);
664 BAIL_ON_PTR_ERROR(i
->forest_name
, wbc_status
);
667 i
->dc_flags
= resp
->data
.dsgetdcname
.dc_flags
;
669 if (resp
->data
.dsgetdcname
.dc_site_name
[0] != '\0') {
670 i
->dc_site_name
= strdup(resp
->data
.dsgetdcname
.dc_site_name
);
671 BAIL_ON_PTR_ERROR(i
->dc_site_name
, wbc_status
);
674 if (resp
->data
.dsgetdcname
.client_site_name
[0] != '\0') {
675 i
->client_site_name
= strdup(
676 resp
->data
.dsgetdcname
.client_site_name
);
677 BAIL_ON_PTR_ERROR(i
->client_site_name
, wbc_status
);
690 /* Get extended domain controller information */
691 wbcErr
wbcLookupDomainControllerEx(const char *domain
,
692 struct wbcGuid
*guid
,
695 struct wbcDomainControllerInfoEx
**dc_info
)
697 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
698 struct winbindd_request request
;
699 struct winbindd_response response
;
701 /* validate input params */
703 if (!domain
|| !dc_info
) {
704 wbc_status
= WBC_ERR_INVALID_PARAM
;
705 BAIL_ON_WBC_ERROR(wbc_status
);
708 ZERO_STRUCT(request
);
709 ZERO_STRUCT(response
);
711 request
.data
.dsgetdcname
.flags
= flags
;
713 strncpy(request
.data
.dsgetdcname
.domain_name
, domain
,
714 sizeof(request
.data
.dsgetdcname
.domain_name
)-1);
717 strncpy(request
.data
.dsgetdcname
.site_name
, site
,
718 sizeof(request
.data
.dsgetdcname
.site_name
)-1);
724 wbc_status
= wbcGuidToString(guid
, &str
);
725 BAIL_ON_WBC_ERROR(wbc_status
);
727 strncpy(request
.data
.dsgetdcname
.domain_guid
, str
,
728 sizeof(request
.data
.dsgetdcname
.domain_guid
)-1);
735 wbc_status
= wbcRequestResponse(WINBINDD_DSGETDCNAME
,
738 BAIL_ON_WBC_ERROR(wbc_status
);
741 wbc_status
= wbc_create_domain_controller_info_ex(&response
,
743 BAIL_ON_WBC_ERROR(wbc_status
);
746 wbc_status
= WBC_ERR_SUCCESS
;
751 static void wbcNamedBlobDestructor(void *ptr
)
753 struct wbcNamedBlob
*b
= (struct wbcNamedBlob
*)ptr
;
755 while (b
->name
!= NULL
) {
756 free(discard_const_p(char, b
->name
));
762 /* Initialize a named blob and add to list of blobs */
763 wbcErr
wbcAddNamedBlob(size_t *num_blobs
,
764 struct wbcNamedBlob
**pblobs
,
770 wbcErr wbc_status
= WBC_ERR_UNKNOWN_FAILURE
;
771 struct wbcNamedBlob
*blobs
, *blob
;
774 return WBC_ERR_INVALID_PARAM
;
778 * Overallocate the b->name==NULL terminator for
779 * wbcNamedBlobDestructor
781 blobs
= (struct wbcNamedBlob
*)wbcAllocateMemory(
782 *num_blobs
+ 2, sizeof(struct wbcNamedBlob
),
783 wbcNamedBlobDestructor
);
786 return WBC_ERR_NO_MEMORY
;
789 if (*pblobs
!= NULL
) {
790 struct wbcNamedBlob
*old
= *pblobs
;
791 memcpy(blobs
, old
, sizeof(struct wbcNamedBlob
) * (*num_blobs
));
792 if (*num_blobs
!= 0) {
793 /* end indicator for wbcNamedBlobDestructor */
800 blob
= &blobs
[*num_blobs
];
802 blob
->name
= strdup(name
);
803 BAIL_ON_PTR_ERROR(blob
->name
, wbc_status
);
806 blob
->blob
.length
= length
;
807 blob
->blob
.data
= (uint8_t *)malloc(length
);
808 BAIL_ON_PTR_ERROR(blob
->blob
.data
, wbc_status
);
809 memcpy(blob
->blob
.data
, data
, length
);
815 wbc_status
= WBC_ERR_SUCCESS
;
817 wbcFreeMemory(blobs
);