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 description for tidb_auth_token authentication #15818

Merged
merged 16 commits into from
Mar 1, 2024
Merged

Add description for tidb_auth_token authentication #15818

merged 16 commits into from
Mar 1, 2024

Conversation

CbcWestwolf
Copy link
Member

What is changed, added or deleted? (Required)

Add description for tidb_auth_token, which can be used not only inside TiDB Cloud, but also by normal tidb users.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

  • master (the latest development version)
  • v7.6 (TiDB 7.6 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.4 (TiDB 7.4 versions)
  • v7.3 (TiDB 7.3 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 19, 2023
@ti-chi-bot ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 23, 2023
@CbcWestwolf CbcWestwolf force-pushed the token-based-auth branch 3 times, most recently from 1e852d2 to a55008e Compare December 23, 2023 12:47
@CbcWestwolf CbcWestwolf marked this pull request as ready for review December 23, 2023 12:58
@ti-chi-bot ti-chi-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 23, 2023
@CbcWestwolf
Copy link
Member Author

/cc bb7133
PTAL

@ti-chi-bot ti-chi-bot bot requested a review from bb7133 December 23, 2023 12:58
bb7133
bb7133 reviewed Dec 29, 2023
View reviewed changes
security-compatibility-with-mysql.md Outdated

`tidb_auth_token` 是一种基于 [JSON Web Token (JWT)](https://datatracker.ietf.org/doc/html/rfc7519) 的无密码认证方式，用于 TiDB Cloud 内部用户认证。不同于 `mysql_native_passsword`、`caching_sha2_password` 等使用密码的认证方式，创建 `tidb_auth_token` 用户时无需设置并保存自定义的密码；使用 `tidb_auth_token` 进行登录时使用签发的 token 进行登录，可以简化用户的认证过程并提升安全性。

JWT 由 header、payload 和 signature 三部分组成，每部分使用 base64 编码之后拼接成一个字符串，中间用点号（`.`）分开。
Copy link
Member

Choose a reason for hiding this comment

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

文档中混用了 'header'、'payload' 这些英文的大小写（首行大写），我感觉放在中文文档里面这么用比较怪异，是不是全首字母大写比较好？可以请文档的同事提一下建议。

security-compatibility-with-mysql.md Outdated

### `tidb_auth_token`

`tidb_auth_token` 是一种基于 [JSON Web Token (JWT)](https://datatracker.ietf.org/doc/html/rfc7519) 的无密码认证方式，用于 TiDB Cloud 内部用户认证。不同于 `mysql_native_passsword`、`caching_sha2_password` 等使用密码的认证方式，创建 `tidb_auth_token` 用户时无需设置并保存自定义的密码；使用 `tidb_auth_token` 进行登录时使用签发的 token 进行登录，可以简化用户的认证过程并提升安全性。
Copy link
Member

Choose a reason for hiding this comment

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

用于 TiDB Cloud 内部用户认证

comment 同上

@CbcWestwolf @bb7133
Update security-compatibility-with-mysql.md
0d58a9f 
Co-authored-by: bb7133 <bb7133@gmail.com>
@qiancai qiancai self-requested a review January 5, 2024 02:42
@qiancai qiancai added the translation/doing This PR’s assignee is translating this PR. label Jan 5, 2024
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jan 5, 2024
@CbcWestwolf CbcWestwolf mentioned this pull request Jan 5, 2024
Merged
17 tasks
bb7133
bb7133 approved these changes Feb 28, 2024
View reviewed changes
Copy link
Member

@bb7133 bb7133 left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 28, 2024

@bb7133: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

LGTM

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.

@qiancai
Copy link
Collaborator

qiancai commented Mar 1, 2024

/approve

@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 1, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

@ti-chi-bot ti-chi-bot bot added the approved label Mar 1, 2024
@ti-chi-bot ti-chi-bot bot merged commit df5bade into pingcap:master Mar 1, 2024
7 checks passed
ti-chi-bot pushed a commit to ti-chi-bot/docs-cn that referenced this pull request Mar 1, 2024
@CbcWestwolf @ti-chi-bot
This is an automated cherry-pick of pingcap#15818
940cdda 
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot mentioned this pull request Mar 1, 2024
Merged
17 tasks
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-6.5: #16708.

ti-chi-bot pushed a commit to ti-chi-bot/docs-cn that referenced this pull request Mar 1, 2024
@CbcWestwolf @ti-chi-bot
This is an automated cherry-pick of pingcap#15818
25f4358 
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot mentioned this pull request Mar 1, 2024
Merged
17 tasks
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.1: #16709.

ti-chi-bot pushed a commit to ti-chi-bot/docs-cn that referenced this pull request Mar 1, 2024
@CbcWestwolf @ti-chi-bot
This is an automated cherry-pick of pingcap#15818
9293ff2 
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.4: #16710.

This was referenced Mar 1, 2024
Merged
Merged
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.5: #16711.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.6: #16712.

ti-chi-bot pushed a commit to ti-chi-bot/docs-cn that referenced this pull request Mar 1, 2024
@CbcWestwolf @ti-chi-bot
Add description for tidb_auth_token authentication (pingcap#15818)
c8d8eac
This was referenced Mar 1, 2024
Merged
Merged
Merged
Merged
Merged
Merged
ti-chi-bot bot pushed a commit that referenced this pull request Mar 1, 2024
@ti-chi-bot
Add description for tidb_auth_token authentication (#15818) (#16712)
5624dc5
ti-chi-bot bot pushed a commit that referenced this pull request Mar 1, 2024
@ti-chi-bot
Add description for tidb_auth_token authentication (#15818) (#16711)
f75efa3
ti-chi-bot bot pushed a commit that referenced this pull request Mar 1, 2024
@ti-chi-bot
Add description for tidb_auth_token authentication (#15818) (#16710)
7f3280a
ti-chi-bot bot pushed a commit that referenced this pull request Mar 1, 2024
@ti-chi-bot
Add description for tidb_auth_token authentication (#15818) (#16709)
7169a69
ti-chi-bot bot pushed a commit that referenced this pull request Mar 1, 2024
@ti-chi-bot
Add description for tidb_auth_token authentication (#15818) (#16708)
c685db1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bb7133 bb7133 bb7133 approved these changes

@hfxsd hfxsd hfxsd approved these changes

@qiancai qiancai qiancai approved these changes

Assignees

@qiancai qiancai

Labels
approved area/security Relates to TiDB security and privilege. lgtm needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. needs-cherry-pick-release-7.1 Should cherry pick this PR to release-7.1 branch. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@CbcWestwolf @qiancai @ti-chi-bot @bb7133 @hfxsd