From b4b0b29a410b148682cf060ee17a5948a14e677f Mon Sep 17 00:00:00 2001 From: sangsu Date: Thu, 2 Jun 2016 07:21:24 +0900 Subject: [PATCH] ACR:add doc document headers Change-Id: Iafad752ca1980993c706434f34e136f44ffe3a91 Signed-off-by: sangsu --- doc/yaca_doc.h | 62 +++++++++++++++++++++++++++++++++++++++++++++++ doc/yaca_encryption_doc.h | 35 ++++++++++++++++++++++++++ doc/yaca_integrity_doc.h | 32 ++++++++++++++++++++++++ doc/yaca_key_doc.h | 31 ++++++++++++++++++++++++ doc/yaca_simple_doc.h | 31 ++++++++++++++++++++++++ 5 files changed, 191 insertions(+) create mode 100755 doc/yaca_doc.h create mode 100755 doc/yaca_encryption_doc.h create mode 100755 doc/yaca_integrity_doc.h create mode 100755 doc/yaca_key_doc.h create mode 100755 doc/yaca_simple_doc.h diff --git a/doc/yaca_doc.h b/doc/yaca_doc.h new file mode 100755 index 0000000..e63e233 --- /dev/null +++ b/doc/yaca_doc.h @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2016 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_YACA_DOC_H__ +#define __TIZEN_CORE_YACA_DOC_H__ +/** + * @ingroup CAPI_SECURITY_FRAMEWORK + * @defgroup CAPI_YACA_MODULE yaca crypto module + * @brief The yaca(yet another crypto api) provides a crypto function such as key management , Data Integrity and data en/decryption . + * Key mangement provides APIs for generating secured key,importing a key trying to match it to the key_type specified and exporting a key to arbitrary format. + * Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digest and digital signature. + * Data en/decryption provides Advanced/Simpled APIs for en/decrypting and sealing/opening a data. + * + * @section CAPI_YACA_MODULE_OVERVIEW Overview + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
APIDescription
@ref CAPI_YACA_ENCRYPTION_MODULE Provides APIs for encryption/decryption operations with symmetric keys and sealing/opening operations with asymmetric keys.
@ref CAPI_YACA_INTEGRITY_MODULE Provides APIs for creating/verifying a signature, calculating HMAC/CMAC and calculating a message digest.
@ref CAPI_YACA_KEY_MODULE Provides APIs for key handling operations such as generating, importing, and exporting a key and deriving a key from password.
@ref CAPI_YACA_SIMPLE_MODULE Provides simple APIs for cryptographic operations.
+ * + * The yaca provides a crypto function such as key management, integrity handling and data en/decryption. + * Key mangement provides APIs for generating secured key, importing a key trying to match it to the key_type specified and exporting a key to arbitrary format. + * Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digests and digital signature. + * Data en/decryption provides Advanced/Simpled APIs for en/decrypting and sealing/opening a data. + * + * @image html capi_yaca_overview_diagram.png + * + * The yaca provides 3 types of API. + * - key management APIs : These APIs provides generating key using random number or password, importing a key trying to match it to the key_type specified and exporting a key to arbitrary format. + * - data en/decryption APIs : These APIs provides Advanced/Simpled API for the data encryption. + * - integrity APIs : These APIs provides creating a signature using asymmetric private key, verifing a signature using asymmetric public key, calculating a HMAC/CMAC of given message using symmetric key and calculating message digests of given message without key. + * + * + */ + +#endif /* __TIZEN_CORE_YACA_DOC_H__ */ diff --git a/doc/yaca_encryption_doc.h b/doc/yaca_encryption_doc.h new file mode 100755 index 0000000..2fd3978 --- /dev/null +++ b/doc/yaca_encryption_doc.h @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2016 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_YACA_ENCRYPTION_DOC_H__ +#define __TIZEN_CORE_YACA_ENCRYPTION_DOC_H__ +/** + * @ingroup CAPI_YACA_MODULE + * @defgroup CAPI_YACA_ENCRYPTION_MODULE yaca encryption module + * @brief Provides APIs for encryption and decryption operations. + * + * @section CAPI_YACA_ENCRYPTION_MODULE_HEADER Required Header + * \#include + * \#include + * \#include + * \#include + * \#include + * + * @section CAPI_YACA_ENCRYPTION_MODULE_OVERVIEW Overview + * It provides advanced APIs for encryption/decryption operations with symmetric keys and sealing/opening operations with asymmetric keys. + * + */ + +#endif /* __TIZEN_CORE_YACA_ENCRYPTION_DOC_H__ */ diff --git a/doc/yaca_integrity_doc.h b/doc/yaca_integrity_doc.h new file mode 100755 index 0000000..4ca565c --- /dev/null +++ b/doc/yaca_integrity_doc.h @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2016 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_YACA_INTEGRITY_DOC_H__ +#define __TIZEN_CORE_YACA_INTEGRITY_DOC_H__ +/** + * @ingroup CAPI_YACA_MODULE + * @defgroup CAPI_YACA_INTEGRITY_MODULE yaca integrity module + * @brief Provides APIs for creating/verifying a signature and digesting a message. + * + * @section CAPI_YACA_INTEGRITY_MODULE_HEADER Required Header + * \#include + * \#include + * + * @section CAPI_YACA_INTEGRITY_MODULE_OVERVIEW Overview + * It provides advanced APIs for creating a signature using asymmetric private key, verifing a signature using asymmetric public key, calculating a HMAC/CMAC of given message using symmetric key and calculating message digests of given message without key. + * + */ + +#endif /* __TIZEN_CORE_YACA_INTEGRITY_DOC_H__ */ diff --git a/doc/yaca_key_doc.h b/doc/yaca_key_doc.h new file mode 100755 index 0000000..ff887f3 --- /dev/null +++ b/doc/yaca_key_doc.h @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2016 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_YACA_KEY_DOC_H__ +#define __TIZEN_CORE_YACA_KEY_DOC_H__ +/** + * @ingroup CAPI_YACA_MODULE + * @defgroup CAPI_YACA_KEY_MODULE yaca key management module + * @brief Provides APIs for key handling operations such as generating and importing a key. + * + * @section CAPI_YACA_KEY_MODULE_HEADER Required Header + * \#include + * + * @section CAPI_YACA_KEY_MODULE_OVERVIEW Overview + * It provides APIs for generating key using random number or password, importing a key trying to match it to the key_type specified and exporting a key to arbitrary format. + * + */ + +#endif /* __TIZEN_CORE_YACA_KEY_DOC_H__ */ diff --git a/doc/yaca_simple_doc.h b/doc/yaca_simple_doc.h new file mode 100755 index 0000000..a4e6982 --- /dev/null +++ b/doc/yaca_simple_doc.h @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2016 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_YACA_SIMPLE_DOC_H__ +#define __TIZEN_CORE_YACA_SIMPLE_DOC_H__ +/** + * @ingroup CAPI_YACA_MODULE + * @defgroup CAPI_YACA_SIMPLE_MODULE yaca simple crypto module + * @brief Provides simple APIs for cryptographic operations. + * + * @section CAPI_YACA_SIMPLE_MODULE_HEADER Required Header + * \#include + * + * @section CAPI_YACA_SIMPLE_MODULE_OVERVIEW Overview + * It provides simple APIs for encryption/decryption, signing/verification, and message digestion. + * + */ + +#endif /* __TIZEN_CORE_YACA_SIMPLE_DOC_H__ */ -- 2.7.4