From 362ab058daa253e9a0bd816962743f8c06a751d2 Mon Sep 17 00:00:00 2001 From: "sangwan.kwon" Date: Thu, 16 Mar 2017 17:45:49 +0900 Subject: [PATCH] Add API headers and build/packaging system Change-Id: I11178429164b9c60e6e0f76d8e9c5fdad1e8a918 Signed-off-by: sangwan.kwon --- CMakeLists.txt | 31 +++++ LICENSE | 202 ++++++++++++++++++++++++++++++++ api/CMakeLists.txt | 20 ++++ api/tanchor/error.h | 55 +++++++++ api/tanchor/trust-anchor.h | 152 ++++++++++++++++++++++++ api/tanchor/trust-anchor.hxx | 57 +++++++++ packaging/trust-anchor.manifest | 5 + packaging/trust-anchor.spec | 44 +++++++ 8 files changed, 566 insertions(+) create mode 100644 CMakeLists.txt create mode 100644 LICENSE create mode 100644 api/CMakeLists.txt create mode 100644 api/tanchor/error.h create mode 100644 api/tanchor/trust-anchor.h create mode 100644 api/tanchor/trust-anchor.hxx create mode 100644 packaging/trust-anchor.manifest create mode 100644 packaging/trust-anchor.spec diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..3026802 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,31 @@ +# Copyright (c) 2017 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 +# +# @file CMakeLists.txt +# @author Sangwan kwon (sangwan.kwon@samsung.com) +# + +CMAKE_MINIMUM_REQUIRED (VERSION 2.8) + +PROJECT(trust-anchor) + +IF(NOT DEFINED INCLUDE_INSTALL_DIR) + SET(INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR}") +ENDIF(NOT DEFINED INCLUDE_INSTALL_DIR) + +SET(TANCHOR_INCLUDE ${PROJECT_SOURCE_DIR}/api/tanchor) + +CONFIGURE_FILE(packaging/trust-anchor.manifest trust-anchor.manifest) + +ADD_SUBDIRECTORY(api) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/api/CMakeLists.txt b/api/CMakeLists.txt new file mode 100644 index 0000000..92506c9 --- /dev/null +++ b/api/CMakeLists.txt @@ -0,0 +1,20 @@ +# Copyright (c) 2017 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 +# +# @file CMakeLists.txt +# @author Sangwan kwon (sangwan.kwon@samsung.com) +# + +INSTALL(DIRECTORY ${TANCHOR_INCLUDE} + DESTINATION ${INCLUDE_INSTALL_DIR}) diff --git a/api/tanchor/error.h b/api/tanchor/error.h new file mode 100644 index 0000000..68463a3 --- /dev/null +++ b/api/tanchor/error.h @@ -0,0 +1,55 @@ +/* + * Copyright (c) 2017 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 + */ + + +/** + * @file error.h + * @brief Error enums and defines. + */ + + +#ifndef TRUST_ANCHOR_ERROR_H +#define TRUST_ANCHOR_ERROR_H + + +#include + + +#ifdef __cplusplus +extern "C" { +#endif + + +#define TRUST_ANCHOR_ERROR_BASE -0x01000000 + + +/** + * @brief Enumeration for trust anchor error values. + */ +typedef enum { + TRUST_ANCHOR_ERROR_NONE = 0, + TRUST_ANCHOR_ERROR_INVALID_PARAMETER = -EINVAL, + TRUST_ANCHOR_ERROR_OUT_OF_MEMORY = -ENOMEM, + TRUST_ANCHOR_ERROR_INTERNAL = TRUST_ANCHOR_ERROR_BASE | 0x01 +} trust_anchor_error_e; + + +#ifdef __cplusplus +} /* extern */ +#endif + + +#endif /* TRUST_ANCHOR_ERROR_H */ diff --git a/api/tanchor/trust-anchor.h b/api/tanchor/trust-anchor.h new file mode 100644 index 0000000..284dd25 --- /dev/null +++ b/api/tanchor/trust-anchor.h @@ -0,0 +1,152 @@ +/* + * Copyright (c) 2017 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 + */ + + +/** + * @file trust-anchor.h + * @brief Trust anchor CAPI header + */ + + +#ifndef TRUST_ANCHOR_H +#define TRUST_ANCHOR_H + + +#include +#include + + +#ifdef __cplusplus +extern "C" { +#endif + + +/** + * @brief Install trust anchor for global app. + * @details App custom certificates would be installed on system. + * This function should be called before trust_anchor_global_launch(). + * @param[in] package_id Global package id + * @param[in] app_certificates_path App custom certificates path + * @param[in] with_system_certificates Whether system certificates use or not + * @return #TRUST_ANCHOR_ERROR_NONE on success, + * negative on error + * @retval #TRUST_ANCHOR_ERROR_NONE Successful + * @retval #TRUST_ANCHOR_ERROR_OUT_OF_MEMORY Out of memory error + * @retval #TRUST_ANCHOR_ERROR_INTERNAL Internal error + * @see trust_anchor_global_launch() + * @see trust_anchor_global_uninstall() + */ +int trust_anchor_global_install(const char *package_id, + const char *app_certificates_path, + bool with_system_certificates); + + +/** + * @brief Install trust anchor for user app. + * @details App custom certificates would be installed on system. + * This function should be called before trust_anchor_usr_launch(). + * @param[in] package_id User package id + * @param[in] app_certificates_path App custom certificates path + * @param[in] uid user id + * @param[in] with_system_certificates Whether system certificates use or not + * @return #TRUST_ANCHOR_ERROR_NONE on success, + * negative on error + * @retval #TRUST_ANCHOR_ERROR_NONE Successful + * @retval #TRUST_ANCHOR_ERROR_OUT_OF_MEMORY Out of memory error + * @retval #TRUST_ANCHOR_ERROR_INTERNAL Internal error + * @see trust_anchor_usr_launch() + * @see trust_anchor_usr_uninstall() + */ +int trust_anchor_usr_install(const char *package_id, + const char *app_certificates_path, + uid_t uid, + bool with_system_certificates); + + +/** + * @brief Launch trust anchor for global app. + * @details After lauching trust anchor, app can use custom certificates. + * @param[in] package_id Global package id + * @param[in] app_certificates_path App custom certificates path + * @param[in] with_system_certificates Whether system certificates use or not + * @return #TRUST_ANCHOR_ERROR_NONE on success, + * negative on error + * @retval #TRUST_ANCHOR_ERROR_NONE Successful + * @retval #TRUST_ANCHOR_ERROR_OUT_OF_MEMORY Out of memory error + * @retval #TRUST_ANCHOR_ERROR_INTERNAL Internal error + * @see trust_anchor_global_install() + */ +int trust_anchor_global_launch(const char *package_id, + const char *app_certificates_path, + bool with_system_certificates); + + +/** + * @brief Launch trust anchor for user app. + * @details After lauching trust anchor, app can use custom certificates. + * @param[in] package_id User package id + * @param[in] app_certificates_path App custom certificates path + * @param[in] with_system_certificates Whether system certificates use or not + * @return #TRUST_ANCHOR_ERROR_NONE on success, + * negative on error + * @retval #TRUST_ANCHOR_ERROR_NONE Successful + * @retval #TRUST_ANCHOR_ERROR_OUT_OF_MEMORY Out of memory error + * @retval #TRUST_ANCHOR_ERROR_INTERNAL Internal error + * @see trust_anchor_global_install() + */ +int trust_anchor_usr_launch(const char *package_id, + const char *app_certificates_path, + uid_t uid, + bool with_system_certificates); + + +/** + * @brief Uninstall trust anchor for global app. + * @param[in] package_id Global package id + * @param[in] app_certificates_path App custom certificates path + * @return #TRUST_ANCHOR_ERROR_NONE on success, + * negative on error + * @retval #TRUST_ANCHOR_ERROR_NONE Successful + * @retval #TRUST_ANCHOR_ERROR_OUT_OF_MEMORY Out of memory error + * @retval #TRUST_ANCHOR_ERROR_INTERNAL Internal error + * @see trust_anchor_global_install() + */ +int trust_anchor_global_uninstall(const char *package_id, + const char *app_certificates_path); + + +/** + * @brief Uninstall trust anchor for user app. + * @param[in] package_id User package id + * @param[in] app_certificates_path App custom certificates path + * @return #TRUST_ANCHOR_ERROR_NONE on success, + * negative on error + * @retval #TRUST_ANCHOR_ERROR_NONE Successful + * @retval #TRUST_ANCHOR_ERROR_OUT_OF_MEMORY Out of memory error + * @retval #TRUST_ANCHOR_ERROR_INTERNAL Internal error + * @see trust_anchor_usr_install() + */ +int trust_anchor_usr_uninstall(const char *package_id, + const char *app_certificates_path, + uid_t uid); + + +#ifdef __cplusplus +} /* extern */ +#endif + + +#endif /* TRUST_ANCHOR_H */ diff --git a/api/tanchor/trust-anchor.hxx b/api/tanchor/trust-anchor.hxx new file mode 100644 index 0000000..fe165eb --- /dev/null +++ b/api/tanchor/trust-anchor.hxx @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2017 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 + */ + + +/** + * @file trust-anchor.hxx + * @brief Trust anchor C++ API header + */ + + +#pragma once + + +#include +#include +#include + + +namespace tanchor { + +class TrustAnchor { +public: + explicit TrustAnchor(const std::string &packageId, + const std::string &certsDir, + uid_t uid) noexcept; + explicit TrustAnchor(const std::string &packageId, + const std::string &certsDir) noexcept; + virtual ~TrustAnchor(void); + + TrustAnchor(const TrustAnchor &) = delete; + TrustAnchor(TrustAnchor &&) = delete; + TrustAnchor &operator=(const TrustAnchor &) = delete; + TrustAnchor &operator=(TrustAnchor &&) = delete; + + int install(bool withSystemCerts) noexcept; + int uninstall(void) noexcept; + int launch(bool withSystemCerts) noexcept; + +private: + class Impl; + std::unique_ptr m_pImpl; +}; + +} // namespace tanchor diff --git a/packaging/trust-anchor.manifest b/packaging/trust-anchor.manifest new file mode 100644 index 0000000..a76fdba --- /dev/null +++ b/packaging/trust-anchor.manifest @@ -0,0 +1,5 @@ + + + + + diff --git a/packaging/trust-anchor.spec b/packaging/trust-anchor.spec new file mode 100644 index 0000000..a3e2110 --- /dev/null +++ b/packaging/trust-anchor.spec @@ -0,0 +1,44 @@ +Name: trust-anchor +Version: 0.0.1 +Release: 0 +License: Apache-2.0 +Source0: file://%{name}-%{version}.tar.gz +Summary: Trust Anchor API +Group: Security/Certificate Management +BuildRequires: gcc +BuildRequires: cmake + +%description +The package provides trust-anchor which the application can assign +SSL root certificates for its HTTPS communication. + +%files +%manifest %{name}.manifest +%license LICENSE + +%prep +%setup -q + +%build +%{!?build_type:%define build_type "RELEASE"} + +%cmake . -DCMAKE_BUILD_TYPE=%{build_type} + +make %{?_smp_mflags} + +%install +%make_install + +## Devel Package ############################################################### +%package devel +Summary: Trust Anchor API (development files) +Group: Security/Development +Requires: %{name} = %{version}-%{release} + +%description devel +The package provides Trust Anchor API development files. + +%files devel +%{_includedir}/tanchor/error.h +%{_includedir}/tanchor/trust-anchor.h +%{_includedir}/tanchor/trust-anchor.hxx -- 2.34.1