xref: /btstack/src/classic/pbap_client.c (revision d58a1b5f11ada8ddf896c41fff5a35e7f140c37e)
1 /*
2  * Copyright (C) 2014 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #define BTSTACK_FILE__ "pbap_client.c"
39 
40 #include "btstack_config.h"
41 
42 #include <stdint.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45 #include <string.h>
46 
47 #include "hci_cmd.h"
48 #include "btstack_run_loop.h"
49 #include "btstack_debug.h"
50 #include "hci.h"
51 #include "btstack_memory.h"
52 #include "hci_dump.h"
53 #include "l2cap.h"
54 #include "bluetooth_sdp.h"
55 #include "classic/sdp_client_rfcomm.h"
56 #include "btstack_event.h"
57 #include "md5.h"
58 #include "yxml.h"
59 
60 #include "classic/obex.h"
61 #include "classic/obex_iterator.h"
62 #include "classic/goep_client.h"
63 #include "classic/pbap_client.h"
64 
65 // 796135f0-f0c5-11d8-0966- 0800200c9a66
66 static const uint8_t pbap_uuid[] = { 0x79, 0x61, 0x35, 0xf0, 0xf0, 0xc5, 0x11, 0xd8, 0x09, 0x66, 0x08, 0x00, 0x20, 0x0c, 0x9a, 0x66};
67 
68 const char * pbap_phonebook_type     = "x-bt/phonebook";
69 const char * pbap_vcard_listing_type = "x-bt/vcard-listing";
70 const char * pbap_vcard_entry_type   = "x-bt/vcard";
71 
72 const char * pbap_vcard_listing_name = "pb";
73 
74 static uint32_t pbap_supported_features = \
75     PBAP_SUPPORTED_FEATURES_DOWNLOAD |
76     PBAP_SUPPORTED_FEATURES_BROWSING |
77     PBAP_SUPPORTED_FEATURES_DATABASE_IDENTIFIER |
78     PBAP_SUPPORTED_FEATURES_FOLDER_VERSION_COUNTERS |
79     PBAP_SUPPORTED_FEATURES_VCARD_SELECTING |
80     PBAP_SUPPORTED_FEATURES_ENHANCED_MISSED_CALLS |
81     PBAP_SUPPORTED_FEATURES_DEFAULT_CONTACT_IMAGE_FORMAT |
82     PBAP_SUPPORTED_FEATURES_X_BT_UCI_VCARD_PROPERTY |
83     PBAP_SUPPORTED_FEATURES_X_BT_UID_VCARD_PROPERTY |
84     PBAP_SUPPORTED_FEATURES_CONTACT_REFERENCING;
85 
86 typedef enum {
87     PBAP_INIT = 0,
88     PBAP_W4_GOEP_CONNECTION,
89     PBAP_W2_SEND_CONNECT_REQUEST,
90     PBAP_W4_CONNECT_RESPONSE,
91     PBAP_W4_USER_AUTHENTICATION,
92     PBAP_W2_SEND_AUTHENTICATED_CONNECT,
93     PBAP_CONNECT_RESPONSE_RECEIVED,
94     PBAP_CONNECTED,
95     //
96     PBAP_W2_SEND_DISCONNECT_REQUEST,
97     PBAP_W4_DISCONNECT_RESPONSE,
98     //
99     PBAP_W2_PULL_PHONEBOOK,
100     PBAP_W4_PHONEBOOK,
101     PBAP_W2_SET_PATH_ROOT,
102     PBAP_W4_SET_PATH_ROOT_COMPLETE,
103     PBAP_W2_SET_PATH_ELEMENT,
104     PBAP_W4_SET_PATH_ELEMENT_COMPLETE,
105     PBAP_W2_GET_PHONEBOOK_SIZE,
106     PBAP_W4_GET_PHONEBOOK_SIZE_COMPLETE,
107     // - pull vacard liast
108     PBAP_W2_GET_CARD_LIST,
109     PBAP_W4_GET_CARD_LIST_COMPLETE,
110     // - pull vcard entry
111     PBAP_W2_GET_CARD_ENTRY,
112     PBAP_W4_GET_CARD_ENTRY_COMPLETE
113 
114 } pbap_state_t;
115 
116 typedef enum {
117     SRM_DISABLED,
118     SRM_W4_CONFIRM,
119     SRM_ENABLED_BUT_WAITING,
120     SRM_ENABLED
121 } srm_state_t;
122 
123 typedef struct pbap_client {
124     pbap_state_t state;
125     uint16_t  cid;
126     bd_addr_t bd_addr;
127     hci_con_handle_t con_handle;
128     uint8_t   incoming;
129     uint16_t  goep_cid;
130     btstack_packet_handler_t client_handler;
131     int request_number;
132     srm_state_t srm_state;
133     const char * current_folder;
134     const char * phone_number;
135     const char * phonebook_path;
136     const char * vcard_name;
137     uint16_t set_path_offset;
138     /* vcard selector / operator */
139     uint32_t vcard_selector;
140     uint8_t  vcard_selector_operator;
141     uint8_t  vcard_selector_supported;
142     /* abort */
143     uint8_t  abort_operation;
144     /* authentication */
145     uint8_t  authentication_options;
146     uint16_t authentication_nonce[16];
147     const char * authentication_password;
148     /* xml parser */
149     yxml_t  xml_parser;
150     uint8_t xml_buffer[50];
151     /* flow control mode */
152     uint8_t flow_control_enabled;
153     uint8_t flow_next_triggered;
154 } pbap_client_t;
155 
156 static pbap_client_t _pbap_client;
157 static pbap_client_t * pbap_client = &_pbap_client;
158 
159 static void pbap_client_emit_connected_event(pbap_client_t * context, uint8_t status){
160     uint8_t event[15];
161     int pos = 0;
162     event[pos++] = HCI_EVENT_PBAP_META;
163     pos++;  // skip len
164     event[pos++] = PBAP_SUBEVENT_CONNECTION_OPENED;
165     little_endian_store_16(event,pos,context->cid);
166     pos+=2;
167     event[pos++] = status;
168     memcpy(&event[pos], context->bd_addr, 6);
169     pos += 6;
170     little_endian_store_16(event,pos,context->con_handle);
171     pos += 2;
172     event[pos++] = context->incoming;
173     event[1] = pos - 2;
174     if (pos != sizeof(event)) log_error("goep_client_emit_connected_event size %u", pos);
175     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
176 }
177 
178 static void pbap_client_emit_connection_closed_event(pbap_client_t * context){
179     uint8_t event[5];
180     int pos = 0;
181     event[pos++] = HCI_EVENT_PBAP_META;
182     pos++;  // skip len
183     event[pos++] = PBAP_SUBEVENT_CONNECTION_CLOSED;
184     little_endian_store_16(event,pos,context->cid);
185     pos+=2;
186     event[1] = pos - 2;
187     if (pos != sizeof(event)) log_error("pbap_client_emit_connection_closed_event size %u", pos);
188     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
189 }
190 
191 static void pbap_client_emit_operation_complete_event(pbap_client_t * context, uint8_t status){
192     uint8_t event[6];
193     int pos = 0;
194     event[pos++] = HCI_EVENT_PBAP_META;
195     pos++;  // skip len
196     event[pos++] = PBAP_SUBEVENT_OPERATION_COMPLETED;
197     little_endian_store_16(event,pos,context->cid);
198     pos+=2;
199     event[pos++]= status;
200     event[1] = pos - 2;
201     if (pos != sizeof(event)) log_error("pbap_client_emit_can_send_now_event size %u", pos);
202     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
203 }
204 
205 static void pbap_client_emit_phonebook_size_event(pbap_client_t * context, uint8_t status, uint16_t phonebook_size){
206     uint8_t event[8];
207     int pos = 0;
208     event[pos++] = HCI_EVENT_PBAP_META;
209     pos++;  // skip len
210     event[pos++] = PBAP_SUBEVENT_PHONEBOOK_SIZE;
211     little_endian_store_16(event,pos,context->cid);
212     pos+=2;
213     event[pos++] = status;
214     little_endian_store_16(event,pos, phonebook_size);
215     pos+=2;
216     event[1] = pos - 2;
217     if (pos != sizeof(event)) log_error("pbap_client_emit_phonebook_size_event size %u", pos);
218     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
219 }
220 
221 static void pbap_client_emit_authentication_event(pbap_client_t * context, uint8_t options){
222     // split options
223     uint8_t user_id_required = (options & 1) ? 1 : 0;
224     uint8_t full_access      = (options & 2) ? 1 : 0;
225 
226     uint8_t event[7];
227     int pos = 0;
228     event[pos++] = HCI_EVENT_PBAP_META;
229     pos++;  // skip len
230     event[pos++] = PBAP_SUBEVENT_AUTHENTICATION_REQUEST;
231     little_endian_store_16(event,pos,context->cid);
232     pos+=2;
233     event[pos++] = user_id_required;
234     event[pos++] = full_access;
235     if (pos != sizeof(event)) log_error("pbap_client_emit_authentication_event size %u", pos);
236     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
237 }
238 
239 static void pbap_client_emit_card_result_event(pbap_client_t * context, const char * name, const char * handle){
240     uint8_t event[5 + PBAP_MAX_NAME_LEN + PBAP_MAX_HANDLE_LEN];
241     int pos = 0;
242     event[pos++] = HCI_EVENT_PBAP_META;
243     pos++;  // skip len
244     event[pos++] = PBAP_SUBEVENT_CARD_RESULT;
245     little_endian_store_16(event,pos,context->cid);
246     pos+=2;
247     int name_len = btstack_min(PBAP_MAX_NAME_LEN, strlen(name));
248     event[pos++] = name_len;
249     memcpy(&event[pos], name, name_len);
250     pos += name_len;
251     int handle_len = btstack_min(PBAP_MAX_HANDLE_LEN, strlen(handle));
252     event[pos++] = handle_len;
253     memcpy(&event[pos], handle, handle_len);
254     pos += handle_len;
255     event[1] = pos - 2;
256     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
257 }
258 
259 static const uint8_t collon = (uint8_t) ':';
260 
261 static void pbap_handle_can_send_now(void){
262     uint8_t  path_element[20];
263     uint16_t path_element_start;
264     uint16_t path_element_len;
265     uint8_t  application_parameters[PBAP_MAX_PHONE_NUMBER_LEN + 10];
266     uint8_t  challenge_response[36];
267     int i;
268     uint16_t phone_number_len;
269     int done;
270 
271     MD5_CTX md5_ctx;
272 
273     if (pbap_client->abort_operation){
274         pbap_client->abort_operation = 0;
275         pbap_client->state = PBAP_CONNECTED;
276         goep_client_request_create_abort(pbap_client->goep_cid);
277         goep_client_execute(pbap_client->goep_cid);
278         return;
279     }
280 
281     switch (pbap_client->state){
282         case PBAP_W2_SEND_CONNECT_REQUEST:
283             goep_client_request_create_connect(pbap_client->goep_cid, OBEX_VERSION, 0, OBEX_MAX_PACKETLEN_DEFAULT);
284             goep_client_header_add_target(pbap_client->goep_cid, pbap_uuid, 18);
285             // Mandatory if the PSE advertises a PbapSupportedFeatures attribute in its SDP record, else excluded.
286             if (goep_client_get_pbap_supported_features(pbap_client->goep_cid) != PBAP_FEATURES_NOT_PRESENT){
287                 application_parameters[0] = PBAP_APPLICATION_PARAMETER_PBAP_SUPPORTED_FEATURES;
288                 application_parameters[1] = 4;
289                 big_endian_store_32(application_parameters, 2, pbap_supported_features);
290                 goep_client_header_add_application_parameters(pbap_client->goep_cid, &application_parameters[0], 6);
291             }
292             pbap_client->state = PBAP_W4_CONNECT_RESPONSE;
293             goep_client_execute(pbap_client->goep_cid);
294             break;
295         case PBAP_W2_SEND_AUTHENTICATED_CONNECT:
296             goep_client_request_create_connect(pbap_client->goep_cid, OBEX_VERSION, 0, OBEX_MAX_PACKETLEN_DEFAULT);
297             goep_client_header_add_target(pbap_client->goep_cid, pbap_uuid, 16);
298             // setup authentication challenge response
299             i = 0;
300             challenge_response[i++] = 0;  // Tag Digest
301             challenge_response[i++] = 16; // Len
302             // calculate md5
303             MD5_Init(&md5_ctx);
304             MD5_Update(&md5_ctx, pbap_client->authentication_nonce, 16);
305             MD5_Update(&md5_ctx, &collon, 1);
306             MD5_Update(&md5_ctx, pbap_client->authentication_password, strlen(pbap_client->authentication_password));
307             MD5_Final(&challenge_response[i], &md5_ctx);
308             i += 16;
309             challenge_response[i++] = 2;  // Tag Nonce
310             challenge_response[i++] = 16; // Len
311             memcpy(&challenge_response[i], pbap_client->authentication_nonce, 16);
312             i += 16;
313             goep_client_header_add_challenge_response(pbap_client->goep_cid, challenge_response, i);
314             pbap_client->state = PBAP_W4_CONNECT_RESPONSE;
315             goep_client_execute(pbap_client->goep_cid);
316             break;
317         case PBAP_W2_SEND_DISCONNECT_REQUEST:
318             goep_client_request_create_disconnect(pbap_client->goep_cid);
319             pbap_client->state = PBAP_W4_DISCONNECT_RESPONSE;
320             goep_client_execute(pbap_client->goep_cid);
321             return;
322         case PBAP_W2_PULL_PHONEBOOK:
323         case PBAP_W2_GET_PHONEBOOK_SIZE:
324             goep_client_request_create_get(pbap_client->goep_cid);
325             if (pbap_client->request_number == 0){
326                 if (!pbap_client->flow_control_enabled){
327                     goep_client_header_add_srm_enable(pbap_client->goep_cid);
328                     pbap_client->srm_state = SRM_W4_CONFIRM;
329                 }
330                 goep_client_header_add_name(pbap_client->goep_cid, pbap_client->phonebook_path);
331                 goep_client_header_add_type(pbap_client->goep_cid, pbap_phonebook_type);
332                 i = 0;
333                 if (pbap_client->vcard_selector_supported){
334                     // vCard Selector
335                     if (pbap_client->vcard_selector){
336                         application_parameters[i++] = PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR;
337                         application_parameters[i++] = 8;
338                         memset(&application_parameters[i], 0, 4);
339                         i += 4;
340                         big_endian_store_32(application_parameters, i, pbap_client->vcard_selector);
341                         i += 4;
342                     }
343                     // vCard Selector Operator
344                     if (pbap_client->vcard_selector_operator != PBAP_VCARD_SELECTOR_OPERATOR_OR){
345                         application_parameters[i++] = PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR_OPERATOR;
346                         application_parameters[i++] = 1;
347                         application_parameters[i++] = pbap_client->vcard_selector_operator;
348                     }
349                 }
350                 if (pbap_client->state == PBAP_W2_GET_PHONEBOOK_SIZE){
351                     // Regular TLV wih 1-byte len
352                     application_parameters[i++] = PBAP_APPLICATION_PARAMETER_MAX_LIST_COUNT;
353                     application_parameters[i++] = 2;
354                     big_endian_store_16(application_parameters, 2, 0);
355                     i += 2;
356                 }
357                 if (i){
358                     goep_client_header_add_application_parameters(pbap_client->goep_cid, application_parameters, i);
359                 }
360             }
361             if (pbap_client->state == PBAP_W2_GET_PHONEBOOK_SIZE){
362                 // state
363                 pbap_client->state = PBAP_W4_GET_PHONEBOOK_SIZE_COMPLETE;
364             } else {
365                 // state
366                 pbap_client->state = PBAP_W4_PHONEBOOK;
367             }
368             // send packet
369             pbap_client->request_number++;
370             goep_client_execute(pbap_client->goep_cid);
371             break;
372         case PBAP_W2_GET_CARD_LIST:
373             goep_client_request_create_get(pbap_client->goep_cid);
374             if (pbap_client->request_number == 0){
375                 if (!pbap_client->flow_control_enabled){
376                     goep_client_header_add_srm_enable(pbap_client->goep_cid);
377                     pbap_client->srm_state = SRM_W4_CONFIRM;
378                 }
379                 goep_client_header_add_name(pbap_client->goep_cid, pbap_client->phonebook_path);
380                 goep_client_header_add_type(pbap_client->goep_cid, pbap_vcard_listing_type);
381                 i = 0;
382                 if (pbap_client->vcard_selector_supported){
383                     // vCard Selector
384                     if (pbap_client->vcard_selector){
385                         application_parameters[i++] = PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR;
386                         application_parameters[i++] = 8;
387                         memset(&application_parameters[i], 0, 4);
388                         i += 4;
389                         big_endian_store_32(application_parameters, i, pbap_client->vcard_selector);
390                         i += 4;
391                     }
392                     // vCard Selector Operator
393                     if (pbap_client->vcard_selector_operator != PBAP_VCARD_SELECTOR_OPERATOR_OR){
394                         application_parameters[i++] = PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR_OPERATOR;
395                         application_parameters[i++] = 1;
396                         application_parameters[i++] = pbap_client->vcard_selector_operator;
397                     }
398                 }
399                 if (pbap_client->phone_number){
400                     // Search by phpone number
401                     phone_number_len = btstack_min(PBAP_MAX_PHONE_NUMBER_LEN, strlen(pbap_client->phone_number));
402                     application_parameters[i++] = PBAP_APPLICATION_PARAMETER_SEARCH_VALUE;
403                     application_parameters[i++] = phone_number_len;
404                     memcpy(&application_parameters[i], pbap_client->phone_number, phone_number_len);
405                     i += phone_number_len;
406                     application_parameters[i++] = PBAP_APPLICATION_PARAMETER_SEARCH_PROPERTY;
407                     application_parameters[i++] = 1;
408                     application_parameters[i++] = 0x01; // Number
409                 }
410                 if (i){
411                     goep_client_header_add_application_parameters(pbap_client->goep_cid, &application_parameters[0], i);
412                 }
413             }
414             // send packet
415             pbap_client->state = PBAP_W4_GET_CARD_LIST_COMPLETE;
416             pbap_client->request_number++;
417             goep_client_execute(pbap_client->goep_cid);
418             break;
419         case PBAP_W2_GET_CARD_ENTRY:
420             goep_client_request_create_get(pbap_client->goep_cid);
421             if (pbap_client->request_number == 0){
422                 if (!pbap_client->flow_control_enabled){
423                     goep_client_header_add_srm_enable(pbap_client->goep_cid);
424                     pbap_client->srm_state = SRM_W4_CONFIRM;
425                 }
426                 goep_client_header_add_name(pbap_client->goep_cid, pbap_client->vcard_name);
427                 goep_client_header_add_type(pbap_client->goep_cid, pbap_vcard_entry_type);
428                 i = 0;
429                 if (i){
430                     // TODO: support property selector
431                     // TODO: support format
432                     goep_client_header_add_application_parameters(pbap_client->goep_cid, &application_parameters[0], i);
433                 }
434                 pbap_client->state = PBAP_W4_GET_CARD_ENTRY_COMPLETE;
435             }
436             // send packet
437             pbap_client->request_number++;
438             goep_client_execute(pbap_client->goep_cid);
439             break;
440         case PBAP_W2_SET_PATH_ROOT:
441             goep_client_request_create_set_path(pbap_client->goep_cid, 1 << 1); // Don’t create directory
442             goep_client_header_add_name(pbap_client->goep_cid, "");
443             // state
444             pbap_client->state = PBAP_W4_SET_PATH_ROOT_COMPLETE;
445             // send packet
446             goep_client_execute(pbap_client->goep_cid);
447             break;
448         case PBAP_W2_SET_PATH_ELEMENT:
449             // find '/' or '\0'
450             path_element_start = pbap_client->set_path_offset;
451             while ((pbap_client->current_folder[pbap_client->set_path_offset] != '\0') &&
452                 (pbap_client->current_folder[pbap_client->set_path_offset] != '/')){
453                 pbap_client->set_path_offset++;
454             }
455             path_element_len = pbap_client->set_path_offset-path_element_start;
456             memcpy(path_element, &pbap_client->current_folder[path_element_start], path_element_len);
457             path_element[path_element_len] = 0;
458 
459             // skip /
460             if (pbap_client->current_folder[pbap_client->set_path_offset] == '/'){
461                 pbap_client->set_path_offset++;
462             }
463 
464             // done?
465             done = pbap_client->current_folder[pbap_client->set_path_offset] == '\0';
466 
467             // status
468             log_info("Path element '%s', done %u", path_element, done);
469 
470             goep_client_request_create_set_path(pbap_client->goep_cid, 1 << 1); // Don’t create directory
471             goep_client_header_add_name(pbap_client->goep_cid, (const char *) path_element); // next element
472             // state
473             pbap_client->state = PBAP_W4_SET_PATH_ELEMENT_COMPLETE;
474             // send packet
475             goep_client_execute(pbap_client->goep_cid);
476             break;
477         default:
478             break;
479     }
480 }
481 
482 static void pbap_parse_authentication_challenge(pbap_client_t * context, const uint8_t * challenge_data, uint16_t challenge_len){
483     // printf("Challenge:  ");
484     // printf_hexdump(challenge_data, challenge_len);
485     int i;
486     // uint8_t charset_code = 0;
487     for (i=0 ; i<challenge_len ; ){
488         int tag = challenge_data[i];
489         int len = challenge_data[i + 1];
490         i += 2;
491         switch (tag) {
492             case 0:
493                 if (len != 0x10) {
494                     log_error("Invalid OBEX digest len %u", len);
495                     return;
496                 }
497                 memcpy(context->authentication_nonce, &challenge_data[i], 16);
498                 // printf("Nonce: ");
499                 // printf_hexdump(context->authentication_nonce, 16);
500                 break;
501             case 1:
502                 context->authentication_options = challenge_data[i];
503                 // printf("Options %u\n", context->authentication_options);
504                 break;
505             case 2:
506                 // TODO: handle charset
507                 // charset_code = challenge_data[i];
508                 break;
509         }
510         i += len;
511     }
512 }
513 
514 static void pbap_process_srm_headers(pbap_client_t * context, uint8_t *packet, uint16_t size){
515 
516     if (packet[0] != OBEX_RESP_CONTINUE) return;
517 
518     // get SRM and SRMP Headers
519     int srm_value = OBEX_SRM_DISABLE;
520     int srmp_value = OBEX_SRMP_NEXT;
521     obex_iterator_t it;
522     for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(context->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
523         uint8_t hi = obex_iterator_get_hi(&it);
524         uint16_t     data_len = obex_iterator_get_data_len(&it);
525         const uint8_t  * data = obex_iterator_get_data(&it);
526         switch (hi){
527             case OBEX_HEADER_SINGLE_RESPONSE_MODE:
528                 if (data_len != 1) break;
529                 srm_value = *data;
530                 break;
531             case OBEX_HEADER_SINGLE_RESPONSE_MODE_PARAMETER:
532                 if (data_len != 1) break;
533                 srmp_value = *data;
534                 break;
535             default:
536                 break;
537         }
538     }
539 
540     // Update SRM state based on SRM haders
541     switch (context->srm_state){
542         case SRM_W4_CONFIRM:
543             switch (srm_value){
544                 case OBEX_SRM_ENABLE:
545                     switch (srmp_value){
546                         case OBEX_SRMP_WAIT:
547                             context->srm_state = SRM_ENABLED_BUT_WAITING;
548                             break;
549                         default:
550                             context->srm_state = SRM_ENABLED;
551                             break;
552                     }
553                     break;
554                 default:
555                     context->srm_state = SRM_DISABLED;
556                     break;
557             }
558             break;
559         case SRM_ENABLED_BUT_WAITING:
560             switch (srmp_value){
561                 case OBEX_SRMP_WAIT:
562                     context->srm_state = SRM_ENABLED_BUT_WAITING;
563                     break;
564                 default:
565                     context->srm_state = SRM_ENABLED;
566                     break;
567             }
568             break;
569         default:
570             break;
571     }
572     log_info("SRM state %u", context->srm_state);
573 }
574 
575 static void pbap_client_process_vcard_listing(uint8_t *packet, uint16_t size){
576     obex_iterator_t it;
577     for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
578         uint8_t hi = obex_iterator_get_hi(&it);
579         if ((hi == OBEX_HEADER_END_OF_BODY) ||
580             (hi == OBEX_HEADER_BODY)){
581             uint16_t     data_len = obex_iterator_get_data_len(&it);
582             const uint8_t  * data =  obex_iterator_get_data(&it);
583             // now try parsing it
584             yxml_init(&pbap_client->xml_parser, pbap_client->xml_buffer, sizeof(pbap_client->xml_buffer));
585             int card_found = 0;
586             int name_found = 0;
587             int handle_found = 0;
588             char name[PBAP_MAX_NAME_LEN];
589             char handle[PBAP_MAX_HANDLE_LEN];
590             while (data_len--){
591                 yxml_ret_t r = yxml_parse(&pbap_client->xml_parser, *data++);
592                 switch (r){
593                     case YXML_ELEMSTART:
594                         card_found = strcmp("card", pbap_client->xml_parser.elem) == 0;
595                         break;
596                     case YXML_ELEMEND:
597                         if (card_found){
598                             pbap_client_emit_card_result_event(pbap_client, name, handle);
599                         }
600                         card_found = 0;
601                         break;
602                     case YXML_ATTRSTART:
603                         if (!card_found) break;
604                         if (strcmp("name", pbap_client->xml_parser.attr) == 0){
605                             name_found = 1;
606                             name[0]    = 0;
607                             break;
608                         }
609                         if (strcmp("handle", pbap_client->xml_parser.attr) == 0){
610                             handle_found = 1;
611                             handle[0]    = 0;
612                             break;
613                         }
614                         break;
615                     case YXML_ATTRVAL:
616                         if (name_found) {
617                             // "In UTF-8, characters from the U+0000..U+10FFFF range (the UTF-16 accessible range) are encoded using sequences of 1 to 4 octets."
618                             if ((strlen(name) + 4 + 1) >= sizeof(name)) break;
619                             strcat(name, pbap_client->xml_parser.data);
620                             break;
621                         }
622                         if (handle_found) {
623                             // "In UTF-8, characters from the U+0000..U+10FFFF range (the UTF-16 accessible range) are encoded using sequences of 1 to 4 octets."
624                             if ((strlen(handle) + 4 + 1) >= sizeof(handle)) break;
625                             strcat(handle, pbap_client->xml_parser.data);
626                             break;
627                         }
628                         break;
629                     case YXML_ATTREND:
630                         name_found = 0;
631                         handle_found = 0;
632                         break;
633                     default:
634                         break;
635                 }
636             }
637         }
638     }
639 }
640 
641 static void pbap_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
642 
643     UNUSED(channel); // ok: there is no channel
644     UNUSED(size);    // ok: handling own geop events
645 
646     obex_iterator_t it;
647     uint8_t status;
648     int wait_for_user = 0;
649     switch (packet_type){
650         case HCI_EVENT_PACKET:
651             switch (hci_event_packet_get_type(packet)) {
652                 case HCI_EVENT_GOEP_META:
653                     switch (hci_event_goep_meta_get_subevent_code(packet)){
654                         case GOEP_SUBEVENT_CONNECTION_OPENED:
655                             status = goep_subevent_connection_opened_get_status(packet);
656                             pbap_client->con_handle = goep_subevent_connection_opened_get_con_handle(packet);
657                             pbap_client->incoming = goep_subevent_connection_opened_get_incoming(packet);
658                             goep_subevent_connection_opened_get_bd_addr(packet, pbap_client->bd_addr);
659                             if (status){
660                                 log_info("pbap: connection failed %u", status);
661                                 pbap_client->state = PBAP_INIT;
662                                 pbap_client_emit_connected_event(pbap_client, status);
663                             } else {
664                                 log_info("pbap: connection established");
665                                 pbap_client->goep_cid = goep_subevent_connection_opened_get_goep_cid(packet);
666                                 pbap_client->state = PBAP_W2_SEND_CONNECT_REQUEST;
667                                 goep_client_request_can_send_now(pbap_client->goep_cid);
668                             }
669                             break;
670                         case GOEP_SUBEVENT_CONNECTION_CLOSED:
671                             if (pbap_client->state != PBAP_CONNECTED){
672                                 pbap_client_emit_operation_complete_event(pbap_client, OBEX_DISCONNECTED);
673                             }
674                             pbap_client->state = PBAP_INIT;
675                             pbap_client_emit_connection_closed_event(pbap_client);
676                             break;
677                         case GOEP_SUBEVENT_CAN_SEND_NOW:
678                             pbap_handle_can_send_now();
679                             break;
680                     }
681                     break;
682                 default:
683                     break;
684             }
685             break;
686         case GOEP_DATA_PACKET:
687             // TODO: handle chunked data
688             // obex_dump_packet(goep_client_get_request_opcode(pbap_client->goep_cid), packet, size);
689             switch (pbap_client->state){
690                 case PBAP_W4_CONNECT_RESPONSE:
691                     switch (packet[0]){
692                         case OBEX_RESP_SUCCESS:
693                             for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
694                                 uint8_t hi = obex_iterator_get_hi(&it);
695                                 if (hi == OBEX_HEADER_CONNECTION_ID){
696                                     goep_client_set_connection_id(pbap_client->goep_cid, obex_iterator_get_data_32(&it));
697                                 }
698                             }
699                             pbap_client->state = PBAP_CONNECTED;
700                             pbap_client->vcard_selector_supported = pbap_supported_features & goep_client_get_pbap_supported_features(pbap_client->goep_cid) & PBAP_SUPPORTED_FEATURES_VCARD_SELECTING;
701                             pbap_client_emit_connected_event(pbap_client, 0);
702                             break;
703                         case OBEX_RESP_UNAUTHORIZED:
704                             for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
705                                 uint8_t hi = obex_iterator_get_hi(&it);
706                                 if (hi == OBEX_HEADER_AUTHENTICATION_CHALLENGE){
707                                     pbap_parse_authentication_challenge(pbap_client, obex_iterator_get_data(&it), obex_iterator_get_data_len(&it));
708                                 }
709                             }
710                             pbap_client->state = PBAP_W4_USER_AUTHENTICATION;
711                             pbap_client_emit_authentication_event(pbap_client, pbap_client->authentication_options);
712                             break;
713                         default:
714                             log_info("pbap: obex connect failed, result 0x%02x", packet[0]);
715                             pbap_client->state = PBAP_INIT;
716                             pbap_client_emit_connected_event(pbap_client, OBEX_CONNECT_FAILED);
717                             break;
718                     }
719                     break;
720                 case PBAP_W4_DISCONNECT_RESPONSE:
721                         goep_client_disconnect(pbap_client->goep_cid);
722                         break;
723                 case PBAP_W4_SET_PATH_ROOT_COMPLETE:
724                 case PBAP_W4_SET_PATH_ELEMENT_COMPLETE:
725                     if (packet[0] == OBEX_RESP_SUCCESS){
726                         // more path?
727                         if (pbap_client->current_folder[pbap_client->set_path_offset]){
728                             pbap_client->state = PBAP_W2_SET_PATH_ELEMENT;
729                             goep_client_request_can_send_now(pbap_client->goep_cid);
730                         } else {
731                             pbap_client->current_folder = NULL;
732                             pbap_client->state = PBAP_CONNECTED;
733                             pbap_client_emit_operation_complete_event(pbap_client, 0);
734                         }
735                     } else if (packet[0] == OBEX_RESP_NOT_FOUND){
736                         pbap_client->state = PBAP_CONNECTED;
737                         pbap_client_emit_operation_complete_event(pbap_client, OBEX_NOT_FOUND);
738                     } else {
739                         pbap_client->state = PBAP_CONNECTED;
740                         pbap_client_emit_operation_complete_event(pbap_client, OBEX_UNKNOWN_ERROR);
741                     }
742                     break;
743                 case PBAP_W4_PHONEBOOK:
744                     pbap_client->flow_next_triggered = 0;
745                     wait_for_user = 0;
746                     for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
747                         uint8_t hi = obex_iterator_get_hi(&it);
748                         uint16_t     data_len = obex_iterator_get_data_len(&it);
749                         const uint8_t  * data = obex_iterator_get_data(&it);
750                         switch (hi){
751                             case OBEX_HEADER_BODY:
752                             case OBEX_HEADER_END_OF_BODY:
753                                 pbap_client->client_handler(PBAP_DATA_PACKET, pbap_client->cid, (uint8_t *) data, data_len);
754                                 wait_for_user++;
755                                 if (wait_for_user > 1){
756                                     log_error("wait_for_user %u", wait_for_user);
757                                 }
758                                 break;
759                             default:
760                                 break;
761                         }
762                     }
763                     switch(packet[0]){
764                         case OBEX_RESP_CONTINUE:
765                             pbap_process_srm_headers(pbap_client, packet, size);
766                             if (pbap_client->srm_state ==  SRM_ENABLED) break;
767                             pbap_client->state = PBAP_W2_PULL_PHONEBOOK;
768                             if (!pbap_client->flow_control_enabled || !wait_for_user || pbap_client->flow_next_triggered) {
769                                 goep_client_request_can_send_now(pbap_client->goep_cid);
770                             }
771                             break;
772                         case OBEX_RESP_SUCCESS:
773                             pbap_client->state = PBAP_CONNECTED;
774                             pbap_client_emit_operation_complete_event(pbap_client, 0);
775                             break;
776                         default:
777                             log_info("unexpected response 0x%02x", packet[0]);
778                             pbap_client->state = PBAP_CONNECTED;
779                             pbap_client_emit_operation_complete_event(pbap_client, OBEX_UNKNOWN_ERROR);
780                             break;
781                     }
782                     break;
783                 case PBAP_W4_GET_PHONEBOOK_SIZE_COMPLETE:
784                     pbap_client->state = PBAP_CONNECTED;
785                     if (packet[0] == OBEX_RESP_SUCCESS){
786                         int have_size = 0;
787                         uint16_t phonebook_size;
788                         for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
789                             uint8_t hi = obex_iterator_get_hi(&it);
790                             if (hi == OBEX_HEADER_APPLICATION_PARAMETERS){
791                                 uint16_t     data_len = obex_iterator_get_data_len(&it);
792                                 const uint8_t  * data =  obex_iterator_get_data(&it);
793                                 // iterate over application headers (TLV with 1 bytes len)
794                                 unsigned int i = 0;
795                                 while (i<data_len){
796                                     uint8_t tag = data[i++];
797                                     uint8_t len = data[i++];
798                                     if ((tag == PBAP_APPLICATION_PARAMETER_PHONEBOOK_SIZE) && (len == 2)){
799                                         have_size = 1;
800                                         phonebook_size = big_endian_read_16(data, i);
801                                     }
802                                     i+=len;
803                                 }
804                             }
805                         }
806                         if (have_size){
807                             pbap_client_emit_phonebook_size_event(pbap_client, 0, phonebook_size);
808                             break;
809                         }
810                     }
811                     pbap_client_emit_phonebook_size_event(pbap_client, OBEX_UNKNOWN_ERROR, 0);
812                     break;
813                 case PBAP_W4_GET_CARD_LIST_COMPLETE:
814                     switch (packet[0]){
815                         case OBEX_RESP_CONTINUE:
816                             // process data
817                             pbap_client_process_vcard_listing(packet, size);
818                             // handle continue
819                             pbap_process_srm_headers(pbap_client, packet, size);
820                             if (pbap_client->srm_state ==  SRM_ENABLED) break;
821                             pbap_client->state = PBAP_W2_GET_CARD_LIST;
822                             if (!pbap_client->flow_control_enabled || !wait_for_user || pbap_client->flow_next_triggered) {
823                                 goep_client_request_can_send_now(pbap_client->goep_cid);
824                             }
825                             break;
826                         case OBEX_RESP_SUCCESS:
827                             // process data
828                             pbap_client_process_vcard_listing(packet, size);
829                             // done
830                             pbap_client->state = PBAP_CONNECTED;
831                             pbap_client_emit_operation_complete_event(pbap_client, 0);
832                             break;
833                         case OBEX_RESP_NOT_ACCEPTABLE:
834                             pbap_client->state = PBAP_CONNECTED;
835                             pbap_client_emit_operation_complete_event(pbap_client, OBEX_NOT_ACCEPTABLE);
836                             break;
837                         default:
838                             log_info("unexpected response 0x%02x", packet[0]);
839                             pbap_client->state = PBAP_CONNECTED;
840                             pbap_client_emit_operation_complete_event(pbap_client, OBEX_UNKNOWN_ERROR);
841                             break;
842                     }
843                     break;
844                 case PBAP_W4_GET_CARD_ENTRY_COMPLETE:
845                     switch (packet[0]){
846                         case OBEX_RESP_CONTINUE:
847                             pbap_process_srm_headers(pbap_client, packet, size);
848                             if (pbap_client->srm_state ==  SRM_ENABLED) break;
849                             pbap_client->state = PBAP_W2_GET_CARD_ENTRY;
850                             if (!pbap_client->flow_control_enabled || !wait_for_user || pbap_client->flow_next_triggered) {
851                                 goep_client_request_can_send_now(pbap_client->goep_cid);
852                             }
853                             break;
854                         case OBEX_RESP_SUCCESS:
855                             for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
856                                 uint8_t hi = obex_iterator_get_hi(&it);
857                                 if ((hi == OBEX_HEADER_END_OF_BODY) ||
858                                     (hi == OBEX_HEADER_BODY)){
859                                     // uint16_t     data_len = obex_iterator_get_data_len(&it);
860                                     // const uint8_t  * data =  obex_iterator_get_data(&it);
861                                     // now try parsing it
862                                 }
863                             }
864                             pbap_client->state = PBAP_CONNECTED;
865                             pbap_client_emit_operation_complete_event(pbap_client, 0);
866                             break;
867                         case OBEX_RESP_NOT_ACCEPTABLE:
868                             pbap_client->state = PBAP_CONNECTED;
869                             pbap_client_emit_operation_complete_event(pbap_client, OBEX_NOT_ACCEPTABLE);
870                             break;
871                         default:
872                             log_info("unexpected response 0x%02x", packet[0]);
873                             pbap_client->state = PBAP_CONNECTED;
874                             pbap_client_emit_operation_complete_event(pbap_client, OBEX_UNKNOWN_ERROR);
875                             break;
876                     }
877                     break;
878                 default:
879                     break;
880             }
881             break;
882         default:
883             break;
884     }
885 }
886 
887 void pbap_client_init(void){
888     memset(pbap_client, 0, sizeof(pbap_client_t));
889     pbap_client->state = PBAP_INIT;
890     pbap_client->cid = 1;
891 }
892 
893 uint8_t pbap_connect(btstack_packet_handler_t handler, bd_addr_t addr, uint16_t * out_cid){
894     if (pbap_client->state != PBAP_INIT) return BTSTACK_MEMORY_ALLOC_FAILED;
895 
896     pbap_client->state = PBAP_W4_GOEP_CONNECTION;
897     pbap_client->client_handler = handler;
898     pbap_client->vcard_selector = 0;
899     pbap_client->vcard_selector_operator = PBAP_VCARD_SELECTOR_OPERATOR_OR;
900 
901     uint8_t err = goep_client_create_connection(&pbap_packet_handler, addr, BLUETOOTH_SERVICE_CLASS_PHONEBOOK_ACCESS_PSE, &pbap_client->goep_cid);
902     *out_cid = pbap_client->cid;
903     if (err) return err;
904     return 0;
905 }
906 
907 uint8_t pbap_disconnect(uint16_t pbap_cid){
908     UNUSED(pbap_cid);
909     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
910     pbap_client->state = PBAP_W2_SEND_DISCONNECT_REQUEST;
911     goep_client_request_can_send_now(pbap_client->goep_cid);
912     return 0;
913 }
914 
915 uint8_t pbap_get_phonebook_size(uint16_t pbap_cid, const char * path){
916     UNUSED(pbap_cid);
917     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
918     pbap_client->state = PBAP_W2_GET_PHONEBOOK_SIZE;
919     pbap_client->phonebook_path = path;
920     pbap_client->request_number = 0;
921     goep_client_request_can_send_now(pbap_client->goep_cid);
922     return 0;
923 }
924 
925 uint8_t pbap_pull_phonebook(uint16_t pbap_cid, const char * path){
926     UNUSED(pbap_cid);
927     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
928     pbap_client->state = PBAP_W2_PULL_PHONEBOOK;
929     pbap_client->phonebook_path = path;
930     pbap_client->request_number = 0;
931     goep_client_request_can_send_now(pbap_client->goep_cid);
932     return 0;
933 }
934 
935 uint8_t pbap_set_phonebook(uint16_t pbap_cid, const char * path){
936     UNUSED(pbap_cid);
937     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
938     pbap_client->state = PBAP_W2_SET_PATH_ROOT;
939     pbap_client->current_folder = path;
940     pbap_client->set_path_offset = 0;
941     goep_client_request_can_send_now(pbap_client->goep_cid);
942     return 0;
943 }
944 
945 uint8_t pbap_authentication_password(uint16_t pbap_cid, const char * password){
946     UNUSED(pbap_cid);
947     if (pbap_client->state != PBAP_W4_USER_AUTHENTICATION) return BTSTACK_BUSY;
948     pbap_client->state = PBAP_W2_SEND_AUTHENTICATED_CONNECT;
949     pbap_client->authentication_password = password;
950     goep_client_request_can_send_now(pbap_client->goep_cid);
951     return 0;
952 }
953 
954 uint8_t pbap_pull_vcard_listing(uint16_t pbap_cid, const char * path){
955     UNUSED(pbap_cid);
956     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
957     pbap_client->state = PBAP_W2_GET_CARD_LIST;
958     pbap_client->phonebook_path = path;
959     pbap_client->phone_number = NULL;
960     pbap_client->request_number = 0;
961     goep_client_request_can_send_now(pbap_client->goep_cid);
962     return 0;
963 }
964 
965 uint8_t pbap_pull_vcard_entry(uint16_t pbap_cid, const char * path){
966     UNUSED(pbap_cid);
967     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
968     pbap_client->state = PBAP_W2_GET_CARD_ENTRY;
969     // pbap_client->phonebook_path = NULL;
970     // pbap_client->phone_number = NULL;
971     pbap_client->vcard_name = path;
972     pbap_client->request_number = 0;
973     goep_client_request_can_send_now(pbap_client->goep_cid);
974     return 0;
975 }
976 
977 uint8_t pbap_lookup_by_number(uint16_t pbap_cid, const char * phone_number){
978     UNUSED(pbap_cid);
979     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
980     pbap_client->state = PBAP_W2_GET_CARD_LIST;
981     pbap_client->phonebook_path = pbap_vcard_listing_name;
982     pbap_client->phone_number   = phone_number;
983     pbap_client->request_number = 0;
984     goep_client_request_can_send_now(pbap_client->goep_cid);
985     return 0;
986 }
987 
988 uint8_t pbap_abort(uint16_t pbap_cid){
989     UNUSED(pbap_cid);
990     log_info("abort current operation, state 0x%02x", pbap_client->state);
991     pbap_client->abort_operation = 1;
992     goep_client_request_can_send_now(pbap_client->goep_cid);
993     return 0;
994 }
995 
996 uint8_t pbap_next_packet(uint16_t pbap_cid){
997     // log_info("pbap_next_packet, state %x", pbap_client->state);
998     UNUSED(pbap_cid);
999     if (!pbap_client->flow_control_enabled) return 0;
1000     switch (pbap_client->state){
1001         case PBAP_W2_PULL_PHONEBOOK:
1002             goep_client_request_can_send_now(pbap_client->goep_cid);
1003             break;
1004         case PBAP_W4_PHONEBOOK:
1005             pbap_client->flow_next_triggered = 1;
1006             break;
1007         default:
1008             break;
1009     }
1010     return 0;
1011 }
1012 
1013 uint8_t pbap_set_flow_control_mode(uint16_t pbap_cid, int enable){
1014     UNUSED(pbap_cid);
1015     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
1016     pbap_client->flow_control_enabled = enable;
1017     return 0;
1018 }
1019 
1020 uint8_t pbap_set_vcard_selector(uint16_t pbap_cid, uint32_t vcard_selector){
1021     UNUSED(pbap_cid);
1022     pbap_client->vcard_selector = vcard_selector;
1023     return 0;
1024 }
1025 
1026 uint8_t pbap_set_vcard_selector_operator(uint16_t pbap_cid, int vcard_selector_operator){
1027     UNUSED(pbap_cid);
1028     pbap_client->vcard_selector_operator = vcard_selector_operator;
1029     return 0;
1030 }
1031