diff options
Diffstat (limited to 'mobicore/MobiCoreDriverLib/Registry/PrivateRegistry.h')
| -rw-r--r-- | mobicore/MobiCoreDriverLib/Registry/PrivateRegistry.h | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/mobicore/MobiCoreDriverLib/Registry/PrivateRegistry.h b/mobicore/MobiCoreDriverLib/Registry/PrivateRegistry.h new file mode 100644 index 0000000..e885d8c --- /dev/null +++ b/mobicore/MobiCoreDriverLib/Registry/PrivateRegistry.h @@ -0,0 +1,215 @@ +/* + * Copyright (c) 2013 TRUSTONIC LIMITED + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. Neither the name of the TRUSTONIC LIMITED nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; + * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** + * MobiCore Registry Private implementation + */ +#ifndef MOBICORE_REGISTRY_H_ +#define MOBICORE_REGISTRY_H_ + +#include "MobiCoreDriverApi.h" +#include "mcContainer.h" + +#ifdef __cplusplus +extern "C" { +#endif + + /** + * Registry object. + */ + typedef struct { + uint32_t len; + uint32_t tlStartOffset; + uint8_t value[]; + } regObject_t; + +//----------------------------------------------------------------- + + /** Stores an authentication token in registry. + * @param so Authentication token secure object. + * @param size Authentication token secure object size. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryStoreAuthToken(void *so, uint32_t size); + + /** Reads an authentication token from registry. + * @param[out] so Authentication token secure object. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryReadAuthToken(mcSoAuthTokenCont_t *so); + + /** Reads an authentication token backup from registry. + * @param[out] so Authentication token secure object. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryReadAuthTokenBackup(mcSoAuthTokenCont_t *so); + + /** Deletes the authentication token secure object from the registry. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryDeleteAuthToken(void); + + /** Stores a root container secure object in the registry. + * @param so Root container secure object. + * @param size Root container secure object size. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryStoreRoot(void *so, uint32_t size); + + /** Reads a root container secure object from the registry. + * @param[out] so Root container secure object. + * @param[out] size Root container secure object size + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryReadRoot(void *so, uint32_t *size); + + /** Stores a service provider container secure object in the registry. + * @param spid Service provider ID. + * @param so Service provider container secure object. + * @param size Service provider container secure object size. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryStoreSp(mcSpid_t spid, void *so, uint32_t size); + + /** Reads a service provider container secure object from the registry. + * @param spid Service provider ID. + * @param[out] so Service provider container secure object. + * @param[out] size Service provider container secure object size + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryReadSp(mcSpid_t spid, void *so, uint32_t *size); + + /** Deletes a service provider recursively, including all trustlets and + * data. + * @param spid Service provider ID. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryCleanupSp(mcSpid_t spid); + + /** Stores a trustlet container secure object in the registry. + * @param uuid Trustlet UUID. + * @param so Trustlet container secure object. + * @param size Trustlet container secure object size + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryStoreTrustletCon(const mcUuid_t *uuid, const mcSpid_t spid, void *so, uint32_t size); + + /** Reads a trustlet container secure object from the registry. + * @param uuid Trustlet UUID. + * @param spid SPID of the trustlet container + * @param[out] so Trustlet container secure object. + * @param[out] size Trustlet container secure object size + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryReadTrustletCon(const mcUuid_t *uuid, const mcSpid_t spid, void *so, uint32_t *size); + + /** Deletes a trustlet container secure object and all of its associated data. + * @param uuid Trustlet UUID. + * @param spid Service provider ID + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryCleanupTrustlet(const mcUuid_t *uuid, const mcSpid_t spid); + + /** Stores a data container secure object in the registry. + * @param so Data container secure object. + * @param size Data container secure object size + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryStoreData(void *so, uint32_t size); + + /** Reads a data container secure object from the registry. + * @param context (service provider = 0; trustlet = 1). + * @param cid Service provider or UUID. + * @param pid Personalization data identifier. + * @param[out] so Data container secure object. + * @param maxLen Maximum size (in bytes) of the destination buffer (so). + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryReadData( + uint32_t context, + const mcCid_t *cid, + mcPid_t pid, + mcSoDataCont_t *so, + uint32_t maxLen); + + /** Deletes the root container and all of its associated service provider + * containers. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryCleanupRoot(void); + + /** Returns a registry object for a given service from memory + * @param spid Service provider ID(ignored for System TLs) + * @param trustlet buffer with trustlet binary + * @param tlSize buffer size + * @return Registry object. + * @note It is the responsibility of the caller to free the registry object + * allocated by this function. + */ + regObject_t *mcRegistryMemGetServiceBlob(mcSpid_t spid, void *trustlet, uint32_t tlSize); + + /** Returns a registry object for a given service. + * @param uuid service UUID + * @return Registry object. + * @note It is the responsibility of the caller to free the registry object + * allocated by this function. + */ + regObject_t *mcRegistryGetServiceBlob(const mcUuid_t *uuid, bool isGpUuid); + + /** Returns a registry object for a given service. + * @param uuid service GP UUID as mc uuid + * @return Registry object. + * @note It is the responsibility of the caller to free the registry object + * allocated by this function. + */ + regObject_t *mcRegistryGetServiceBlobGP(const mcUuid_t *uuid); + + /** Returns a registry object for a given service. + * @param driverFilename driver filename + * @return Registry object. + * @note It is the responsibility of the caller to free the registry object + * allocated by this function. + */ + regObject_t *mcRegistryGetDriverBlob(const char *filename); + + /** Stores a Trustlet Application blob in the registry. + * @param spid SPID of the trustlet container. + * @param blob Trustlet Application blob. + * @param size Trustlet Application blob size. + * @return MC_DRV_OK if successful, otherwise error code. + */ + mcResult_t mcRegistryStoreTABlob(mcSpid_t spid, void *blob, uint32_t size); + +#ifdef __cplusplus +} +#endif + +#endif // MOBICORE_REGISTRY_H_ + |