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

fix: allow parsing of certificate chains and password-less certificates #5125

Merged

Conversation

handsomejack-42
Copy link
Contributor

What type of PR is this?

/kind bug

What this PR does / why we need it:

Certificate parsing function isn't capable of parsing certificate chains

The decodePksc12 function fails to parse my PKCS12 certificate chain with the message

decoding the client certificate: decoding the PKCS#12 client certificate: pkcs12: expected exactly two safe bags in the PFX PDU

because, internally, it uses the pkcs12.Decode function, which expects only the key and a main cert, not a whole chain of certs. It is mentioned in the comment that

Since PKCS#12 files often contain more than one certificate, you probably want to use [DecodeChain] instead.

The option is either switching to that .DecodeChain function, or, there is a cert parser implemented in azidentity, that provides even more (PEM) parsing capabilities.

I propose using the parsing function from azidentity instead, as that is the 'native' identity provider for azure anyway.

Password-less certificates

When parsing the config into credential providers in NewAuthProvider, the only way to trigger the certificate credential path is to have password protected certificate. Certificates can exist without password protection.

Remove this condition to allow even password-less certificates.

Which issue(s) this PR fixes:

x

Special notes for your reviewer:

x

Does this PR introduce a user-facing change?

Added certificate parsing capability for password-less certificates and certificate chains

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 6, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @handsomejack-42!

It looks like this is your first PR to kubernetes-sigs/cloud-provider-azure 🎉. 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-sigs/cloud-provider-azure 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 k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 6, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @handsomejack-42. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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 the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 6, 2023
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 6, 2023
When parsing the config into credential providers in NewAuthProvider,
the only way to trigger the certificate credential path is to
have password protected certificate. Certificates can
exist without password protection.

Remove this condition to enable even password-less
certificates.

Signed-off-by: HandsomeJack <dusek.honza@gmail.com>
azidentity.ParseCertificates

The `decodePksc12` function fails to parse my PKCS12
certificate chain with the message

```
decoding the client certificate: decoding the PKCS#12
client certificate: pkcs12: expected exactly two safe
bags in the PFX PDU
```

because, internally, it uses the pkcs12.Decode function,
which expects only the key and a main cert, not a whole
chain of certs. It is mentioned in the comment that

> Since PKCS#12 files often contain more than one certificate,
  you probably want to use [DecodeChain] instead.

The option is either switching to that `.DecodeChain` function,
or, there is a cert parser implemented in azidentity,
that provides even more (PEM) parsing capabilities.

I propose using the parsing function from `azidentity` instead,
as that is the 'native' identity provider for azure anyway.

Signed-off-by: HandsomeJack <dusek.honza@gmail.com>
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 6, 2023
@handsomejack-42 handsomejack-42 changed the title Allow parsing of certificate chains and password-less certificates fix: allow parsing of certificate chains and password-less certificates Dec 6, 2023
@MartinForReal
Copy link
Contributor

Thanks for the fix!
/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: handsomejack-42, MartinForReal

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 6, 2023
@MartinForReal
Copy link
Contributor

/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. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 6, 2023
@k8s-ci-robot k8s-ci-robot merged commit cc2003e into kubernetes-sigs:master Dec 6, 2023
11 checks passed
@handsomejack-42
Copy link
Contributor Author

handsomejack-42 commented Dec 6, 2023

sub 50m approve and merge, wow!

kudos @MartinForReal

@handsomejack-42 handsomejack-42 deleted the hsj/dsts-support branch December 6, 2023 09:49
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. kind/bug Categorizes issue or PR as related to a bug. 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. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants