7 Star 4 Fork 8

caixindi / oss-fuzz-openeuler

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

OSS-Fuzz 移植项目简介

项目需求

本项目针对开展在 openEuler 上构建 OSS-Fuzz 的容器镜像,实现 OSS-Fuzz 容器从 Ubuntu 到 openEuler 的迁移,并完成 24 个软件包的 OSS-Fuzz 测试。

环境要求

  1. x86架构
  2. openEuler 20.03 LTS SP3 和 openEuler 22.03-LTS

验收要求

  1. 四种引擎支持:libfuzzer、afl、honggfuzz、dataflow
  2. 检测功能支持:address、memory、undefined、dataflow
  3. 多语言支持:C/C++、Go、Java、Python、Rust、Swift
  4. OSS-Fuzz 基础镜像的 Dockerfile
  5. 自动化用例
  6. 测试报告

项目相关链接

OSS-Fuzz 官方介绍

OSS-Fuzz-README.md

基础镜像移植思路

移植思路:

  1. 替换基础镜像(ubuntu:20.04 --> openeuler/openeuler:20.03-lts-sp3)

  2. 替换包管理工具(apt-get --> yum

  3. 替换软件包,软件包源

    • 先尝试是否可以安装同名包(apt-get install -y wget --> yum install -y wget
    • 如果没有同名包,则安装相同作用的包(apt-get install -y libc6-dev --> yum install -y glibc-devel
  4. 构建基于 openEuler 的镜像(docker build -t fuzz-base-image:alpha1 .),根据构建过程中的错误 log 修改 Dockerfile 直至镜像构建成功

openEuler repo 源替换

备份 repo 源

cp /etc/yum.repos.d/openEuler.repo /etc/yum.repos.d/openEuler.repo.bak

将仓库中 docs/whut/openeuler_x86-64.repo.txt 文件中的内容复制到 openEuler.repo 中(检查是否复制完全),重新生成缓存

yum clean all
yum makecache

项目仓库的 fork 及基本设置

fork 项目

fork 的作用是将主仓库复制一份到个人仓库中,对个人仓库的修改不会影响主仓库。

进入项目主仓库之后,界面右上角(头像下面)会有 Fork 按钮,点击该按钮将项目 fork 到个人仓库中。

Gitee 个人仓库

clone

将 fork 到个人仓库的项目克隆到本地

在项目主页复制项目 Git 链接

copy-gitee-link

将项目克隆到本地

git clone repo_link

新建开发分支

git checkout -b 用户名_dev
git push --set-upstream origin 用户名_dev

master 分支主要是为了同步主仓库的代码,开发分支为实际做修改的分支。

new_branch

设置 git 用户名及邮箱

git config --global user.name "你的用户名"
git config --global user.email "你注册时候的邮箱"

免密 push

解决 git push 时每次都需要输入用户名和密码的问题

# oss-fuzz-openeuler 目录下输入
git config  credential.helper store
# 将本次修改推送到远程仓库
git push
# 输入账号密码后,下次 push 就不用输入了

提交修改

在解决了某个 bug 或完成了某个功能后,生成一次 commit 来保存修改。

  1. git status查看有变动的文件

    git-status

  2. git add .将所有有变动的文件都加入到暂存区

    git-add

  3. git commit填写 commit message,将修改提交,提交的规范见下文。

    git-commit

  4. git push将修改提交到 Gitee 仓库(支持多次 commit 操作之后一起提交到 Gitee 仓库)

    git-push

  5. 完成一次变动提交

git commit message 规范

设定项目提交模板

git config --global commit.template .git-commit-template

在编写 commit message 时,遵循以下规范

<type>(<scope>):space<subject>
blank line
<body>
blank line
<footer>

详细参数值解释会显示在输入 git commit 之后的 message 编辑界面,编写示例参照上文的 commit message 截图

参照 git commit message 规范

同步项目主仓库的修改

同步主仓库

这一步的目的是为了将主仓库 master 分支的变动同步到个人仓库的 master 分支。

在 Gitee 个人仓库,选择 master 分支,然后点击同步按钮并确认同步。

稍等片刻就会把项目主仓库(JasonChio/oss-fuzz-openeuler)的更改同步到个人仓库的 master 分支(覆盖,不保留更改

git-push

git-push

通过 Gitee 将 master 更改合并到开发分支

该操作的目的是将 master 分支的改动合并到开发分支,以同步主仓库的最新代码,但是可能有冲突需要解决。

步骤比较多,但是胜在直观。

  1. 在仓库主页点击【+ Pull Request】

    git-push

  2. 将源分支和目标分支中的仓库都改成个人仓库,源分支的分支为刚刚同步的 master 分支,目标分支为开发分支。

    git-push

  3. 创建同步之后,会生成一次 Pull Request,并且需要审查后才能真正同步到个人开发分支中(避免盲目同步导致个人代码丢失)

    git-push

  4. 在文件一栏可以看到本次合并影响的文件以及对应的修改

    git-push

  5. 审查通过-测试通过后,选择【变基并合并】,然后接受 pull request

    git-push

  6. 在开发机的项目目录下输入 git pull --rebase,更新本地代码

    git-push

通过命令将 master 更改合并到开发分支

步骤比较少,但是相对不那么直观。

  1. 首先在本地项目目录切换到 master 分支,git checkout master需要保证当前分支没有未提交的修改。

  2. 将上述同步的主仓库代码拉取到本地,git pull --rebase

    git-pull-reabse

  3. 切换到开发分支 git checkout jason_dev

    git-checkout-jason_dev

  4. 合并主分支更改 git merge --no-commit,Git用<<<<<<<``=======``>>>>>>>标记分离不同分支的内容,将不需要的部分删掉即可解决冲突。

  5. 提交本次合并 git commit

将代码提交到项目主仓库

在基础镜像移植完成或者用例测试修改完成并且保证测试无误之后,提交修改到主仓库。

提交方式为新建 Pull Request,源分支为个人仓库的开发分支,目的分支为主仓库的master分支,提交之后会进行审查及测试,以上过程无误后管理员会接受本次 Pull Request。

问题记录格式规范

问题记录的格式规范如下图所示

issue_sloution

本地镜像或容器的迁移

本地容器的导出导入

  1. 将本地容器导出为镜像文件

    docker export 容器ID > test_container.tar
  2. 将镜像文件导入到本地

    docker import - 镜像名< test_container.tar

    也可以在导入后使用如下命令重命名镜像

    docker tag 镜像ID 新的镜像名:新的镜像Tag

本地镜像的导出导入

  1. 将本地镜像导出为镜像文件

    docker save 镜像ID > test_image.tar
  2. 将镜像文件导入到本地

    docker load < test_image.tar

    也可以在导入后使用如下命令重命名镜像

    docker tag 镜像ID 新的镜像名:新的镜像Tag

注意事项

  1. 两种方式不可混用
  2. export 导出的镜像文件体积小于 save 保存的镜像
  3. docker import 可以为镜像指定新名称;docker load 不能对载入的镜像重命名

上传镜像到 Dockerhub

  1. dockers login -u dockerhub-username

    docker-login-successful.png

  2. 在 dockerhub 创建仓库(与镜像名称相同)

    dockerhub

    dockerhub-create-repo

  3. dockers image ls 查看构建成功的镜像

    docker-image-ls

  4. docker tag IMAGE_ID dockerhub-username更改镜像名:标签

    docker tag 1be2383f0444 jasonchio/fuzz-base-image:latest

    docker-tag

    只有将镜像名更改为【dockerhub-username更改镜像名:标签】这种格式才能将其上传到 dockerhub 中

  5. docker push jasonchio/fuzz-base-image:latest 将镜像上传到 dockerhub,速度可能会比较慢。

  6. 上传成功后就可以看到结果了

    dockerhub-repo

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.

简介

OSS-Fuzz 向 openEuler 平台的迁移项目 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/caixindi/oss-fuzz-openeuler.git
git@gitee.com:caixindi/oss-fuzz-openeuler.git
caixindi
oss-fuzz-openeuler
oss-fuzz-openeuler
master

搜索帮助