-
Notifications
You must be signed in to change notification settings - Fork 232
/
Copy pathHAPIPAccessoryServer.c
4299 lines (3951 loc) · 210 KB
/
HAPIPAccessoryServer.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2015-2019 The HomeKit ADK Contributors
//
// Licensed under the Apache License, Version 2.0 (the “License”);
// you may not use this file except in compliance with the License.
// See [CONTRIBUTORS.md] for the list of HomeKit ADK project authors.
#include "HAP+Internal.h"
#if HAP_IP
#include "util_base64.h"
static const HAPLogObject logObject = { .subsystem = kHAP_LogSubsystem, .category = "IPAccessoryServer" };
/** Build-time flag to disable session security. */
#define kHAPIPAccessoryServer_SessionSecurityDisabled ((bool) false)
/** US-ASCII horizontal-tab character. */
#define kHAPIPAccessoryServerCharacter_HorizontalTab ((char) 9)
/** US-ASCII space character. */
#define kHAPIPAccessoryServerCharacter_Space ((char) 32)
/**
* HAP Status Codes.
*
* @see HomeKit Accessory Protocol Specification R14
* Table 6-11 HAP Status Codes
*/
/**@{*/
/** This specifies a success for the request. */
#define kHAPIPAccessoryServerStatusCode_Success ((int32_t) 0)
/** Request denied due to insufficient privileges. */
#define kHAPIPAccessoryServerStatusCode_InsufficientPrivileges ((int32_t) -70401)
/** Unable to perform operation with requested service or characteristic. */
#define kHAPIPAccessoryServerStatusCode_UnableToPerformOperation ((int32_t) -70402)
/** Resource is busy, try again. */
#define kHAPIPAccessoryServerStatusCode_ResourceIsBusy ((int32_t) -70403)
/** Cannot write to read only characteristic. */
#define kHAPIPAccessoryServerStatusCode_WriteToReadOnlyCharacteristic ((int32_t) -70404)
/** Cannot read from a write only characteristic. */
#define kHAPIPAccessoryServerStatusCode_ReadFromWriteOnlyCharacteristic ((int32_t) -70405)
/** Notification is not supported for characteristic. */
#define kHAPIPAccessoryServerStatusCode_NotificationNotSupported ((int32_t) -70406)
/** Out of resources to process request. */
#define kHAPIPAccessoryServerStatusCode_OutOfResources ((int32_t) -70407)
/** Resource does not exist. */
#define kHAPIPAccessoryServerStatusCode_ResourceDoesNotExist ((int32_t) -70409)
/** Accessory received an invalid value in a write request. */
#define kHAPIPAccessoryServerStatusCode_InvalidValueInWrite ((int32_t) -70410)
/** Insufficient Authorization. */
#define kHAPIPAccessoryServerStatusCode_InsufficientAuthorization ((int32_t) -70411)
/**@}*/
/**
* Predefined HTTP/1.1 response indicating successful request completion with an empty response body.
*/
#define kHAPIPAccessoryServerResponse_NoContent ("HTTP/1.1 204 No Content\r\n\r\n")
/**
* Predefined HTTP/1.1 response indicating a malformed request.
*/
#define kHAPIPAccessoryServerResponse_BadRequest \
("HTTP/1.1 400 Bad Request\r\n" \
"Content-Length: 0\r\n\r\n")
/**
* Predefined HTTP/1.1 response indicating that the client has insufficient privileges to request the corresponding
* operation.
*/
#define kHAPIPAccessoryServerResponse_InsufficientPrivileges \
("HTTP/1.1 400 Bad Request\r\n" \
"Content-Type: application/hap+json\r\n" \
"Content-Length: 17\r\n\r\n" \
"{\"status\":-70401}")
/**
* Predefined HTTP/1.1 response indicating that the requested resource is not available.
*/
#define kHAPIPAccessoryServerResponse_ResourceNotFound \
("HTTP/1.1 404 Not Found\r\n" \
"Content-Length: 0\r\n\r\n")
/**
* Predefined HTTP/1.1 response indicating that the requested operation is not supported for the requested resource.
*/
#define kHAPIPAccessoryServerResponse_MethodNotAllowed \
("HTTP/1.1 405 Method Not Allowed\r\n" \
"Content-Length: 0\r\n\r\n")
/**
* Predefined HTTP/1.1 response indicating that the connection is not authorized to request the corresponding operation.
*/
#define kHAPIPAccessoryServerResponse_ConnectionAuthorizationRequired \
("HTTP/1.1 470 Connection Authorization Required\r\n" \
"Content-Length: 0\r\n\r\n")
/**
* Predefined HTTP/1.1 response indicating that the connection is not authorized to request the corresponding operation,
* including a HAP status code.
*/
#define kHAPIPAccessoryServerResponse_ConnectionAuthorizationRequiredWithStatus \
("HTTP/1.1 470 Connection Authorization Required\r\n" \
"Content-Type: application/hap+json\r\n" \
"Content-Length: 17\r\n\r\n" \
"{\"status\":-70411}")
/**
* Predefined HTTP/1.1 response indicating that the server encountered an unexpected condition which prevented it from
* successfully processing the request.
*/
#define kHAPIPAccessoryServerResponse_InternalServerError \
("HTTP/1.1 500 Internal Server Error\r\n" \
"Content-Length: 0\r\n\r\n")
/**
* Predefined HTTP/1.1 response indicating that the server did not have enough resources to process request.
*/
#define kHAPIPAccessoryServerResponse_OutOfResources \
("HTTP/1.1 500 Internal Server Error\r\n" \
"Content-Type: application/hap+json\r\n" \
"Content-Length: 17\r\n\r\n" \
"{\"status\":-70407}")
/**
* Maximum time an IP session can stay idle before it will be closed by the accessory server.
*
* - Maximum idle time will on be enforced during shutdown of the accessory server or at maximum capacity.
*/
#define kHAPIPSession_MaxIdleTime ((HAPTime)(60 * HAPSecond))
/**
* Maximum delay during which event notifications will be coalesced into a single message.
*/
#define kHAPIPAccessoryServer_MaxEventNotificationDelay ((HAPTime)(1 * HAPSecond))
static void log_result(HAPLogType type, char* msg, int result, const char* function, const char* file, int line) {
HAPAssert(msg);
HAPAssert(function);
HAPAssert(file);
HAPLogWithType(&logObject, type, "%s:%d - %s @ %s:%d", msg, result, function, file, line);
}
static void log_protocol_error(
HAPLogType type,
char* msg,
HAPIPByteBuffer* b,
const char* function,
const char* file,
int line) {
HAPAssert(msg);
HAPAssert(b);
HAPAssert(function);
HAPAssert(file);
HAPLogBufferWithType(
&logObject,
b->data,
b->position,
type,
"%s:%lu - %s @ %s:%d",
msg,
(unsigned long) b->position,
function,
file,
line);
}
static void get_db_ctx(
HAPAccessoryServerRef* server_,
uint64_t aid,
uint64_t iid,
const HAPCharacteristic** chr,
const HAPService** svc,
const HAPAccessory** acc) {
HAPPrecondition(server_);
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
HAPPrecondition(chr);
HAPPrecondition(svc);
HAPPrecondition(acc);
*chr = NULL;
*svc = NULL;
*acc = NULL;
const HAPAccessory* accessory = NULL;
if (server->primaryAccessory->aid == aid) {
accessory = server->primaryAccessory;
} else if (server->ip.bridgedAccessories) {
for (size_t i = 0; server->ip.bridgedAccessories[i]; i++) {
if (server->ip.bridgedAccessories[i]->aid == aid) {
accessory = server->ip.bridgedAccessories[i];
break;
}
}
}
if (accessory) {
size_t i = 0;
while (accessory->services[i] && !*chr) {
const HAPService* service = accessory->services[i];
if (HAPAccessoryServerSupportsService(server_, kHAPTransportType_IP, service)) {
size_t j = 0;
while (service->characteristics[j] && !*chr) {
const HAPBaseCharacteristic* characteristic = service->characteristics[j];
if (HAPIPCharacteristicIsSupported(characteristic)) {
if (characteristic->iid == iid) {
*chr = characteristic;
*svc = service;
*acc = accessory;
} else {
j++;
}
} else {
j++;
}
}
if (!*chr) {
i++;
}
} else {
i++;
}
}
}
}
static void publish_homeKit_service(HAPAccessoryServerRef* server_) {
HAPPrecondition(server_);
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
HAPAssert(!server->ip.isServiceDiscoverable);
HAPAssert(HAPPlatformTCPStreamManagerIsListenerOpen(HAPNonnull(server->platform.ip.tcpStreamManager)));
HAPIPServiceDiscoverySetHAPService(server_);
server->ip.isServiceDiscoverable = true;
}
static void HandlePendingTCPStream(HAPPlatformTCPStreamManagerRef tcpStreamManager, void* _Nullable context);
static void schedule_max_idle_time_timer(HAPAccessoryServerRef* server_);
static void HAPIPSessionDestroy(HAPIPSession* ipSession) {
HAPPrecondition(ipSession);
HAPIPSessionDescriptor* session = (HAPIPSessionDescriptor*) &ipSession->descriptor;
if (!session->server) {
return;
}
HAPLogDebug(&logObject, "session:%p:releasing session", (const void*) session);
HAPRawBufferZero(&ipSession->descriptor, sizeof ipSession->descriptor);
HAPRawBufferZero(ipSession->inboundBuffer.bytes, ipSession->inboundBuffer.numBytes);
HAPRawBufferZero(ipSession->outboundBuffer.bytes, ipSession->outboundBuffer.numBytes);
HAPRawBufferZero(
ipSession->eventNotifications, ipSession->numEventNotifications * sizeof *ipSession->eventNotifications);
}
static void collect_garbage(HAPAccessoryServerRef* server_) {
HAPPrecondition(server_);
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
if (server->ip.garbageCollectionTimer) {
HAPPlatformTimerDeregister(server->ip.garbageCollectionTimer);
server->ip.garbageCollectionTimer = 0;
}
size_t n = 0;
for (size_t i = 0; i < server->ip.storage->numSessions; i++) {
HAPIPSession* ipSession = &server->ip.storage->sessions[i];
HAPIPSessionDescriptor* session = (HAPIPSessionDescriptor*) &ipSession->descriptor;
if (!session->server) {
continue;
}
if (session->state == kHAPIPSessionState_Idle) {
HAPIPSessionDestroy(ipSession);
HAPAssert(server->ip.numSessions > 0);
server->ip.numSessions--;
} else {
n++;
}
}
HAPAssert(n == server->ip.numSessions);
// If there are open sessions, wait until they are closed before continuing.
if (HAPPlatformTCPStreamManagerIsListenerOpen(HAPNonnull(server->platform.ip.tcpStreamManager)) ||
(server->ip.numSessions != 0)) {
return;
}
// Finalize server state transition after last session closed.
HAPAssert(server->ip.state == kHAPIPAccessoryServerState_Stopping);
if (server->ip.stateTransitionTimer) {
HAPPlatformTimerDeregister(server->ip.stateTransitionTimer);
server->ip.stateTransitionTimer = 0;
}
if (server->ip.maxIdleTimeTimer) {
HAPPlatformTimerDeregister(server->ip.maxIdleTimeTimer);
server->ip.maxIdleTimeTimer = 0;
}
HAPLogDebug(&logObject, "Completing accessory server state transition.");
if (server->ip.nextState == kHAPIPAccessoryServerState_Running) {
server->ip.state = kHAPIPAccessoryServerState_Running;
server->ip.nextState = kHAPIPAccessoryServerState_Undefined;
HAPAccessoryServerDelegateScheduleHandleUpdatedState(server_);
} else {
HAPAssert(server->ip.nextState == kHAPIPAccessoryServerState_Idle);
// HAPAccessoryServerStop.
if (server->ip.isServiceDiscoverable) {
HAPIPServiceDiscoveryStop(server_);
server->ip.isServiceDiscoverable = false;
}
// Stop service discovery.
if (server->ip.discoverableService) {
HAPAssert(!server->ip.isServiceDiscoverable);
HAPAssert(server->ip.discoverableService == kHAPIPServiceDiscoveryType_HAP);
HAPIPServiceDiscoveryStop(server_);
}
HAPAssert(!server->ip.discoverableService);
HAPAssert(!server->ip.isServiceDiscoverable);
server->ip.state = kHAPIPAccessoryServerState_Idle;
server->ip.nextState = kHAPIPAccessoryServerState_Undefined;
HAPAccessoryServerDelegateScheduleHandleUpdatedState(server_);
}
}
static void handle_garbage_collection_timer(HAPPlatformTimerRef timer, void* _Nullable context) {
HAPPrecondition(context);
HAPAccessoryServerRef* server_ = context;
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
(void) server;
HAPPrecondition(timer == server->ip.garbageCollectionTimer);
server->ip.garbageCollectionTimer = 0;
collect_garbage(server_);
}
static void handle_max_idle_time_timer(HAPPlatformTimerRef timer, void* _Nullable context) {
HAPPrecondition(context);
HAPAccessoryServerRef* server_ = context;
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
(void) server;
HAPPrecondition(timer == server->ip.maxIdleTimeTimer);
server->ip.maxIdleTimeTimer = 0;
HAPLogDebug(&logObject, "Session idle timer expired.");
schedule_max_idle_time_timer(server_);
}
static void CloseSession(HAPIPSessionDescriptor* session);
static void schedule_max_idle_time_timer(HAPAccessoryServerRef* server_) {
HAPPrecondition(server_);
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
if (server->ip.maxIdleTimeTimer) {
HAPPlatformTimerDeregister(server->ip.maxIdleTimeTimer);
server->ip.maxIdleTimeTimer = 0;
}
HAPError err;
HAPTime clock_now_ms = HAPPlatformClockGetCurrent();
int64_t timeout_ms = -1;
if ((server->ip.state == kHAPIPAccessoryServerState_Stopping) &&
HAPPlatformTCPStreamManagerIsListenerOpen(HAPNonnull(server->platform.ip.tcpStreamManager))) {
HAPPlatformTCPStreamManagerCloseListener(HAPNonnull(server->platform.ip.tcpStreamManager));
}
for (size_t i = 0; i < server->ip.storage->numSessions; i++) {
HAPIPSession* ipSession = &server->ip.storage->sessions[i];
HAPIPSessionDescriptor* session = (HAPIPSessionDescriptor*) &ipSession->descriptor;
if (!session->server) {
continue;
}
if ((session->state == kHAPIPSessionState_Reading) && (session->inboundBuffer.position == 0) &&
(server->ip.state == kHAPIPAccessoryServerState_Stopping)) {
CloseSession(session);
} else if (
((session->state == kHAPIPSessionState_Reading) || (session->state == kHAPIPSessionState_Writing)) &&
((server->ip.numSessions == server->ip.storage->numSessions) ||
(server->ip.state == kHAPIPAccessoryServerState_Stopping))) {
HAPAssert(clock_now_ms >= session->stamp);
HAPTime dt_ms = clock_now_ms - session->stamp;
if (dt_ms < kHAPIPSession_MaxIdleTime) {
HAPAssert(kHAPIPSession_MaxIdleTime <= INT64_MAX);
int64_t t_ms = (int64_t)(kHAPIPSession_MaxIdleTime - dt_ms);
if ((timeout_ms == -1) || (t_ms < timeout_ms)) {
timeout_ms = t_ms;
}
} else {
HAPLogInfo(&logObject, "Connection timeout.");
CloseSession(session);
}
}
}
if (timeout_ms >= 0) {
HAPTime deadline_ms;
if (UINT64_MAX - clock_now_ms < (HAPTime) timeout_ms) {
HAPLog(&logObject, "Clipping maximum idle time timer to avoid clock overflow.");
deadline_ms = UINT64_MAX;
} else {
deadline_ms = clock_now_ms + (HAPTime) timeout_ms;
}
HAPAssert(deadline_ms >= clock_now_ms);
err = HAPPlatformTimerRegister(&server->ip.maxIdleTimeTimer, deadline_ms, handle_max_idle_time_timer, server_);
if (err) {
HAPLog(&logObject, "Not enough resources to schedule maximum idle time timer!");
HAPFatalError();
}
HAPAssert(server->ip.maxIdleTimeTimer);
}
if (!server->ip.garbageCollectionTimer) {
err = HAPPlatformTimerRegister(&server->ip.garbageCollectionTimer, 0, handle_garbage_collection_timer, server_);
if (err) {
HAPLog(&logObject, "Not enough resources to schedule garbage collection!");
HAPFatalError();
}
HAPAssert(server->ip.garbageCollectionTimer);
}
}
static void RegisterSession(HAPIPSessionDescriptor* session) {
HAPPrecondition(session);
HAPPrecondition(session->server);
HAPAccessoryServer* server = (HAPAccessoryServer*) session->server;
HAPPrecondition(server->ip.numSessions < server->ip.storage->numSessions);
server->ip.numSessions++;
if (server->ip.numSessions == server->ip.storage->numSessions) {
schedule_max_idle_time_timer(session->server);
}
}
static void handle_characteristic_unsubscribe_request(
HAPIPSessionDescriptor* session,
const HAPCharacteristic* chr,
const HAPService* svc,
const HAPAccessory* acc);
static void CloseSession(HAPIPSessionDescriptor* session) {
HAPPrecondition(session);
HAPPrecondition(session->server);
HAPAccessoryServer* server = (HAPAccessoryServer*) session->server;
HAPAssert(session->state != kHAPIPSessionState_Idle);
HAPError err;
HAPLogDebug(&logObject, "session:%p:closing", (const void*) session);
while (session->numEventNotifications) {
HAPIPEventNotification* eventNotification =
(HAPIPEventNotification*) &session->eventNotifications[session->numEventNotifications - 1];
const HAPCharacteristic* characteristic;
const HAPService* service;
const HAPAccessory* accessory;
get_db_ctx(
session->server, eventNotification->aid, eventNotification->iid, &characteristic, &service, &accessory);
if (eventNotification->flag) {
HAPAssert(session->numEventNotificationFlags);
session->numEventNotificationFlags--;
}
session->numEventNotifications--;
handle_characteristic_unsubscribe_request(session, characteristic, service, accessory);
}
if (session->securitySession.isOpen) {
HAPLogDebug(&logObject, "session:%p:closing security context", (const void*) session);
switch (session->securitySession.type) {
case kHAPIPSecuritySessionType_HAP: {
HAPLogDebug(&logObject, "Closing HAP session.");
HAPSessionRelease(HAPNonnull(session->server), &session->securitySession._.hap);
HAPRawBufferZero(&session->securitySession, sizeof session->securitySession);
} break;
case kHAPIPSecuritySessionType_MFiSAP: {
HAPLogDebug(&logObject, "Closing MFi SAP session.");
HAPRawBufferZero(&session->securitySession, sizeof session->securitySession);
} break;
}
HAPAssert(!session->securitySession.type);
HAPAssert(!session->securitySession.isSecured);
HAPAssert(!session->securitySession.isOpen);
}
if (session->tcpStreamIsOpen) {
HAPLogDebug(&logObject, "session:%p:closing TCP stream", (const void*) session);
HAPPlatformTCPStreamClose(HAPNonnull(server->platform.ip.tcpStreamManager), session->tcpStream);
session->tcpStreamIsOpen = false;
}
session->state = kHAPIPSessionState_Idle;
if (!server->ip.garbageCollectionTimer) {
err = HAPPlatformTimerRegister(
&server->ip.garbageCollectionTimer, 0, handle_garbage_collection_timer, session->server);
if (err) {
HAPLog(&logObject, "Not enough resources to schedule garbage collection!");
HAPFatalError();
}
HAPAssert(server->ip.garbageCollectionTimer);
}
HAPLogDebug(&logObject, "session:%p:closed", (const void*) session);
}
static void OpenSecuritySession(HAPIPSessionDescriptor* session) {
HAPPrecondition(session);
HAPPrecondition(session->server);
HAPPrecondition(!session->securitySession.isOpen);
HAPPrecondition(!session->securitySession.isSecured);
HAPLogDebug(&logObject, "Opening HAP session.");
session->securitySession.type = kHAPIPSecuritySessionType_HAP;
HAPSessionCreate(HAPNonnull(session->server), &session->securitySession._.hap, kHAPTransportType_IP);
session->securitySession.isOpen = true;
}
static void write_msg(HAPIPByteBuffer* b, const char* msg) {
HAPError err;
err = HAPIPByteBufferAppendStringWithFormat(b, "%s", msg);
HAPAssert(!err);
}
static void prepare_reading_request(HAPIPSessionDescriptor* session) {
HAPPrecondition(session);
HAPPrecondition(session->server);
util_http_reader_init(&session->httpReader, util_HTTP_READER_TYPE_REQUEST);
session->httpReaderPosition = 0;
session->httpParserError = false;
session->httpMethod.bytes = NULL;
session->httpURI.bytes = NULL;
session->httpHeaderFieldName.bytes = NULL;
session->httpHeaderFieldValue.bytes = NULL;
session->httpContentLength.isDefined = false;
session->httpContentType = kHAPIPAccessoryServerContentType_Unknown;
}
static void handle_input(HAPIPSessionDescriptor* session);
static void post_resource(HAPIPSessionDescriptor* session HAP_UNUSED) {
}
static void put_prepare(HAPIPSessionDescriptor* session) {
HAPPrecondition(session);
HAPPrecondition(session->server);
HAPPrecondition(session->securitySession.type == kHAPIPSecuritySessionType_HAP);
HAPPrecondition(session->securitySession.isOpen);
HAPPrecondition(session->securitySession.isSecured || kHAPIPAccessoryServer_SessionSecurityDisabled);
HAPPrecondition(!HAPSessionIsTransient(&session->securitySession._.hap));
HAPError err;
uint64_t ttl, pid;
HAPAssert(session->inboundBuffer.data);
HAPAssert(session->inboundBuffer.position <= session->inboundBuffer.limit);
HAPAssert(session->inboundBuffer.limit <= session->inboundBuffer.capacity);
HAPAssert(session->httpReaderPosition <= session->inboundBuffer.position);
if (session->httpContentLength.isDefined) {
HAPAssert(session->httpContentLength.value <= session->inboundBuffer.position - session->httpReaderPosition);
err = HAPIPAccessoryProtocolGetCharacteristicWritePreparation(
&session->inboundBuffer.data[session->httpReaderPosition],
session->httpContentLength.value,
&ttl,
&pid);
if (!err) {
HAPLogDebug(&logObject, "Prepare Write Request - TTL = %lu ms.", (unsigned long) ttl);
// If the accessory receives consecutive Prepare Write Requests in the same session, the accessory must
// reset the timed write transaction with the TTL specified by the latest request.
// See HomeKit Accessory Protocol Specification R14
// Section 6.7.2.4 Timed Write Procedures
// Assumption: Same behavior for PID.
// TTL.
HAPTime clock_now_ms = HAPPlatformClockGetCurrent();
if (UINT64_MAX - clock_now_ms < ttl) {
HAPLog(&logObject, "Clipping TTL to avoid clock overflow.");
session->timedWriteExpirationTime = UINT64_MAX;
} else {
session->timedWriteExpirationTime = clock_now_ms + ttl;
}
HAPAssert(session->timedWriteExpirationTime >= clock_now_ms);
// PID.
session->timedWritePID = pid;
// The accessory must respond with a 200 OK HTTP Status Code and include a HAP status code indicating if
// timed write procedure can be executed or not.
// See HomeKit Accessory Protocol Specification R14
// Section 6.7.2.4 Timed Write Procedures
// It is not documented under what conditions this should fail.
write_msg(
&session->outboundBuffer,
"HTTP/1.1 200 OK\r\n"
"Content-Type: application/hap+json\r\n"
"Content-Length: 12\r\n\r\n"
"{\"status\":0}");
} else {
write_msg(&session->outboundBuffer, kHAPIPAccessoryServerResponse_BadRequest);
}
} else {
write_msg(&session->outboundBuffer, kHAPIPAccessoryServerResponse_BadRequest);
}
}
static void write_characteristic_write_response(
HAPIPSessionDescriptor* session,
HAPIPWriteContextRef* contexts,
size_t contexts_count) {
HAPPrecondition(session);
HAPPrecondition(session->server);
HAPPrecondition(session->securitySession.type == kHAPIPSecuritySessionType_HAP);
HAPPrecondition(session->securitySession.isOpen);
HAPPrecondition(session->securitySession.isSecured || kHAPIPAccessoryServer_SessionSecurityDisabled);
HAPPrecondition(!HAPSessionIsTransient(&session->securitySession._.hap));
HAPError err;
size_t content_length, mark;
HAPAssert(contexts);
HAPAssert(session->outboundBuffer.data);
HAPAssert(session->outboundBuffer.position <= session->outboundBuffer.limit);
HAPAssert(session->outboundBuffer.limit <= session->outboundBuffer.capacity);
content_length = HAPIPAccessoryProtocolGetNumCharacteristicWriteResponseBytes(
HAPNonnull(session->server), contexts, contexts_count);
HAP_DIAGNOSTIC_IGNORED_ICCARM(Pa084)
if (content_length <= UINT32_MAX) {
mark = session->outboundBuffer.position;
err = HAPIPByteBufferAppendStringWithFormat(
&session->outboundBuffer,
"HTTP/1.1 207 Multi-Status\r\n"
"Content-Type: application/hap+json\r\n"
"Content-Length: %lu\r\n\r\n",
(unsigned long) content_length);
HAPAssert(!err);
if (content_length <= session->outboundBuffer.limit - session->outboundBuffer.position) {
mark = session->outboundBuffer.position;
err = HAPIPAccessoryProtocolGetCharacteristicWriteResponseBytes(
HAPNonnull(session->server), contexts, contexts_count, &session->outboundBuffer);
HAPAssert(!err && (session->outboundBuffer.position - mark == content_length));
} else {
HAPLog(&logObject, "Out of resources (outbound buffer too small).");
session->outboundBuffer.position = mark;
write_msg(&session->outboundBuffer, kHAPIPAccessoryServerResponse_OutOfResources);
}
} else {
HAPLog(&logObject, "Content length exceeding UINT32_MAX.");
write_msg(&session->outboundBuffer, kHAPIPAccessoryServerResponse_OutOfResources);
}
HAP_DIAGNOSTIC_RESTORE_ICCARM(Pa084)
}
static void schedule_event_notifications(HAPAccessoryServerRef* server_);
static void handle_event_notification_timer(HAPPlatformTimerRef timer, void* _Nullable context) {
HAPPrecondition(context);
HAPAccessoryServerRef* server_ = context;
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
HAPPrecondition(timer == server->ip.eventNotificationTimer);
server->ip.eventNotificationTimer = 0;
HAPLogDebug(&logObject, "Event notification timer expired.");
schedule_event_notifications(server_);
}
static void write_event_notifications(HAPIPSessionDescriptor* session);
static void schedule_event_notifications(HAPAccessoryServerRef* server_) {
HAPPrecondition(server_);
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
if (server->ip.eventNotificationTimer) {
HAPPlatformTimerDeregister(server->ip.eventNotificationTimer);
server->ip.eventNotificationTimer = 0;
}
HAPError err;
for (size_t i = 0; i < server->ip.storage->numSessions; i++) {
HAPIPSession* ipSession = &server->ip.storage->sessions[i];
HAPIPSessionDescriptor* session = (HAPIPSessionDescriptor*) &ipSession->descriptor;
if (!session->server) {
continue;
}
if ((session->state == kHAPIPSessionState_Reading) && (session->inboundBuffer.position == 0) &&
(session->numEventNotificationFlags > 0)) {
write_event_notifications(session);
}
}
HAPTime clock_now_ms = HAPPlatformClockGetCurrent();
int64_t timeout_ms = -1;
for (size_t i = 0; i < server->ip.storage->numSessions; i++) {
HAPIPSession* ipSession = &server->ip.storage->sessions[i];
HAPIPSessionDescriptor* session = (HAPIPSessionDescriptor*) &ipSession->descriptor;
if (!session->server) {
continue;
}
if ((session->state == kHAPIPSessionState_Reading) && (session->inboundBuffer.position == 0) &&
(session->numEventNotificationFlags > 0)) {
HAPAssert(clock_now_ms >= session->eventNotificationStamp);
HAPTime dt_ms = clock_now_ms - session->eventNotificationStamp;
HAP_DIAGNOSTIC_PUSH
HAP_DIAGNOSTIC_IGNORED_ARMCC(186)
HAP_DIAGNOSTIC_IGNORED_GCC("-Wtype-limits")
if (dt_ms < kHAPIPAccessoryServer_MaxEventNotificationDelay) {
HAPAssert(kHAPIPAccessoryServer_MaxEventNotificationDelay <= INT64_MAX);
int64_t t_ms = (int64_t)(kHAPIPAccessoryServer_MaxEventNotificationDelay - dt_ms);
if ((timeout_ms == -1) || (t_ms < timeout_ms)) {
timeout_ms = t_ms;
}
} else {
timeout_ms = 0;
}
HAP_DIAGNOSTIC_POP
}
}
if (timeout_ms >= 0) {
HAPTime deadline_ms;
if (UINT64_MAX - clock_now_ms < (HAPTime) timeout_ms) {
HAPLog(&logObject, "Clipping event notification timer to avoid clock overflow.");
deadline_ms = UINT64_MAX;
} else {
deadline_ms = clock_now_ms + (HAPTime) timeout_ms;
}
HAPAssert(deadline_ms >= clock_now_ms);
err = HAPPlatformTimerRegister(
&server->ip.eventNotificationTimer, deadline_ms, handle_event_notification_timer, server_);
if (err) {
HAPLog(&logObject, "Not enough resources to schedule event notification timer!");
HAPFatalError();
}
HAPAssert(server->ip.eventNotificationTimer);
}
}
static void handle_characteristic_subscribe_request(
HAPIPSessionDescriptor* session,
const HAPCharacteristic* chr,
const HAPService* svc,
const HAPAccessory* acc) {
HAPPrecondition(session);
HAPPrecondition(session->server);
HAPPrecondition(session->securitySession.type == kHAPIPSecuritySessionType_HAP);
HAPPrecondition(session->securitySession.isOpen);
HAPPrecondition(session->securitySession.isSecured || kHAPIPAccessoryServer_SessionSecurityDisabled);
HAPPrecondition(!HAPSessionIsTransient(&session->securitySession._.hap));
HAPPrecondition(chr);
HAPPrecondition(svc);
HAPPrecondition(acc);
HAPAccessoryServerHandleSubscribe(HAPNonnull(session->server), &session->securitySession._.hap, chr, svc, acc);
}
static void handle_characteristic_unsubscribe_request(
HAPIPSessionDescriptor* session,
const HAPCharacteristic* chr,
const HAPService* svc,
const HAPAccessory* acc) {
HAPPrecondition(session);
HAPPrecondition(session->server);
HAPPrecondition(session->securitySession.type == kHAPIPSecuritySessionType_HAP);
HAPPrecondition(session->securitySession.isOpen);
HAPPrecondition(session->securitySession.isSecured || kHAPIPAccessoryServer_SessionSecurityDisabled);
HAPPrecondition(!HAPSessionIsTransient(&session->securitySession._.hap));
HAPPrecondition(chr);
HAPPrecondition(svc);
HAPPrecondition(acc);
HAPAccessoryServerHandleUnsubscribe(HAPNonnull(session->server), &session->securitySession._.hap, chr, svc, acc);
}
static void handle_characteristic_read_request(
HAPIPSessionDescriptor* session,
const HAPCharacteristic* chr,
const HAPService* svc,
const HAPAccessory* acc,
HAPIPReadContextRef* ctx,
HAPIPByteBuffer* data_buffer);
/**
* Converts a characteristic write request error to the corresponding HAP status code.
*
* @param error Write request error.
*
* @return HAP write request status code.
*
* @see HomeKit Accessory Protocol Specification R14
* Table 6-11 HAP Status Codes
*/
static int32_t ConvertCharacteristicWriteErrorToStatusCode(HAPError error) {
switch (error) {
case kHAPError_None: {
return kHAPIPAccessoryServerStatusCode_Success;
}
case kHAPError_Unknown: {
return kHAPIPAccessoryServerStatusCode_UnableToPerformOperation;
}
case kHAPError_InvalidState: {
return kHAPIPAccessoryServerStatusCode_UnableToPerformOperation;
}
case kHAPError_InvalidData: {
return kHAPIPAccessoryServerStatusCode_InvalidValueInWrite;
}
case kHAPError_OutOfResources: {
return kHAPIPAccessoryServerStatusCode_OutOfResources;
}
case kHAPError_NotAuthorized: {
return kHAPIPAccessoryServerStatusCode_InsufficientAuthorization;
}
case kHAPError_Busy: {
return kHAPIPAccessoryServerStatusCode_ResourceIsBusy;
}
}
HAPFatalError();
}
static void handle_characteristic_write_request(
HAPIPSessionDescriptor* session,
const HAPCharacteristic* characteristic,
const HAPService* service,
const HAPAccessory* accessory,
HAPIPWriteContextRef* context,
HAPIPByteBuffer* dataBuffer) {
HAPPrecondition(session);
HAPPrecondition(session->server);
HAPPrecondition(session->securitySession.type == kHAPIPSecuritySessionType_HAP);
HAPPrecondition(session->securitySession.isOpen);
HAPPrecondition(session->securitySession.isSecured || kHAPIPAccessoryServer_SessionSecurityDisabled);
HAPPrecondition(!HAPSessionIsTransient(&session->securitySession._.hap));
HAPPrecondition(characteristic);
HAPPrecondition(service);
HAPPrecondition(accessory);
HAPPrecondition(context);
HAPPrecondition(dataBuffer);
HAPError err;
const HAPBaseCharacteristic* baseCharacteristic = characteristic;
HAPIPWriteContext* writeContext = (HAPIPWriteContext*) context;
HAPAssert(baseCharacteristic->iid == writeContext->iid);
if ((writeContext->type == kHAPIPWriteValueType_None) &&
(writeContext->ev == kHAPIPEventNotificationState_Undefined)) {
writeContext->status = kHAPIPAccessoryServerStatusCode_InvalidValueInWrite;
return;
}
if (writeContext->ev != kHAPIPEventNotificationState_Undefined) {
if (HAPCharacteristicReadRequiresAdminPermissions(baseCharacteristic) &&
!HAPSessionControllerIsAdmin(&session->securitySession._.hap)) {
writeContext->status = kHAPIPAccessoryServerStatusCode_InsufficientPrivileges;
} else if (!baseCharacteristic->properties.supportsEventNotification) {
writeContext->status = kHAPIPAccessoryServerStatusCode_NotificationNotSupported;
} else {
writeContext->status = kHAPIPAccessoryServerStatusCode_Success;
HAPAssert(session->numEventNotifications <= session->maxEventNotifications);
size_t i = 0;
while ((i < session->numEventNotifications) &&
((((HAPIPEventNotification*) &session->eventNotifications[i])->aid != writeContext->aid) ||
(((HAPIPEventNotification*) &session->eventNotifications[i])->iid != writeContext->iid))) {
i++;
}
HAPAssert(
(i == session->numEventNotifications) ||
((i < session->numEventNotifications) &&
(((HAPIPEventNotification*) &session->eventNotifications[i])->aid == writeContext->aid) &&
(((HAPIPEventNotification*) &session->eventNotifications[i])->iid == writeContext->iid)));
if (i == session->numEventNotifications) {
if (writeContext->ev == kHAPIPEventNotificationState_Enabled) {
if (i == session->maxEventNotifications) {
writeContext->status = kHAPIPAccessoryServerStatusCode_OutOfResources;
} else {
((HAPIPEventNotification*) &session->eventNotifications[i])->aid = writeContext->aid;
((HAPIPEventNotification*) &session->eventNotifications[i])->iid = writeContext->iid;
((HAPIPEventNotification*) &session->eventNotifications[i])->flag = false;
session->numEventNotifications++;
handle_characteristic_subscribe_request(session, characteristic, service, accessory);
}
}
} else if (writeContext->ev == kHAPIPEventNotificationState_Disabled) {
session->numEventNotifications--;
if (((HAPIPEventNotification*) &session->eventNotifications[i])->flag) {
HAPAssert(session->numEventNotificationFlags > 0);
session->numEventNotificationFlags--;
}
while (i < session->numEventNotifications) {
HAPRawBufferCopyBytes(
&session->eventNotifications[i],
&session->eventNotifications[i + 1],
sizeof session->eventNotifications[i]);
i++;
}
HAPAssert(i == session->numEventNotifications);
handle_characteristic_unsubscribe_request(session, characteristic, service, accessory);
}
}
}
if (writeContext->type != kHAPIPWriteValueType_None) {
if (HAPCharacteristicWriteRequiresAdminPermissions(baseCharacteristic) &&
!HAPSessionControllerIsAdmin(&session->securitySession._.hap)) {
writeContext->status = kHAPIPAccessoryServerStatusCode_InsufficientPrivileges;
return;
}
if ((baseCharacteristic->properties.ip.supportsWriteResponse || writeContext->response) &&
HAPCharacteristicReadRequiresAdminPermissions(baseCharacteristic) &&
!HAPSessionControllerIsAdmin(&session->securitySession._.hap)) {
writeContext->status = kHAPIPAccessoryServerStatusCode_InsufficientPrivileges;
return;
}
if (baseCharacteristic->properties.writable) {
writeContext->status = kHAPIPAccessoryServerStatusCode_Success;
const void* authorizationDataBytes = NULL;
size_t numAuthorizationDataBytes = 0;
if (writeContext->authorizationData.bytes) {
int r = util_base64_decode(
writeContext->authorizationData.bytes,
writeContext->authorizationData.numBytes,
writeContext->authorizationData.bytes,
writeContext->authorizationData.numBytes,
&writeContext->authorizationData.numBytes);
if (r == 0) {
authorizationDataBytes = writeContext->authorizationData.bytes;
numAuthorizationDataBytes = writeContext->authorizationData.numBytes;
} else {
writeContext->status = kHAPIPAccessoryServerStatusCode_InvalidValueInWrite;
}
}
if (writeContext->status == kHAPIPAccessoryServerStatusCode_Success) {
switch (baseCharacteristic->format) {
case kHAPCharacteristicFormat_Data: {
if (writeContext->type == kHAPIPWriteValueType_String) {
HAPAssert(writeContext->value.stringValue.bytes);
int r = util_base64_decode(
writeContext->value.stringValue.bytes,
writeContext->value.stringValue.numBytes,
writeContext->value.stringValue.bytes,
writeContext->value.stringValue.numBytes,
&writeContext->value.stringValue.numBytes);
if (r == 0) {
HAPAssert(writeContext->value.stringValue.bytes);
err = HAPDataCharacteristicHandleWrite(
HAPNonnull(session->server),
&(const HAPDataCharacteristicWriteRequest) {
.transportType = kHAPTransportType_IP,
.session = &session->securitySession._.hap,
.characteristic = (const HAPDataCharacteristic*) baseCharacteristic,
.service = service,
.accessory = accessory,
.remote = writeContext->remote,
.authorizationData = { .bytes = authorizationDataBytes,
.numBytes = numAuthorizationDataBytes } },
HAPNonnull(writeContext->value.stringValue.bytes),
writeContext->value.stringValue.numBytes,
HAPAccessoryServerGetClientContext(HAPNonnull(session->server)));
writeContext->status = ConvertCharacteristicWriteErrorToStatusCode(err);
} else {
writeContext->status = kHAPIPAccessoryServerStatusCode_InvalidValueInWrite;
}
} else {
writeContext->status = kHAPIPAccessoryServerStatusCode_InvalidValueInWrite;
}
} break;
case kHAPCharacteristicFormat_Bool: {
if ((writeContext->type == kHAPIPWriteValueType_UInt) &&