Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_ks_interface.h
Go to the documentation of this file.
1 
2 
3 /*
4  * ====================== WARNING ======================
5  *
6  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
7  * DO NOT MODIFY IN ANY WAY.
8  *
9  * ====================== WARNING ======================
10  */
11 
163 #ifndef TAF_KS_INTERFACE_H_INCLUDE_GUARD
164 #define TAF_KS_INTERFACE_H_INCLUDE_GUARD
165 
166 
167 #include "legato.h"
168 
169 // Interface specific includes
170 #include "le_limit_interface.h"
171 
172 // Internal includes for this interface
173 #include "taf_ks_common.h"
174 //--------------------------------------------------------------------------------------------------
178 //--------------------------------------------------------------------------------------------------
179 typedef void (*taf_ks_DisconnectHandler_t)(void *);
180 
181 //--------------------------------------------------------------------------------------------------
193 //--------------------------------------------------------------------------------------------------
195 (
196  void
197 );
198 
199 //--------------------------------------------------------------------------------------------------
218 //--------------------------------------------------------------------------------------------------
220 (
221  void
222 );
223 
224 //--------------------------------------------------------------------------------------------------
232 //--------------------------------------------------------------------------------------------------
234 (
235  taf_ks_DisconnectHandler_t disconnectHandler,
236  void *contextPtr
237 );
238 
239 //--------------------------------------------------------------------------------------------------
250 //--------------------------------------------------------------------------------------------------
252 (
253  taf_ks_DisconnectHandler_t disconnectHandler,
254  void *contextPtr
255 );
256 
257 //--------------------------------------------------------------------------------------------------
268 //--------------------------------------------------------------------------------------------------
270 (
271  void
272 );
273 
274 //--------------------------------------------------------------------------------------------------
284 //--------------------------------------------------------------------------------------------------
286 (
287  const char* LE_NONNULL keyName,
289  taf_ks_KeyUsage_t keyUsage,
291  taf_ks_KeyRef_t* keyRefPtr
293 );
294 
295 //--------------------------------------------------------------------------------------------------
305 //--------------------------------------------------------------------------------------------------
307 (
308  const char* LE_NONNULL keyName,
310  taf_ks_KeyRef_t* keyRefPtr
312 );
313 
314 //--------------------------------------------------------------------------------------------------
324 //--------------------------------------------------------------------------------------------------
326 (
327  taf_ks_KeyRef_t keyRef
329 );
330 
331 //--------------------------------------------------------------------------------------------------
341 //--------------------------------------------------------------------------------------------------
343 (
344  taf_ks_KeyRef_t keyRef,
346  taf_ks_KeyUsage_t* keyUsagePtr
348 );
349 
350 //--------------------------------------------------------------------------------------------------
359 //--------------------------------------------------------------------------------------------------
361 (
362  taf_ks_KeyRef_t keyRef,
364  uint32_t value
366 );
367 
368 //--------------------------------------------------------------------------------------------------
377 //--------------------------------------------------------------------------------------------------
379 (
380  taf_ks_KeyRef_t keyRef,
382  uint32_t value
384 );
385 
386 //--------------------------------------------------------------------------------------------------
399 //--------------------------------------------------------------------------------------------------
401 (
402  taf_ks_KeyRef_t keyRef,
404  const uint8_t* dataPtr,
406  size_t dataSize
408 );
409 
410 //--------------------------------------------------------------------------------------------------
420 //--------------------------------------------------------------------------------------------------
422 (
423  taf_ks_KeyRef_t keyRef,
425  uint64_t value
427 );
428 
429 //--------------------------------------------------------------------------------------------------
439 //--------------------------------------------------------------------------------------------------
441 (
442  taf_ks_KeyRef_t keyRef,
444  uint64_t value
446 );
447 
448 //--------------------------------------------------------------------------------------------------
458 //--------------------------------------------------------------------------------------------------
460 (
461  taf_ks_KeyRef_t keyRef,
463  uint64_t value
465 );
466 
467 //--------------------------------------------------------------------------------------------------
481 //--------------------------------------------------------------------------------------------------
483 (
484  taf_ks_KeyRef_t keyRef,
486  taf_ks_RsaKeySize_t keySize,
489  taf_ks_RsaEncPadding_t padding,
491  const uint8_t* impDataPtr,
493  size_t impDataSize
495 );
496 
497 //--------------------------------------------------------------------------------------------------
511 //--------------------------------------------------------------------------------------------------
513 (
514  taf_ks_KeyRef_t keyRef,
516  taf_ks_RsaKeySize_t keySize,
519  taf_ks_RsaSigPadding_t padding,
521  const uint8_t* impDataPtr,
523  size_t impDataSize
525 );
526 
527 //--------------------------------------------------------------------------------------------------
541 //--------------------------------------------------------------------------------------------------
543 (
544  taf_ks_KeyRef_t keyRef,
546  taf_ks_EccKeySize_t keySize,
549  taf_ks_Digest_t digest,
551  const uint8_t* impDataPtr,
553  size_t impDataSize
555 );
556 
557 //--------------------------------------------------------------------------------------------------
571 //--------------------------------------------------------------------------------------------------
573 (
574  taf_ks_KeyRef_t keyRef,
576  taf_ks_AesKeySize_t keySize,
581  const uint8_t* impDataPtr,
583  size_t impDataSize
585 );
586 
587 //--------------------------------------------------------------------------------------------------
601 //--------------------------------------------------------------------------------------------------
603 (
604  taf_ks_KeyRef_t keyRef,
606  uint32_t keySize,
609  taf_ks_Digest_t digest,
611  const uint8_t* impDataPtr,
613  size_t impDataSize
615 );
616 
617 //--------------------------------------------------------------------------------------------------
631 //--------------------------------------------------------------------------------------------------
633 (
634  taf_ks_KeyRef_t keyRef,
636  const uint8_t* appDataPtr,
638  size_t appDataSize,
640  uint8_t* expDataPtr,
642  size_t* expDataSizePtr
644 );
645 
646 //--------------------------------------------------------------------------------------------------
656 //--------------------------------------------------------------------------------------------------
658 (
659  taf_ks_KeyRef_t keyRef,
661  taf_ks_CryptoSessionRef_t* sessionRefPtr
663 );
664 
665 //--------------------------------------------------------------------------------------------------
677 //--------------------------------------------------------------------------------------------------
679 (
680  taf_ks_CryptoSessionRef_t sessionRef,
682  const uint8_t* dataPtr,
684  size_t dataSize
686 );
687 
688 //--------------------------------------------------------------------------------------------------
702 //--------------------------------------------------------------------------------------------------
704 (
705  taf_ks_CryptoSessionRef_t sessionRef,
707  const uint8_t* dataPtr,
709  size_t dataSize
711 );
712 
713 //--------------------------------------------------------------------------------------------------
727 //--------------------------------------------------------------------------------------------------
729 (
730  taf_ks_CryptoSessionRef_t sessionRef,
732  taf_ks_CryptoPurpose_t cryptoPurpose
734 );
735 
736 //--------------------------------------------------------------------------------------------------
750 //--------------------------------------------------------------------------------------------------
752 (
753  taf_ks_CryptoSessionRef_t sessionRef,
755  const uint8_t* dataPtr,
757  size_t dataSize
759 );
760 
761 //--------------------------------------------------------------------------------------------------
775 //--------------------------------------------------------------------------------------------------
777 (
778  taf_ks_CryptoSessionRef_t sessionRef,
780  const uint8_t* inputDataPtr,
786  size_t inputDataSize,
788  uint8_t* outputDataPtr,
794  size_t* outputDataSizePtr
796 );
797 
798 //--------------------------------------------------------------------------------------------------
811 //--------------------------------------------------------------------------------------------------
813 (
814  taf_ks_CryptoSessionRef_t sessionRef,
816  const uint8_t* inputDataPtr,
819  size_t inputDataSize,
821  uint8_t* outputDataPtr,
827  size_t* outputDataSizePtr
829 );
830 
831 //--------------------------------------------------------------------------------------------------
843 //--------------------------------------------------------------------------------------------------
845 (
846  taf_ks_CryptoSessionRef_t sessionRef
848 );
849 
850 #endif // TAF_KS_INTERFACE_H_INCLUDE_GUARD
le_result_t taf_ks_ProvisionRsaSigKeyValue(taf_ks_KeyRef_t keyRef, taf_ks_RsaKeySize_t keySize, taf_ks_RsaSigPadding_t padding, const uint8_t *impDataPtr, size_t impDataSize)
Definition: taf_ks_client.c:869
le_result_t taf_ks_SetKeyMaxUsesPerBoot(taf_ks_KeyRef_t keyRef, uint32_t value)
Definition: taf_ks_client.c:664
le_result_t taf_ks_TryConnectService(void)
Definition: taf_ks_client.c:323
le_result_t taf_ks_DeleteKey(taf_ks_KeyRef_t keyRef)
Definition: taf_ks_client.c:616
le_result_t taf_ks_ProvisionRsaEncKeyValue(taf_ks_KeyRef_t keyRef, taf_ks_RsaKeySize_t keySize, taf_ks_RsaEncPadding_t padding, const uint8_t *impDataPtr, size_t impDataSize)
Definition: taf_ks_client.c:829
taf_ks_RsaSigPadding_t
Definition: taf_ks_common.h:256
le_result_t taf_ks_GetKey(const char *LE_NONNULL keyName, taf_ks_KeyRef_t *keyRefPtr)
Definition: taf_ks_client.c:590
le_result_t taf_ks_SetKeyAppData(taf_ks_KeyRef_t keyRef, const uint8_t *dataPtr, size_t dataSize)
Definition: taf_ks_client.c:718
le_result_t taf_ks_SetKeyOriginationExpireDateTime(taf_ks_KeyRef_t keyRef, uint64_t value)
Definition: taf_ks_client.c:773
struct taf_ks_Key * taf_ks_KeyRef_t
Definition: taf_ks_common.h:320
le_result_t taf_ks_CryptoSessionSetAppData(taf_ks_CryptoSessionRef_t sessionRef, const uint8_t *dataPtr, size_t dataSize)
Definition: taf_ks_client.c:1125
le_result_t taf_ks_CryptoSessionProcess(taf_ks_CryptoSessionRef_t sessionRef, const uint8_t *inputDataPtr, size_t inputDataSize, uint8_t *outputDataPtr, size_t *outputDataSizePtr)
Definition: taf_ks_client.c:1221
LE_FULL_API void taf_ks_SetServerDisconnectHandler(taf_ks_DisconnectHandler_t disconnectHandler, void *contextPtr)
Definition: taf_ks_client.c:380
taf_ks_EccKeySize_t
Definition: taf_ks_common.h:113
le_result_t taf_ks_GetKeyUsage(taf_ks_KeyRef_t keyRef, taf_ks_KeyUsage_t *keyUsagePtr)
Definition: taf_ks_client.c:639
le_result_t taf_ks_CryptoSessionSetAesNonce(taf_ks_CryptoSessionRef_t sessionRef, const uint8_t *dataPtr, size_t dataSize)
Definition: taf_ks_client.c:1092
void taf_ks_DisconnectService(void)
Definition: taf_ks_client.c:503
le_result_t taf_ks_CryptoSessionEnd(taf_ks_CryptoSessionRef_t sessionRef, const uint8_t *inputDataPtr, size_t inputDataSize, uint8_t *outputDataPtr, size_t *outputDataSizePtr)
Definition: taf_ks_client.c:1267
le_result_t taf_ks_CryptoSessionProcessAead(taf_ks_CryptoSessionRef_t sessionRef, const uint8_t *dataPtr, size_t dataSize)
Definition: taf_ks_client.c:1188
le_result_t taf_ks_SetKeyMinSecondsBetweenOps(taf_ks_KeyRef_t keyRef, uint32_t value)
Definition: taf_ks_client.c:689
taf_ks_RsaKeySize_t
Definition: taf_ks_common.h:73
LE_FULL_API void taf_ks_SetNonExitServerDisconnectHandler(taf_ks_DisconnectHandler_t disconnectHandler, void *contextPtr)
Definition: taf_ks_client.c:457
le_result_t taf_ks_CryptoSessionAbort(taf_ks_CryptoSessionRef_t sessionRef)
Definition: taf_ks_client.c:1309
le_result_t taf_ks_CreateKey(const char *LE_NONNULL keyName, taf_ks_KeyUsage_t keyUsage, taf_ks_KeyRef_t *keyRefPtr)
Definition: taf_ks_client.c:561
le_result_t taf_ks_ExportKey(taf_ks_KeyRef_t keyRef, const uint8_t *appDataPtr, size_t appDataSize, uint8_t *expDataPtr, size_t *expDataSizePtr)
Definition: taf_ks_client.c:1029
taf_ks_AesKeySize_t
Definition: taf_ks_common.h:94
le_result_t taf_ks_ProvisionHmacKeyValue(taf_ks_KeyRef_t keyRef, uint32_t keySize, taf_ks_Digest_t digest, const uint8_t *impDataPtr, size_t impDataSize)
Definition: taf_ks_client.c:989
le_result_t taf_ks_ProvisionAesKeyValue(taf_ks_KeyRef_t keyRef, taf_ks_AesKeySize_t keySize, taf_ks_AesBlockMode_t mode, const uint8_t *impDataPtr, size_t impDataSize)
Definition: taf_ks_client.c:949
le_result_t taf_ks_SetKeyUsageExpireDateTime(taf_ks_KeyRef_t keyRef, uint64_t value)
Definition: taf_ks_client.c:799
le_result_t taf_ks_CryptoSessionStart(taf_ks_CryptoSessionRef_t sessionRef, taf_ks_CryptoPurpose_t cryptoPurpose)
Definition: taf_ks_client.c:1158
#define LE_NONNULL
Definition: le_basics.h:368
void(* taf_ks_DisconnectHandler_t)(void *)
Definition: taf_ks_interface.h:179
taf_ks_CryptoPurpose_t
Definition: taf_ks_common.h:177
taf_ks_Digest_t
Definition: taf_ks_common.h:198
le_result_t
Definition: le_basics.h:45
le_result_t taf_ks_ProvisionEcdsaKeyValue(taf_ks_KeyRef_t keyRef, taf_ks_EccKeySize_t keySize, taf_ks_Digest_t digest, const uint8_t *impDataPtr, size_t impDataSize)
Definition: taf_ks_client.c:909
void taf_ks_ConnectService(void)
Definition: taf_ks_client.c:291
taf_ks_KeyUsage_t
Definition: taf_ks_common.h:134
#define LE_FULL_API
Definition: le_apiFeatures.h:42
struct taf_ks_CryptoSession * taf_ks_CryptoSessionRef_t
Definition: taf_ks_common.h:328
le_result_t taf_ks_CryptoSessionCreate(taf_ks_KeyRef_t keyRef, taf_ks_CryptoSessionRef_t *sessionRefPtr)
Definition: taf_ks_client.c:1064
le_result_t taf_ks_SetKeyActiveDateTime(taf_ks_KeyRef_t keyRef, uint64_t value)
Definition: taf_ks_client.c:747
taf_ks_AesBlockMode_t
Definition: taf_ks_common.h:295
taf_ks_RsaEncPadding_t
Definition: taf_ks_common.h:225