Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fuzzer and OSS-fuzz build script #10326

Merged
merged 1 commit into from
Dec 4, 2020
Merged

Conversation

AdamKorcz
Copy link
Contributor

This PR adds a go-fuzz fuzzer that targets WriteToken as well as a build script to integrate Kops into OSS-fuzz.

I have the integration script available for OSS-fuzz and will be happy to finalize the integration. For this, at least one maintainers email is needed for potential bug reports.

Fuzzing is a way of testing programs whereby pseudo-random data is passed to a target application with the goal of finding bugs and vulnerabilities. Kubernetes is already being fuzzed continuously by way of OSS-fuzz, and this has led to finding bugs and vulnerabilities.

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Nov 27, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @AdamKorcz!

It looks like this is your first PR to kubernetes/kops 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kops has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @AdamKorcz. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 27, 2020
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 27, 2020
@johngmyers
Copy link
Member

Please squash the commits.

Perusing the OSS-Fuzz documentation, I was not able to find a definition of the API for a fuzz target, particularly not a definition of the integer return values.

I also don't see any provision of a seed corpus or dictionary. Shouldn't this be tuned towards JSON?

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. do-not-merge/contains-merge-commits and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 27, 2020
@AdamKorcz
Copy link
Contributor Author

I have not forgotten about this PR. I will ping you once it is ready to review.

@AdamKorcz
Copy link
Contributor Author

Perusing the OSS-Fuzz documentation, I was not able to find a definition of the API for a fuzz target, particularly not a definition of the integer return values.

The fuzzer is implemented by way of go-fuzz, and some documentation on the integer return values can be found here: https://github.com/dvyukov/go-fuzz#usage

I also don't see any provision of a seed corpus or dictionary. Shouldn't this be tuned towards JSON?

To be meticulous: We don't have to do this, but it will help the fuzzer significantly. During build process we will clone https://github.com/google/AFL and get the json.dict from there, and we will do the same for the corpus at https://github.com/dvyukov/go-fuzz-corpus. The two commands in the build file moves the dict and zip files to the correct location with the correct names.

@AdamKorcz
Copy link
Contributor Author

@johngmyers Does it look fine? From my side I consider the corpus and the dict added and all that is needed now is a squash.

@johngmyers
Copy link
Member

Please squash and I'll approve.

@AdamKorcz
Copy link
Contributor Author

Done!

@mikesplain
Copy link
Contributor

Thanks @AdamKorcz!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 4, 2020
@mikesplain
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AdamKorcz, mikesplain

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 4, 2020
@k8s-ci-robot k8s-ci-robot merged commit 5ccbcb3 into kubernetes:master Dec 4, 2020
@k8s-ci-robot k8s-ci-robot added this to the v1.20 milestone Dec 4, 2020
@rifelpet
Copy link
Member

rifelpet commented Dec 5, 2020

@AdamKorcz is the fuzzing going to be happening on some platform that we can access? you mentioned needing an email address: ideally we could use a distribution list but I don't know if we have one setup other than a few announcement lists

@AdamKorcz
Copy link
Contributor Author

@rifelpet The fuzzing will be done by OSS-fuzz which offers a dashboard for found bugs, stats and more. The dashboard is available at https://oss-fuzz.com/, and to get access to the kOps project maintainers need to add their email address in the project.yaml file here. For now, please leave all maintainer email addresses in the current integration PR ( google/oss-fuzz#4729 ) as we are currently discussing whether or not kOps and Kubernetes should be in the same integration in OSS-fuzz. Inputs on that thread are welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants