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