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
|
/*
* Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* 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 a user’s passwords 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>
* <tr>
* <td> @ref CAPI_KEY_MANAGER_CLIENT_MODULE</td>
* <td> Provides APIs for accessing the secure repository and additional secure cryptographic operations.</td>
* </tr>
* <tr>
* <td> @ref CAPI_KEY_MANAGER_TYPES_MODULE</td>
* <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 a user’s passwords.
* 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).
*
* Data Store Policy:
* A client can specify simple access rules when storing a 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.
* In that case, Key Manager provides secure cryptographic operations for non-exportable keys without revealing key values to clients.
* - Per Key Password:
* All data in Key Manager is protected by a user’s password.
* 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.
*
* User Login/Logout and Data Protection
* - When a user logs in, logs out or changes his/her password, Key Manager should know about it.
* Privileged APPs such as LockScreen APP or Setting APP can notify the key manager using these control APIs.
* - When a user logs in, the key manager decrypts the user's DKEK (with which a user's data file is encrypted) with a user password.
* So during the login period, any client can access its data which is protected by a user's password.
* "user key" in API means DKEK.
* - When a user logs out, the key manager removes the user's DKEK from memory.
* Therefore, clients cannot access any data.
* - When a user changes his/her password, the key manager re-encrypts the user's DKEK with the new password.
*
* 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__ */
|
