Skip to content

Update topo {Get,Create}Keyspace to prevent invalid keyspace names#12732

Merged
deepthi merged 8 commits intovitessio:mainfrom
planetscale:andrew/topo-validate-ks-name
Mar 29, 2023
Merged

Update topo {Get,Create}Keyspace to prevent invalid keyspace names#12732
deepthi merged 8 commits intovitessio:mainfrom
planetscale:andrew/topo-validate-ks-name

Conversation

@ajm188
Copy link
Contributor

@ajm188 ajm188 commented Mar 26, 2023 •
edited
Loading

Description

What it says on the tin. Note that any method that calls GetKeyspace will be affected by this (almost a good search)

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 26, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 26, 2023 •
edited by deepthi
Loading

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

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

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

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

Update topo {Get,Create}Keyspace to prevent invalid keyspace names
689ab9c 
Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 force-pushed the andrew/topo-validate-ks-name branch from 26e8805 to 689ab9c Compare March 26, 2023 22:47
Andrew Mason added 2 commits March 27, 2023 15:31
embarrassing
edae169 
Signed-off-by: Andrew Mason <andrew@planetscale.com>
docs, release notes
38c662f 
Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 marked this pull request as ready for review March 27, 2023 21:02
mattlord
mattlord reviewed Mar 28, 2023
View reviewed changes
Copy link
Member

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Had some questions and suggestions, but otherwise it LGTM.

@frouioui frouioui mentioned this pull request Mar 28, 2023
Closed
34 tasks
only validate, do not correct
966e4df 
Signed-off-by: Andrew Mason <andrew@planetscale.com>
deepthi
deepthi reviewed Mar 28, 2023
View reviewed changes
changelog/17.0/17.0.0/summary.md Outdated

Prior to v17, it was possible to create a keyspace with invalid characters, which would then be inaccessible to various cluster management operations.

Now, the TopoServer's `GetKeyspace` and `CreateKeyspace` methods return an error if given an invalid name.
Copy link
Collaborator

@deepthi deepthi Mar 28, 2023

Choose a reason for hiding this comment

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

This seems overly broad. We don't know what other invalid characters people can provide that break in unpredictable ways. The only one we are disallowing is /.
I would remove the first two sentences altogether and just leave the last one.

@deepthi deepthi removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 28, 2023
broader restrictions via allow-list
5354d4f 
Signed-off-by: Andrew Mason <andrew@planetscale.com>
mattlord
mattlord reviewed Mar 28, 2023
View reviewed changes
mattlord
mattlord approved these changes Mar 28, 2023
View reviewed changes
Copy link
Member

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

👍 👍

GuptaManan100
GuptaManan100 reviewed Mar 29, 2023
View reviewed changes
changelog/17.0/17.0.0/summary.md Outdated
Comment on lines 54 to 59
Copy link
Contributor

@GuptaManan100 GuptaManan100 Mar 29, 2023

Choose a reason for hiding this comment

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

Should we be backporting this change? This doesn't look like a bug-fix but a validation on the input received.

Copy link
Member

@frouioui frouioui Mar 29, 2023

Choose a reason for hiding this comment

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

It does sound like a bug fix to me, keyspaces can be inaccessible prior to v17.0.0

frouioui
frouioui reviewed Mar 29, 2023
View reviewed changes
frouioui
frouioui approved these changes Mar 29, 2023
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Left one comment, otherwise it looks good to me.

The DCO check is failing.

Andrew Mason added 2 commits March 29, 2023 09:15
Revert "broader restrictions via allow-list"
5f5157e 
This reverts commit 5354d4f.

Signed-off-by: Andrew Mason <andrew@planetscale.com>
tighten up release notes scope
c56eb58 
Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 @frouioui
Update go/vt/topo/keyspace.go
512ebf4 
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 force-pushed the andrew/topo-validate-ks-name branch from 4c0b190 to 512ebf4 Compare March 29, 2023 13:16
@ajm188
Copy link
Contributor Author

ajm188 commented Mar 29, 2023

Left one comment, otherwise it looks good to me.

The DCO check is failing.

It was the revert commit, I rebased to rewrite from there-forward, should be good now!

@deepthi deepthi merged commit 3d9ef87 into vitessio:main Mar 29, 2023
@deepthi deepthi deleted the andrew/topo-validate-ks-name branch March 29, 2023 21:19
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 29, 2023

I was unable to backport this Pull Request to the following branches: release-16.0.

ajm188 pushed a commit to planetscale/vitess that referenced this pull request Mar 29, 2023
@frouioui
Update topo {Get,Create}Keyspace to prevent invalid keyspace names (v…
2432c42 
…itessio#12732)

* Update topo {Get,Create}Keyspace to prevent invalid keyspace names

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* embarrassing

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* docs, release notes

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* only validate, do not correct

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* broader restrictions via allow-list

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* Revert "broader restrictions via allow-list"

This reverts commit 5354d4f.

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* tighten up release notes scope

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* Update go/vt/topo/keyspace.go

Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>

---------

Signed-off-by: Andrew Mason <andrew@planetscale.com>
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
@ajm188 ajm188 mentioned this pull request Mar 29, 2023
Merged
frouioui added a commit that referenced this pull request Mar 30, 2023
@frouioui
[Backport] Update topo {Get,Create}Keyspace to prevent invalid keyspa…
adf1019 
…ce names (#12732) (#12771)

* Update topo {Get,Create}Keyspace to prevent invalid keyspace names (#12732)

* Update topo {Get,Create}Keyspace to prevent invalid keyspace names

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* embarrassing

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* docs, release notes

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* only validate, do not correct

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* broader restrictions via allow-list

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* Revert "broader restrictions via allow-list"

This reverts commit 5354d4f.

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* tighten up release notes scope

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* Update go/vt/topo/keyspace.go

Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>

---------

Signed-off-by: Andrew Mason <andrew@planetscale.com>
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>

* update notes and comments

Signed-off-by: Andrew Mason <andrew@planetscale.com>

---------

Signed-off-by: Andrew Mason <andrew@planetscale.com>
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
@ajm188 ajm188 mentioned this pull request Apr 5, 2023
Merged
4 tasks
@dbussink dbussink mentioned this pull request Apr 18, 2023
Merged
4 tasks
@hmaurer hmaurer mentioned this pull request Mar 21, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattlord mattlord mattlord approved these changes

@frouioui frouioui frouioui approved these changes

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

@rsajwani rsajwani Awaiting requested review from rsajwani

+2 more reviewers

@deepthi deepthi deepthi left review comments

@GuptaManan100 GuptaManan100 GuptaManan100 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Component: Cluster management Type: Bug

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Bug Report: CreateKeyspace allows keyspace names with "/", which breaks other commands/components

5 participants

@ajm188 @deepthi @mattlord @frouioui @GuptaManan100