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.

Sign up for GitHub

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

Jump to bottom

Add support for hashed caching sha2 passwords #17948

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for hashed caching sha2 passwords #17948

wants to merge 1 commit into from
+92 −14

Conversation

dbussink
Copy link
Contributor

This allows for storing already hashed caching sha2 passwords for authentication. This way you can use the new authentication method without needing the password to be in plain text.

Related Issue(s)

Fixes #17947

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

@dbussink
Add support for hashed caching sha2 passwords
48bee79 
This allows for storing already hashed caching sha2 passwords for
authentication. This way you can use the new authentication method
without needing the password to be in plain text.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
@dbussink dbussink added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Authn/z Authentication / Authorization / Certificates labels Mar 11, 2025
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 11, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Mar 11, 2025
dbussink
dbussink commented Mar 11, 2025
View reviewed changes
go/mysql/auth_server.go
// for 4.1 style password hashes. It drops the optionally leading * before
// decoding the rest as a hex encoded string.
func DecodeMysqlNativePasswordHex(hexEncodedPassword string) ([]byte, error) {
func DecodePasswordHex(hexEncodedPassword string) ([]byte, error) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed this since it's really a hex decoding helper, not specifically related to mysql_native_password.

go/mysql/auth_server_test.go
@@ -22,11 +22,11 @@ import (
"github.com/stretchr/testify/assert"
)

func TestVerifyHashedMysqlNativePassword(t *testing.T) {
func TestVerifyHashedCachingSha2Password(t *testing.T) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The names here of the test were swapped compare to the implementation!

@dbussink dbussink added NeedsWebsiteDocsUpdate What it says and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Mar 11, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Mar 11, 2025
@dbussink dbussink mentioned this pull request Mar 11, 2025
Open
@dbussink
Copy link
Contributor Author

Opened #17948 as well.

@dbussink dbussink removed the NeedsWebsiteDocsUpdate What it says label Mar 11, 2025
@codecov Codecov
Copy link

codecov bot commented Mar 11, 2025

Codecov Report

Attention: Patch coverage is 84.21053% with 3 lines in your changes missing coverage. Please review.

Project coverage is 67.56%. Comparing base (0bf4276) to head (48bee79).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
go/mysql/auth_server_static.go 88.23% 2 Missing ⚠️
go/mysql/vault/auth_server_vault.go 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #17948      +/-   ##
==========================================
- Coverage   67.56%   67.56%   -0.01%     
==========================================
  Files        1597     1597              
  Lines      259763   259807      +44     
==========================================
+ Hits       175506   175527      +21     
- Misses      84257    84280      +23

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@systay systay Awaiting requested review from systay systay is a code owner

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
Component: Authn/z Authentication / Authorization / Certificates Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.

Feature Request: Allow for storing hashed caching sha2 credentials in static auth server
1 participant
@dbussink