Update documents in doc/ 12/112812/1
authorKyungwook Tak <k.tak@samsung.com>
Fri, 3 Feb 2017 02:13:09 +0000 (11:13 +0900)
committerKyungwook Tak <k.tak@samsung.com>
Fri, 3 Feb 2017 02:15:40 +0000 (11:15 +0900)
Change-Id: I3de73523d2a51f8508482247eddb2bc2a0078ad7
Signed-off-by: Kyungwook Tak <k.tak@samsung.com>
doc/key-manager-client_doc.h
doc/key-manager-types_doc.h
doc/key-manager_doc.h

index 25720cc..b17a65c 100644 (file)
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+
 #ifndef __TIZEN_CORE_KEY_MANAGER_CLIENT_DOC_H__
 #define __TIZEN_CORE_KEY_MANAGER_CLIENT_DOC_H__
+
+
 /**
  * @ingroup CAPI_KEY_MANAGER_MODULE
  * @defgroup CAPI_KEY_MANAGER_CLIENT_MODULE Key Manager Client
- * @brief    It provides APIs accessing on the secure repository and additional secure cryptographic operations.
- *
+ * @brief It provides APIs accessing on the secure repository and additional secure cryptographic operations.
  * @section CAPI_KEY_MANAGER_CLIENT_MODULE_HEADER Required Header
  * \#include <ckmc/ckmc-manager.h>
  *
@@ -28,4 +31,5 @@
  * Additionally, it provides secure cryptographic operations for non-exportable keys without revealing key values to clients.
  */
 
+
 #endif /* __TIZEN_CORE_KEY_MANAGER_CLIENT_DOC_H__ */
index c13d822..8c975b8 100644 (file)
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+
 #ifndef __TIZEN_CORE_KEY_MANAGER_TYPES_DOC_H__
 #define __TIZEN_CORE_KEY_MANAGER_TYPES_DOC_H__
+
+
 /**
  * @ingroup CAPI_KEY_MANAGER_MODULE
  * @defgroup CAPI_KEY_MANAGER_TYPES_MODULE Key Manager Data Types
- * @brief    It defines data types used in these APIs and provides utility methods handling them.
- *
+ * @brief It defines data types used in these APIs and provides utility methods handling them.
  * @section CAPI_KEY_MANAGER_TYPES_MODULE_HEADER Required Header
  * \#include <ckmc/ckmc-type.h>
  *
  * @section CAPI_KEY_MANAGER_TYPES_MODULE_OVERVIEW Overview
- * It defines data types for key, certificate,raw buffer, and linked list used in these APIs.
+ * It defines data types for key, certificate, raw buffer, and linked list used in these APIs.
  * It also provides new and free methods for them.
- *
  */
 
 #endif /* __TIZEN_CORE_KEY_MANAGER_TYPES_DOC_H__ */
index d34293f..776a124 100644 (file)
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+
 #ifndef __TIZEN_CORE_KEY_MANAGER_DOC_H__
 #define __TIZEN_CORE_KEY_MANAGER_DOC_H__
+
+
 /**
  * @ingroup CAPI_SECURITY_FRAMEWORK
  * @defgroup CAPI_KEY_MANAGER_MODULE Key Manager
- * @brief    The key manager provides a secure repository protected by Tizen platform for keys, certificates, and sensitive data of users and/or their APPs.
- *           Additionally, the key manager provides secure cryptographic operations for non-exportable keys without revealing key values to clients.
- *
+ * @brief The key manager provides a secure repository protected by Tizen platform for keys, certificates, and sensitive data of users and/or their APPs.
+ *        Additionally, the key manager provides secure cryptographic operations for non-exportable keys without revealing key values to clients.
  * @section CAPI_KEY_MANAGER_MODULE_OVERVIEW Overview
  * <table>
  *   <tr><th>API</th><th>Description</th></tr>
  *     <td> Defines data types used in these APIs and provides utility methods handling them.</td>
  *   </tr>
  * </table>
- *
  * It provides a secure repository for keys, certificates, and sensitive data of users and/or their APPs which are protected by Tizen platform.
  * Additionally, it provides secure cryptographic operations for non-exportable keys without revealing key values to clients.
  *
  * @image html capi_key_manager_overview_diagram.png
- *
  * The key manager provides 2 types of API.
- * - secure repository APIs : These APIs provides storing, retrieving, and removing functions for keys, certificates, and data.
- * - secure crypto APIs : These APIs provides additional cryptographic operations (create asymmetric key pair, sign/verify signature, verify certificate).
- *
+ * - secure repository APIs: These APIs provides storing, retrieving, and removing functions for keys, certificates, and data.
+ * - secure crypto APIs: These APIs provides additional cryptographic operations (create asymmetric key pair, sign/verify signature, verify certificate).
  * Data Store Policy:
- *   A client can specify simple access rules when storing data in Key Manager.
+ *   A client can specify simple access rules when storing data in Key Manager.
  *   - Exportable/Non-Exportable:
  *     Only for data tagged as exportable, Key Manager returns the raw value of the data.
  *     If data is tagged as non-exportable, Key Manager does not return its raw value.
  *     All data in Key Manager is protected by Tizen platform.
  *     Besides, a client can encrypt its data using its own password additionally.
  *     If a client provides a password when storing a data, the data will be encrypted with the password.
- *     This password should be provided when get the data from Key Manager.
- *
+ *     This password should be provided when getting the data from Key Manager.
  * Data Access Control
  *   - By default, only the owner of a data can access to the data.
  *   - If the owner grants the access to other applications, those applications can read or delete the data from key-manager DB.
  *   - When an application is deleted, the data and access control information granted by the application are also removed.
- *
  * Alias Format
  *   - The format of alias is "package_id name".
  *   - If package_id is not provided by a client, the key-manager will add the package_id of the client to the name internally.
  *   - The client can specify only its own package id in the alias when storing a key, certificate, or data.
  *   - A client should specify the package id of the owner in the alias to retrieve a a key, certificate, or data shared by other applications.
  *   - Aliases are returned as the format of "package_id name" from the key-manager.
- *
  */
 
+
 #endif /* __TIZEN_CORE_KEY_MANAGER_DOC_H__ */