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 validation for base64 url without = padding #1024

Merged
merged 2 commits into from Mar 19, 2023

Conversation

yasoobh
Copy link
Contributor

@yasoobh yasoobh commented Nov 8, 2022

Fixes Or Enhances

Make sure that you've checked the boxes below before you submit PR:

  • Tests exist or have been written that cover this particular change.

Change:

As flagged in this issue, validation fails for some strings encoded using base64.RawURLEncoding function.

The discussion around whether padding should be considered optional or not is rather long. Some of it can be found here: golang/go#4237. Following which, RawURLEncoding was introduced in base64 package.

The general rule of thumb regarding padding seems to be that you MUST be padding when encoding, but SHOULD be able to handle both padded and unpadded inputs when decoding. Therefore, we should provide support for validating unpadded encoded inputs.

Instead of modifying the "base64url" tag to accept unpadded inputs, it makes more sense to have a separate tag - "base64rawurl". This way it would be clear to the developer and they would use one or the other, or both back to back, depending on their usecase.

PS: formatting changes in doc.go because of go 1.19 updates. Please lmk if I should revert them.

Closes #1002

@go-playground/validator-maintainers

@yasoobh yasoobh requested a review from a team as a code owner November 8, 2022 08:10
@coveralls
Copy link

coveralls commented Nov 8, 2022

Coverage Status

Coverage: 74.255% (+0.005%) from 74.25% when pulling e8f6a16 on yasoobh:master into 1c1f70d on go-playground:master.

@yasoobh yasoobh mentioned this pull request Nov 8, 2022
2 tasks
@azlancpool
Copy link

Will this change be added to any version soon?

@apinet
Copy link

apinet commented Mar 19, 2023

Any chance to have the last code review needed? 🥹

deankarn
deankarn previously approved these changes Mar 19, 2023
@deankarn deankarn merged commit 29d50ba into go-playground:master Mar 19, 2023
@apinet
Copy link

apinet commented Mar 19, 2023

@deankarn you are awesome! many thx for this gorgeous lib!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

base64url should not require padding
6 participants