Resolve #4106, add check for empty certificate in get_pem_cert_key #4193

nr17 · 2019-06-13T04:52:35Z

What this PR does / why we need it:
This PR fixes #4106

Special notes for your reviewer:
The original author's expectation might be that configuration.get_pem_cert_key(hostname) returns nil for the hostname when no tls section is defined for the corresponding ingress resource. But it seems to be returning empty string and this causes ssl.cert_pem_to_der(pem_cert_key) to fail later. This check fixes this issue.

k8s-ci-robot · 2019-06-13T04:52:36Z

Welcome @nr17!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. 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/ingress-nginx 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 · 2019-06-13T04:52:37Z

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.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

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 · 2019-06-13T04:52:42Z

Hi @nr17. 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 · 2019-06-13T04:52:53Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: nr17
To complete the pull request process, please assign elvinefendi
You can assign the PR to them by writing /assign @elvinefendi in a comment when ready.

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

Needs approval from an approver in each of these files:

OWNERS

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

aledbf · 2019-06-13T06:52:44Z

@nr17 please change the description of the PR

aledbf · 2019-06-13T06:52:51Z

/ok-to-test

codecov-io · 2019-06-13T06:57:37Z

Codecov Report

❗ No coverage uploaded for pull request base (master@8cee8d5). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master    #4193   +/-   ##
=========================================
  Coverage          ?   57.77%           
=========================================
  Files             ?       87           
  Lines             ?     6479           
  Branches          ?        0           
=========================================
  Hits              ?     3743           
  Misses            ?     2306           
  Partials          ?      430

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8cee8d5...5a04699. Read the comment docs.

ElvinEfendi · 2019-06-13T15:13:09Z

Thanks for the PR!

It seems like under certain scenario controller pushes an empty certificate payload to Lua for a given host - certificate.lua module expects that if there's an entry for a given host then it must be a correct PEM cert. Empty payload, is an incorrect PEM cert therefore it expectedly fails.

IMHO this PR is not fixing the root cause of the problem. We should find out why the controller pushes empty payload for the host first and either make sure it pushes correct certificate (this will make sure things work as expected) or it does not push anything at all (in which case get_pem_cert_key will return nil and you will get the same result as this PR).

Can you write an e2e test first that describes the scenario with incorrect behaviour?

nr17 · 2019-06-13T17:47:43Z

Thanks for the PR!

It seems like under certain scenario controller pushes an empty certificate payload to Lua for a given host - certificate.lua module expects that if there's an entry for a given host then it must be a correct PEM cert. Empty payload, is an incorrect PEM cert therefore it expectedly fails.

IMHO this PR is not fixing the root cause of the problem. We should find out why the controller pushes empty payload for the host first and either make sure it pushes correct certificate (this will make sure things work as expected) or it does not push anything at all (in which case get_pem_cert_key will return nil and you will get the same result as this PR).

Can you write an e2e test first that describes the scenario with incorrect behaviour?

Yes, I had the same exact thoughts; but before investigating further, I wanted to get some feedback.

Also, I tried running the existing e2e tests with minikube, but for some reason I wasn't successful. Are the instructions at https://github.com/kubernetes/ingress-nginx/blob/master/docs/development.md up to date on running the tests. E.g. I noticed that make e2e-test requires "make e2e-test-image" to be executed first unless I am missing something. Can you give me some hints to have a setup with minikube where I can run e2e tests. I am not familiar with ginkgo.

ElvinEfendi · 2019-06-13T19:13:45Z

@nr17 unfortunately it is out of date. What I do is

eval $(minikube docker-env)

make e2e-test-image

then

E2E_NODES=2 make e2e-test

you can also you FOCUS var when running e2e tests to focus on specific tests only because otherwise it takes forever. Another trick is to edit test/e2e/e2e.go and comment out all the test packages except the one that you want to run, then make sure you rebuild e2e test image before running again.

You can look at test/e2e/lua/dynamic_certificates.go for some inspiration.

nr17 · 2019-06-14T23:15:42Z

@nr17 unfortunately it is out of date. What I do is
eval $(minikube docker-env)
make e2e-test-image
then
E2E_NODES=2 make e2e-test
you can also you FOCUS var when running e2e tests to focus on specific tests only because otherwise it takes forever. Another trick is to edit test/e2e/e2e.go and comment out all the test packages except the one that you want to run, then make sure you rebuild e2e test image before running again.

You can look at test/e2e/lua/dynamic_certificates.go for some inspiration.

Thanks. I'll continue working on it.

secure-backends is supported now. backend-protocol will be ignored to avoid conflicts.

Add support for deprecated annotation

k8s-ci-robot · 2019-06-17T19:27:52Z

@nr17: PR needs rebase.

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 · 2019-06-24T17:41:30Z

@nr17: The following tests failed, say /retest to rerun them all:

Test name	Commit	Details	Rerun command
pull-ingress-nginx-codegen	`accee08`	link	`/test pull-ingress-nginx-codegen`
pull-ingress-nginx-gofmt	`accee08`	link	`/test pull-ingress-nginx-gofmt`
pull-ingress-nginx-golint	`accee08`	link	`/test pull-ingress-nginx-golint`
pull-ingress-nginx-test-lua	`accee08`	link	`/test pull-ingress-nginx-test-lua`
pull-ingress-nginx-test	`accee08`	link	`/test pull-ingress-nginx-test`
pull-ingress-nginx-e2e-1-13	`accee08`	link	`/test pull-ingress-nginx-e2e-1-13`
pull-ingress-nginx-e2e-1-14	`accee08`	link	`/test pull-ingress-nginx-e2e-1-14`
pull-ingress-nginx-e2e-1-15	`accee08`	link	`/test pull-ingress-nginx-e2e-1-15`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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.

aledbf · 2019-06-25T11:21:08Z

internal/ingress/annotations/backendprotocol/main.go

@@ -46,20 +46,28 @@ func NewParser(r resolver.Resolver) parser.IngressAnnotation {
 // ParseAnnotations parses the annotations contained in the ingress
 // rule used to indicate the backend protocol.
 func (a backendProtocol) Parse(ing *extensions.Ingress) (interface{}, error) {
+	klog.Infof("Parsing backend protocol annotation")


Please remove L49

aledbf · 2019-06-25T11:22:42Z

internal/ingress/annotations/backendprotocol/main.go

 	if ing.GetAnnotations() == nil {
 		return HTTP, nil
 	}

+	// Proofpoint hack to make v0.24.1 compatible with deprecated "secure-backend" annotation


Please remove this change. This annotation was removed in 0.21.0 #3203

nr17 · 2019-06-25T20:36:22Z

Closing it as this has been fixed with #4229

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jun 13, 2019

k8s-ci-robot requested review from aledbf and ElvinEfendi June 13, 2019 04:52

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 13, 2019

fix issues for ingress without tls section

5a04699

nr17 force-pushed the release-0.24.1 branch from 0c49f1e to 5a04699 Compare June 13, 2019 05:06

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 13, 2019

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 13, 2019

aledbf assigned ElvinEfendi Jun 13, 2019

aledbf added this to In Progress in 0.25.0 Jun 13, 2019

nr17 changed the title ~~Release 0.24.1~~ Resolve #4106, add check for empty certificate in get_pem_cert_key Jun 13, 2019

nr17 added 2 commits June 15, 2019 12:51

Add support for deprecated annotation

c3be006

secure-backends is supported now. backend-protocol will be ignored to avoid conflicts.

Merge pull request #2 from nr17/fix-non-tls-ingress

accee08

Add support for deprecated annotation

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 17, 2019

k8s-ci-robot removed the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jun 17, 2019

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 17, 2019

aledbf reviewed Jun 25, 2019

View reviewed changes

aledbf mentioned this pull request Jun 25, 2019

Do not send empty certificates to nginx #4229

Merged

aledbf removed this from In Progress in 0.25.0 Jun 25, 2019

nr17 closed this Jun 25, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Resolve #4106, add check for empty certificate in get_pem_cert_key #4193

Resolve #4106, add check for empty certificate in get_pem_cert_key #4193

nr17 commented Jun 13, 2019

k8s-ci-robot commented Jun 13, 2019

k8s-ci-robot commented Jun 13, 2019

k8s-ci-robot commented Jun 13, 2019

k8s-ci-robot commented Jun 13, 2019

aledbf commented Jun 13, 2019

aledbf commented Jun 13, 2019

codecov-io commented Jun 13, 2019

ElvinEfendi commented Jun 13, 2019

nr17 commented Jun 13, 2019

ElvinEfendi commented Jun 13, 2019 •

edited

nr17 commented Jun 14, 2019

k8s-ci-robot commented Jun 17, 2019

k8s-ci-robot commented Jun 24, 2019

aledbf Jun 25, 2019

aledbf Jun 25, 2019

nr17 commented Jun 25, 2019

Resolve #4106, add check for empty certificate in get_pem_cert_key #4193

Resolve #4106, add check for empty certificate in get_pem_cert_key #4193

Conversation

nr17 commented Jun 13, 2019

k8s-ci-robot commented Jun 13, 2019

k8s-ci-robot commented Jun 13, 2019

k8s-ci-robot commented Jun 13, 2019

k8s-ci-robot commented Jun 13, 2019

aledbf commented Jun 13, 2019

aledbf commented Jun 13, 2019

codecov-io commented Jun 13, 2019

Codecov Report

ElvinEfendi commented Jun 13, 2019

nr17 commented Jun 13, 2019

ElvinEfendi commented Jun 13, 2019 • edited

nr17 commented Jun 14, 2019

k8s-ci-robot commented Jun 17, 2019

k8s-ci-robot commented Jun 24, 2019

aledbf Jun 25, 2019

Choose a reason for hiding this comment

aledbf Jun 25, 2019

Choose a reason for hiding this comment

nr17 commented Jun 25, 2019

ElvinEfendi commented Jun 13, 2019 •

edited