2 * @file sipe-lync-autodiscover.c
6 * Copyright (C) 2016 SIPE Project <http://sipe.sourceforge.net/>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program 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
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * Specification references:
25 * - [MS-OCDISCWS]: https://msdn.microsoft.com/en-us/library/hh623245.aspx
26 * - Understanding Autodiscover in Lync Server 2013
27 * https://technet.microsoft.com/en-us/library/jj945654.aspx
34 #include "sipe-common.h"
35 #include "sipe-backend.h"
36 #include "sipe-core.h"
37 #include "sipe-core-private.h"
38 #include "sipe-http.h"
39 #include "sipe-lync-autodiscover.h"
40 #include "sipe-utils.h"
42 #include "sipe-webticket.h"
45 #define LYNC_AUTODISCOVER_ACCEPT_HEADER \
46 "Accept: application/vnd.microsoft.rtc.autodiscover+xml;v=1\r\n"
48 struct lync_autodiscover_request
{
49 sipe_lync_autodiscover_callback
*cb
;
51 gpointer id
; /* != NULL for active request */
52 struct sipe_http_request
*request
;
53 struct sipe_svc_session
*session
;
54 const gchar
*protocol
;
60 struct sipe_lync_autodiscover
{
61 GSList
*pending_requests
;
64 /* Use "lar" inside the code fragment */
65 #define FOR_ALL_REQUESTS_WITH_SAME_ID(code) \
67 GSList *entry = sipe_private->lync_autodiscover->pending_requests; \
69 struct lync_autodiscover_request *lar = entry->data; \
70 entry = entry->next; \
71 if (lar->id == id) { \
77 static void sipe_lync_autodiscover_request_free(struct sipe_core_private
*sipe_private
,
78 struct lync_autodiscover_request
*request
)
80 struct sipe_lync_autodiscover
*sla
= sipe_private
->lync_autodiscover
;
82 sla
->pending_requests
= g_slist_remove(sla
->pending_requests
, request
);
85 sipe_http_request_cancel(request
->request
);
87 /* Callback: aborted */
88 (*request
->cb
)(sipe_private
, NULL
, request
->cb_data
);
89 sipe_svc_session_close(request
->session
);
94 static void sipe_lync_autodiscover_cb(struct sipe_core_private
*sipe_private
,
98 gpointer callback_data
);
99 static void lync_request(struct sipe_core_private
*sipe_private
,
100 struct lync_autodiscover_request
*request
,
102 const gchar
*headers
)
104 request
->request
= sipe_http_request_get(sipe_private
,
106 headers
? headers
: LYNC_AUTODISCOVER_ACCEPT_HEADER
,
107 sipe_lync_autodiscover_cb
,
111 static GSList
*sipe_lync_autodiscover_add(GSList
*servers
,
112 const sipe_xml
*node
,
115 const sipe_xml
*child
= sipe_xml_child(node
, name
);
116 const gchar
*fqdn
= sipe_xml_attribute(child
, "fqdn");
117 guint port
= sipe_xml_int_attribute(child
, "port", 0);
119 /* Add new entry to head of list */
120 if (fqdn
&& (port
!= 0)) {
121 struct sipe_lync_autodiscover_data
*lync_data
= g_new0(struct sipe_lync_autodiscover_data
, 1);
122 lync_data
->server
= g_strdup(fqdn
);
123 lync_data
->port
= port
;
124 servers
= g_slist_prepend(servers
, lync_data
);
130 GSList
*sipe_lync_autodiscover_pop(GSList
*servers
)
133 struct sipe_lync_autodiscover_data
*lync_data
= servers
->data
;
134 servers
= g_slist_remove(servers
, lync_data
);
137 g_free((gchar
*) lync_data
->server
);
145 static void sipe_lync_autodiscover_queue_request(struct sipe_core_private
*sipe_private
,
146 struct lync_autodiscover_request
*request
);
147 static void sipe_lync_autodiscover_parse(struct sipe_core_private
*sipe_private
,
148 struct lync_autodiscover_request
*request
,
151 sipe_xml
*xml
= sipe_xml_parse(body
, strlen(body
));
152 const sipe_xml
*node
;
153 gboolean next
= TRUE
;
155 /* Root: resources exposed by this server */
156 for (node
= sipe_xml_child(xml
, "Root/Link");
158 node
= sipe_xml_twin(node
)) {
159 const gchar
*token
= sipe_xml_attribute(node
, "token");
160 const gchar
*uri
= sipe_xml_attribute(node
, "href");
164 if (sipe_strcase_equal(token
, "Redirect")) {
165 SIPE_DEBUG_INFO("sipe_lync_autodiscover_parse: redirect to %s",
167 lync_request(sipe_private
, request
, uri
, NULL
);
172 } else if (sipe_strcase_equal(token
, "User")) {
173 SIPE_DEBUG_INFO("sipe_lync_autodiscover_parse: user %s",
176 /* remember URI for authentication failure */
177 request
->uri
= g_strdup(uri
);
179 lync_request(sipe_private
, request
, uri
, NULL
);
184 SIPE_DEBUG_INFO("sipe_lync_autodiscover_parse: unknown token %s",
189 /* User: topology information of the user’s home server */
190 if ((node
= sipe_xml_child(xml
, "User")) != NULL
) {
191 gpointer id
= request
->id
;
193 /* Active request? */
197 /* List is reversed, i.e. internal will be tried first */
198 servers
= g_slist_prepend(NULL
, NULL
);
199 servers
= sipe_lync_autodiscover_add(servers
,
201 "SipClientExternalAccess");
202 servers
= sipe_lync_autodiscover_add(servers
,
204 "SipClientInternalAccess");
206 /* Callback takes ownership of servers list */
207 (*request
->cb
)(sipe_private
, servers
, request
->cb_data
);
209 /* We're done with requests for this callback */
210 FOR_ALL_REQUESTS_WITH_SAME_ID( \
217 /* Request completed */
219 sipe_lync_autodiscover_request_free(sipe_private
, request
);
220 /* request is invalid */
226 sipe_lync_autodiscover_queue_request(sipe_private
, request
);
229 static void sipe_lync_autodiscover_webticket(struct sipe_core_private
*sipe_private
,
230 SIPE_UNUSED_PARAMETER
const gchar
*base_uri
,
231 const gchar
*auth_uri
,
232 const gchar
*wsse_security
,
233 SIPE_UNUSED_PARAMETER
const gchar
*failure_msg
,
234 gpointer callback_data
)
236 struct lync_autodiscover_request
*request
= callback_data
;
239 /* Extract SAML Assertion from WSSE Security XML text */
241 ((saml
= sipe_xml_extract_raw(wsse_security
,
244 gchar
*base64
= g_base64_encode((const guchar
*) saml
,
246 gchar
*headers
= g_strdup_printf(LYNC_AUTODISCOVER_ACCEPT_HEADER
247 "X-MS-WebTicket: opaque=%s\r\n",
251 SIPE_DEBUG_INFO("sipe_lync_autodiscover_webticket: got ticket for Auth URI %s",
255 lync_request(sipe_private
, request
, auth_uri
, headers
);
259 sipe_lync_autodiscover_queue_request(sipe_private
, request
);
262 static void sipe_lync_autodiscover_cb(struct sipe_core_private
*sipe_private
,
266 gpointer callback_data
)
268 struct lync_autodiscover_request
*request
= callback_data
;
269 const gchar
*type
= sipe_utils_nameval_find(headers
, "Content-Type");
270 gchar
*uri
= request
->uri
;
272 request
->request
= NULL
;
276 case SIPE_HTTP_STATUS_OK
:
277 /* only accept Autodiscover XML responses */
278 if (body
&& g_str_has_prefix(type
, "application/vnd.microsoft.rtc.autodiscover+xml"))
279 sipe_lync_autodiscover_parse(sipe_private
, request
, body
);
281 sipe_lync_autodiscover_queue_request(sipe_private
, request
);
284 case SIPE_HTTP_STATUS_FAILED
:
287 /* check for authentication failure */
288 const gchar
*webticket_uri
= sipe_utils_nameval_find(headers
,
289 "X-MS-WebTicketURL");
291 if (!(webticket_uri
&&
292 sipe_webticket_request_with_auth(sipe_private
,
296 sipe_lync_autodiscover_webticket
,
298 sipe_lync_autodiscover_queue_request(sipe_private
, request
);
300 sipe_lync_autodiscover_queue_request(sipe_private
, request
);
304 case SIPE_HTTP_STATUS_ABORTED
:
305 /* we are not allowed to generate new requests */
306 sipe_lync_autodiscover_request_free(sipe_private
, request
);
310 sipe_lync_autodiscover_queue_request(sipe_private
, request
);
317 /* Proceed to next method for request */
318 static void sipe_lync_autodiscover_request(struct sipe_core_private
*sipe_private
,
319 struct lync_autodiscover_request
*request
)
321 gpointer id
= request
->id
;
323 /* Active request? */
325 static const gchar
*methods
[] = {
326 "%s://LyncDiscoverInternal.%s/?sipuri=%s",
327 "%s://LyncDiscover.%s/?sipuri=%s",
331 request
->is_pending
= TRUE
;
336 request
->method
= methods
;
338 if (*request
->method
) {
339 gchar
*uri
= g_strdup_printf(*request
->method
,
341 SIPE_CORE_PUBLIC
->sip_domain
,
342 sipe_private
->username
);
344 SIPE_DEBUG_INFO("sipe_lync_autodiscover_request: trying '%s'", uri
);
346 lync_request(sipe_private
, request
, uri
, NULL
);
352 /* Count entries with the same request ID */
353 FOR_ALL_REQUESTS_WITH_SAME_ID( \
359 * This is the last pending request for this
360 * ID, i.e. autodiscover has failed. Create
361 * empty server list and return it.
363 GSList
*servers
= g_slist_prepend(NULL
, NULL
);
365 /* All methods tried, indicate failure to caller */
366 SIPE_DEBUG_INFO_NOFORMAT("sipe_lync_autodiscover_request: no more methods to try!");
368 /* Callback takes ownership of servers list */
369 (*request
->cb
)(sipe_private
, servers
, request
->cb_data
);
372 /* Request completed */
374 sipe_lync_autodiscover_request_free(sipe_private
, request
);
375 /* request is invalid */
378 /* Inactive request, callback already NULL */
379 sipe_lync_autodiscover_request_free(sipe_private
, request
);
380 /* request is invalid */
384 /* Proceed to next method for all requests */
385 static void sipe_lync_autodiscover_queue_request(struct sipe_core_private
*sipe_private
,
386 struct lync_autodiscover_request
*request
)
388 gpointer id
= request
->id
;
390 /* This request is ready to proceed to next method */
391 request
->is_pending
= FALSE
;
393 /* Is any request for the same ID still pending? */
394 FOR_ALL_REQUESTS_WITH_SAME_ID( \
395 if (lar
->is_pending
) \
399 SIPE_DEBUG_INFO_NOFORMAT("sipe_lync_autodiscover_queue_request: proceed in lockstep");
401 /* No, proceed to next method for all requests */
402 FOR_ALL_REQUESTS_WITH_SAME_ID( \
403 sipe_lync_autodiscover_request(sipe_private
, \
408 static gpointer
sipe_lync_autodiscover_create(struct sipe_core_private
*sipe_private
,
410 const gchar
*protocol
,
411 sipe_lync_autodiscover_callback
*callback
,
412 gpointer callback_data
)
414 struct sipe_lync_autodiscover
*sla
= sipe_private
->lync_autodiscover
;
415 struct lync_autodiscover_request
*request
= g_new0(struct lync_autodiscover_request
, 1);
417 /* use address of first request structure as unique ID */
421 request
->protocol
= protocol
;
422 request
->cb
= callback
;
423 request
->cb_data
= callback_data
;
425 request
->session
= sipe_svc_session_start();
427 sla
->pending_requests
= g_slist_prepend(sla
->pending_requests
,
430 sipe_lync_autodiscover_request(sipe_private
, request
);
435 void sipe_lync_autodiscover_start(struct sipe_core_private
*sipe_private
,
436 sipe_lync_autodiscover_callback
*callback
,
437 gpointer callback_data
)
441 #define CREATE(protocol) \
442 id = sipe_lync_autodiscover_create(sipe_private, \
451 void sipe_lync_autodiscover_init(struct sipe_core_private
*sipe_private
)
453 struct sipe_lync_autodiscover
*sla
= g_new0(struct sipe_lync_autodiscover
, 1);
455 sipe_private
->lync_autodiscover
= sla
;
458 void sipe_lync_autodiscover_free(struct sipe_core_private
*sipe_private
)
460 struct sipe_lync_autodiscover
*sla
= sipe_private
->lync_autodiscover
;
462 while (sla
->pending_requests
)
463 sipe_lync_autodiscover_request_free(sipe_private
,
464 sla
->pending_requests
->data
);
467 sipe_private
->lync_autodiscover
= NULL
;