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