Improve ErrInvalidKeyType error messages #361

Laurin-Notemann · 2023-11-08T09:44:19Z

This small PR adds

a little bit more context to the ErrInvalidKeyType error message "key is of invalid go type (should be []byte())"
better description of the Parse function

Generally the original error might seem obvious but for some reason it wasn't clear to me that it was specifically referring to the type in Go, I thought it was some kind of error with my jwt token and not my signing key. It seems like an easy fix of just improving the error message slightly so its clearer what is means.

Since I only looked at the example of how parse the jwt into a correct token again I was also really confused as to what "AllYourBase" even meant. Which is why I suggest to add a small comment, so its clear that this is referring to the signing key (which it only is if you read the previous examples and specifically look at the value of the signingKey).

errors.go

rsa.go

rsa_pss.go

rsa.go

example_test.go

errors.go

oxisto

Looks good with a minor nit. Please also change the PR title and description to remove the parse docs.

ecdsa.go

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/golang-jwt/jwt/v5](https://togithub.com/golang-jwt/jwt) | require | minor | `v5.1.0` -> `v5.2.0` | --- ### Release Notes <details> <summary>golang-jwt/jwt (github.com/golang-jwt/jwt/v5)</summary> ### [`v5.2.0`](https://togithub.com/golang-jwt/jwt/releases/tag/v5.2.0) [Compare Source](https://togithub.com/golang-jwt/jwt/compare/v5.1.0...v5.2.0) #### What's Changed - Exported `NewValidator` by [@oxisto](https://togithub.com/oxisto) in [golang-jwt/jwt#349 - Improve ErrInvalidKeyType error messages by [@Laurin-Notemann](https://togithub.com/Laurin-Notemann) in [golang-jwt/jwt#361 - Update MIGRATION_GUIDE.md by [@jbarham](https://togithub.com/jbarham) in [golang-jwt/jwt#363 #### New Contributors - [@Laurin-Notemann](https://togithub.com/Laurin-Notemann) made their first contribution in [golang-jwt/jwt#361 - [@jbarham](https://togithub.com/jbarham) made their first contribution in [golang-jwt/jwt#363 **Full Changelog**: golang-jwt/jwt@v5.1.0...v5.2.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 6am on Monday" in timezone Europe/Paris, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/cozy/cozy-stack).

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | code.gitea.io/sdk/gitea | require | minor | `v0.16.0` -> `v0.17.0` | | [github.com/antonmedv/expr](https://togithub.com/antonmedv/expr) | require | patch | `v1.15.5` -> `v1.15.6` | | [github.com/golang-jwt/jwt/v5](https://togithub.com/golang-jwt/jwt) | require | minor | `v5.1.0` -> `v5.2.0` | | [github.com/urfave/cli/v2](https://togithub.com/urfave/cli) | require | minor | `v2.25.7` -> `v2.26.0` | --- ### Release Notes <details> <summary>antonmedv/expr (github.com/antonmedv/expr)</summary> ### [`v1.15.6`](https://togithub.com/expr-lang/expr/releases/tag/v1.15.6) [Compare Source](https://togithub.com/antonmedv/expr/compare/v1.15.5...v1.15.6) - This is a new release for `expr-lang/epxr`. </details> <details> <summary>golang-jwt/jwt (github.com/golang-jwt/jwt/v5)</summary> ### [`v5.2.0`](https://togithub.com/golang-jwt/jwt/releases/tag/v5.2.0) [Compare Source](https://togithub.com/golang-jwt/jwt/compare/v5.1.0...v5.2.0) #### What's Changed - Exported `NewValidator` by [@oxisto](https://togithub.com/oxisto) in [golang-jwt/jwt#349 - Improve ErrInvalidKeyType error messages by [@Laurin-Notemann](https://togithub.com/Laurin-Notemann) in [golang-jwt/jwt#361 - Update MIGRATION_GUIDE.md by [@jbarham](https://togithub.com/jbarham) in [golang-jwt/jwt#363 #### New Contributors - [@Laurin-Notemann](https://togithub.com/Laurin-Notemann) made their first contribution in [golang-jwt/jwt#361 - [@jbarham](https://togithub.com/jbarham) made their first contribution in [golang-jwt/jwt#363 **Full Changelog**: golang-jwt/jwt@v5.1.0...v5.2.0 </details> <details> <summary>urfave/cli (github.com/urfave/cli/v2)</summary> ### [`v2.26.0`](https://togithub.com/urfave/cli/releases/tag/v2.26.0) [Compare Source](https://togithub.com/urfave/cli/compare/v2.25.7...v2.26.0) #### What's Changed - Bash completion nits by [@meatballhat](https://togithub.com/meatballhat) in [urfave/cli#1762 - Chore: Rename mkdocs requirements file name by [@dearchap](https://togithub.com/dearchap) in [urfave/cli#1776 - Fix:(issue\_1787) Add fix for commands not listed when hide help comma… by [@dearchap](https://togithub.com/dearchap) in [urfave/cli#1788 - Fix nil HelpFlag panic (v2) by [@wxiaoguang](https://togithub.com/wxiaoguang) in [urfave/cli#1795 - Always get 0 for a nested int64 value in v2.25.7 by [@stephenfire](https://togithub.com/stephenfire) in [urfave/cli#1799 - Helper messages for documenting build process by [@abitrolly](https://togithub.com/abitrolly) in [urfave/cli#1800 - fix: check duplicated sub command name and alias by [@linrl3](https://togithub.com/linrl3) in [urfave/cli#1805 - Fix:(issue\_1689) Have consistent behavior for default text in man and… by [@dearchap](https://togithub.com/dearchap) in [urfave/cli#1825 - Fix linting issues by [@skelouse](https://togithub.com/skelouse) in [urfave/cli#1696 #### New Contributors - [@stephenfire](https://togithub.com/stephenfire) made their first contribution in [urfave/cli#1799 - [@linrl3](https://togithub.com/linrl3) made their first contribution in [urfave/cli#1805 **Full Changelog**: urfave/cli@v2.25.7...v2.26.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am" (UTC), Automerge - "before 4am" (UTC). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/woodpecker-ci/woodpecker).  --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: qwerty287 <ndev@web.de>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/golang-jwt/jwt/v5](https://togithub.com/golang-jwt/jwt) | `v5.0.0` -> `v5.2.1` | [![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fgolang-jwt%2fjwt%2fv5/v5.2.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fgolang-jwt%2fjwt%2fv5/v5.2.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fgolang-jwt%2fjwt%2fv5/v5.0.0/v5.2.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fgolang-jwt%2fjwt%2fv5/v5.0.0/v5.2.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>golang-jwt/jwt (github.com/golang-jwt/jwt/v5)</summary> ### [`v5.2.1`](https://togithub.com/golang-jwt/jwt/releases/tag/v5.2.1) [Compare Source](https://togithub.com/golang-jwt/jwt/compare/v5.2.0...v5.2.1) #### What's Changed - chore: remove unnecessary conversions from tests by [@estensen](https://togithub.com/estensen) in [golang-jwt/jwt#370 - Trivial: Typo fix for ECDSA error message by [@tjs-cinemo](https://togithub.com/tjs-cinemo) in [golang-jwt/jwt#373 - Fix incorrect error return by [@ss49919201](https://togithub.com/ss49919201) in [golang-jwt/jwt#371 #### New Contributors - [@tjs-cinemo](https://togithub.com/tjs-cinemo) made their first contribution in [golang-jwt/jwt#373 - [@ss49919201](https://togithub.com/ss49919201) made their first contribution in [golang-jwt/jwt#371 **Full Changelog**: golang-jwt/jwt@v5.2.0...v5.2.1 ### [`v5.2.0`](https://togithub.com/golang-jwt/jwt/releases/tag/v5.2.0) [Compare Source](https://togithub.com/golang-jwt/jwt/compare/v5.1.0...v5.2.0) #### What's Changed - Exported `NewValidator` by [@oxisto](https://togithub.com/oxisto) in [golang-jwt/jwt#349 - Improve ErrInvalidKeyType error messages by [@Laurin-Notemann](https://togithub.com/Laurin-Notemann) in [golang-jwt/jwt#361 - Update MIGRATION_GUIDE.md by [@jbarham](https://togithub.com/jbarham) in [golang-jwt/jwt#363 #### New Contributors - [@Laurin-Notemann](https://togithub.com/Laurin-Notemann) made their first contribution in [golang-jwt/jwt#361 - [@jbarham](https://togithub.com/jbarham) made their first contribution in [golang-jwt/jwt#363 **Full Changelog**: golang-jwt/jwt@v5.1.0...v5.2.0 ### [`v5.1.0`](https://togithub.com/golang-jwt/jwt/releases/tag/v5.1.0) [Compare Source](https://togithub.com/golang-jwt/jwt/compare/v5.0.0...v5.1.0) #### What's Changed - Using jwt's native `ErrInvalidType` instead of `json.UnsupportedTypeError` by [@oxisto](https://togithub.com/oxisto) in [golang-jwt/jwt#316 - Fix typos in comments and test names by [@alexandear](https://togithub.com/alexandear) in [golang-jwt/jwt#317 - Format: add whitespaces, remove empty lines by [@alexandear](https://togithub.com/alexandear) in [golang-jwt/jwt#319 - Refactor example: use io.ReadAll instead of io.Copy by [@alexandear](https://togithub.com/alexandear) in [golang-jwt/jwt#320 - Refactor code by using switch instead of if-else by [@alexandear](https://togithub.com/alexandear) in [golang-jwt/jwt#318 - A quick way to validate token string by [@dcalsky](https://togithub.com/dcalsky) in [golang-jwt/jwt#302 - Refactor: remove unnecessary \[]byte conversion to string by [@alexandear](https://togithub.com/alexandear) in [golang-jwt/jwt#330 - Refactor: compare strings with strings.EqualFold by [@alexandear](https://togithub.com/alexandear) in [golang-jwt/jwt#329 - Avoid use of json.NewDecoder by [@craigpastro](https://togithub.com/craigpastro) in [golang-jwt/jwt#313 - Update ParseUnverified godoc by [@duhaesbaert](https://togithub.com/duhaesbaert) in [golang-jwt/jwt#341 - Update ci workflows (add go1.21) by [@mfridman](https://togithub.com/mfridman) in [golang-jwt/jwt#345 - Bump actions/checkout from 3 to 4 by [@dependabot](https://togithub.com/dependabot) in [golang-jwt/jwt#346 - Key rotation with VerificationKeySet by [@mfridman](https://togithub.com/mfridman) in [golang-jwt/jwt#344 - Add explicit ClaimsValidator implementation check for custom claims by [@epelc](https://togithub.com/epelc) in [golang-jwt/jwt#343 - feat: allow making exp claim required by [@tareksha](https://togithub.com/tareksha) in [golang-jwt/jwt#351 - Add error handling to examples by [@craigpastro](https://togithub.com/craigpastro) in [golang-jwt/jwt#312 #### New Contributors - [@alexandear](https://togithub.com/alexandear) made their first contribution in [golang-jwt/jwt#317 - [@dcalsky](https://togithub.com/dcalsky) made their first contribution in [golang-jwt/jwt#302 - [@craigpastro](https://togithub.com/craigpastro) made their first contribution in [golang-jwt/jwt#313 - [@duhaesbaert](https://togithub.com/duhaesbaert) made their first contribution in [golang-jwt/jwt#341 - [@epelc](https://togithub.com/epelc) made their first contribution in [golang-jwt/jwt#343 - [@tareksha](https://togithub.com/tareksha) made their first contribution in [golang-jwt/jwt#351 **Full Changelog**: golang-jwt/jwt@v5.0.0...v5.1.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/infratographer/x).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Improve ErrInvalidKeyType error message

92b3eaf

oxisto reviewed Nov 8, 2023

View reviewed changes

errors.go Outdated Show resolved Hide resolved

Laurin-Notemann added 2 commits November 8, 2023 12:38

add specific expected type to error message

b3b45a6

fix ErrInvalidKey error to ErrInvalidKeyType in rsa and rsapss

c37696e

Laurin-Notemann commented Nov 8, 2023

View reviewed changes

rsa.go Outdated Show resolved Hide resolved

Laurin-Notemann commented Nov 8, 2023

View reviewed changes

rsa_pss.go Outdated Show resolved Hide resolved

Laurin-Notemann requested a review from oxisto November 8, 2023 12:13

oxisto reviewed Nov 8, 2023

View reviewed changes

rsa.go Outdated Show resolved Hide resolved

example_test.go Outdated Show resolved Hide resolved

oxisto linked an issue Nov 8, 2023 that may be closed by this pull request

v5.0.0/request/request.go: with WithLeeway support? #357

Closed

oxisto reviewed Nov 8, 2023

View reviewed changes

errors.go Outdated Show resolved Hide resolved

oxisto removed a link to an issue Nov 8, 2023

v5.0.0/request/request.go: with WithLeeway support? #357

Closed

format

fcdcf11

Laurin-Notemann force-pushed the main branch from 3c0ecdd to fcdcf11 Compare November 8, 2023 12:44

Laurin-Notemann requested a review from oxisto November 8, 2023 12:46

revert changes from example_test.go remove the comments

c7f33b3

oxisto approved these changes Nov 13, 2023

View reviewed changes

ecdsa.go Outdated Show resolved Hide resolved

Laurin-Notemann changed the title ~~Improve ErrInvalidKeyType error message and Parse docs~~ Improve ErrInvalidKeyType error messages Nov 17, 2023

fix: udpate the signing names to uppercase

ce050d5

Laurin-Notemann requested a review from oxisto November 17, 2023 16:21

oxisto approved these changes Nov 17, 2023

View reviewed changes

mfridman approved these changes Nov 17, 2023

View reviewed changes

oxisto merged commit b05644b into golang-jwt:main Nov 17, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve ErrInvalidKeyType error messages #361

Improve ErrInvalidKeyType error messages #361

Laurin-Notemann commented Nov 8, 2023

oxisto left a comment

Improve ErrInvalidKeyType error messages #361

Improve ErrInvalidKeyType error messages #361

Conversation

Laurin-Notemann commented Nov 8, 2023

oxisto left a comment

Choose a reason for hiding this comment