v5.2.2: Update TLS docs by dveeden · Pull Request #6323 · pingcap/docs

dveeden · 2021-08-27T15:05:07Z

What is changed, added or deleted? (Required)

Update TLS docs with:

TiDB 5.2.x additions
Remove the use of mysql_ssl_rsa_setup as this is replaced with AutoTLS
Add SSL Modes available in MySQL 8.0 client

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

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

Closes #6387

Including this:

Not including this as it doesn't apply to v5.2:

config,util: Add setting for TLS version tidb#26937

ti-chi-bot · 2021-08-27T15:05:10Z

[REVIEW NOTIFICATION]

This pull request has been approved by:

TomShawn
morgo

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Details

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

dveeden · 2021-08-27T15:06:20Z

/cc @bb7133 @morgo @TomShawn

dveeden · 2021-08-30T06:37:35Z

The list on https://pkg.go.dev/crypto/tls#pkg-constants doesn't match exactly with the list on https://docs.pingcap.com/tidb/stable/enable-tls-between-clients-and-servers#supported-tls-versions-key-exchange-protocols-and-encryption-algorithms

Should it match exactly?

dveeden · 2021-09-08T07:03:15Z

@morgo @bb7133 @TomShawn PTAL

morgo

LGTM. For the chinese translation you might want to ask @s3nt3 for translation or review, because the usage of some of the language is very specific.

TomShawn · 2021-10-18T08:54:48Z

For v5.2.x additions, could you please add the description: "Since v5.2.2, ...."?

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

TomShawn · 2021-10-19T03:01:55Z

@dveeden Any update?

dveeden · 2021-10-19T11:45:41Z

@TomShawn added some text about mysql_ssl_rsa_setup (which is a third-party tool from Oracle MySQL: https://dev.mysql.com/doc/refman/8.0/en/mysql-ssl-rsa-setup.html ) and added a note about versions. auto-tls, Ssl_server_not_after and Ssl_server_not_before are the items that need a version note.

TomShawn

LGTM

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

TomShawn · 2021-10-19T14:26:17Z

/merge

ti-chi-bot · 2021-10-19T14:26:21Z

This pull request has been accepted and is ready to merge.

Details

Commit hash: 28aeb2a

ti-chi-bot · 2021-10-19T14:33:21Z

In response to a cherrypick label: new pull request created: #6646.

s3nt3 · 2021-10-21T06:02:18Z


 If the certificate parameters are correct, TiDB outputs `secure connection is enabled` when started; otherwise, it outputs `secure connection is NOT ENABLED`.

+For TiDB versions earlier than v5.2.0, you can use `mysql_ssl_rsa_setup --datadir=./certs` to generate certficates. The `mysql_ssal_rsa_setup` tool is a part of MySQL Server.


There seems to be a mistake: mysql_ssal_rsa_setup should be changed to mysql_ssl_rsa_setup.

fixed in b9ce3fe.

ti-chi-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 27, 2021

ti-chi-bot requested a review from TomShawn August 27, 2021 15:05

ti-chi-bot added 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 Aug 27, 2021

ti-chi-bot requested review from bb7133 and morgo August 27, 2021 15:06

morgo reviewed Aug 27, 2021

View reviewed changes

Comment thread enable-tls-between-clients-and-servers.md Outdated

dveeden force-pushed the tls_52 branch from 752f90b to 6436fb0 Compare August 30, 2021 06:30

dveeden force-pushed the tls_52 branch from 6436fb0 to af52a4f Compare August 30, 2021 08:13

dveeden marked this pull request as ready for review August 30, 2021 08:33

ti-chi-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 30, 2021

TomShawn added needs-cherry-pick-release-5.2 translation/doing This PR's assignee is translating this PR. labels Aug 31, 2021

ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Aug 31, 2021

TomShawn added the type/enhancement The issue or PR belongs to an enhancement. label Aug 31, 2021

TomShawn assigned Liuxiaozhen12 Aug 31, 2021

TomShawn added status/PTAL This PR is ready for reviewing. sig/docs Indicates that the Issue or PR belongs to the docs SIG. area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. labels Sep 1, 2021

dveeden force-pushed the tls_52 branch from af52a4f to ef4f67d Compare September 6, 2021 06:08

ti-chi-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 Sep 6, 2021

dveeden mentioned this pull request Sep 6, 2021

Inconsistent description on the same page #6387

Closed

dveeden requested a review from morgo September 8, 2021 07:02

morgo approved these changes Sep 11, 2021

View reviewed changes

Comment thread enable-tls-between-clients-and-servers.md Outdated

ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Sep 11, 2021

TomShawn added the type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. label Oct 18, 2021

TomShawn reviewed Oct 18, 2021

View reviewed changes

TomShawn changed the title ~~Update TLS docs~~ v5.2.2: Update TLS docs Oct 18, 2021

Apply suggestions from code review

7872241

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

TomShawn added area/security Relates to TiDB security and privilege. and removed area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. labels Oct 19, 2021

dveeden added 2 commits October 19, 2021 13:42

update basted on review

e3aad9e

Merge remote-tracking branch 'upstream/master' into tls_52

88124e2

TomShawn approved these changes Oct 19, 2021

View reviewed changes

Comment thread enable-tls-between-clients-and-servers.md Outdated

Comment thread enable-tls-between-clients-and-servers.md Outdated

ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Oct 19, 2021

dveeden and others added 2 commits October 19, 2021 14:12

Update enable-tls-between-clients-and-servers.md

da9e545

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update enable-tls-between-clients-and-servers.md

28aeb2a

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Oct 19, 2021

ti-chi-bot merged commit 800491f into pingcap:master Oct 19, 2021

ti-chi-bot mentioned this pull request Oct 19, 2021

v5.2.2: Update TLS docs (#6323) #6646

Merged

8 tasks

ti-chi-bot added a commit that referenced this pull request Oct 19, 2021

v5.2.2: Update TLS docs (#6323) (#6646)

3a6a745

Liuxiaozhen12 mentioned this pull request Oct 21, 2021

v5.2.2: Update TLS docs pingcap/docs-cn#7318

Merged

13 tasks

Liuxiaozhen12 added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Oct 21, 2021

s3nt3 reviewed Oct 21, 2021

View reviewed changes

Liuxiaozhen12 mentioned this pull request Oct 21, 2021

TLS docs: fix some typo #6655

Merged

13 tasks

This was referenced Oct 25, 2021

v5.2.2: Update TLS docs (#7318) pingcap/docs-cn#7329

Merged

TLS docs: fix some typo (#6655) #6667

Merged


		If the certificate parameters are correct, TiDB outputs `secure connection is enabled` when started; otherwise, it outputs `secure connection is NOT ENABLED`.

		For TiDB versions earlier than v5.2.0, you can use `mysql_ssl_rsa_setup --datadir=./certs` to generate certficates. The `mysql_ssal_rsa_setup` tool is a part of MySQL Server.

Conversation

dveeden commented Aug 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is changed, added or deleted? (Required)

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

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

Uh oh!

ti-chi-bot commented Aug 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dveeden commented Aug 27, 2021

Uh oh!

Uh oh!

dveeden commented Aug 30, 2021

Uh oh!

dveeden commented Sep 8, 2021

Uh oh!

morgo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TomShawn commented Oct 18, 2021

Uh oh!

TomShawn commented Oct 19, 2021

Uh oh!

dveeden commented Oct 19, 2021

Uh oh!

TomShawn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

TomShawn commented Oct 19, 2021

Uh oh!

ti-chi-bot commented Oct 19, 2021

Uh oh!

ti-chi-bot commented Oct 19, 2021

Uh oh!

s3nt3 Oct 21, 2021

Choose a reason for hiding this comment

Uh oh!

Liuxiaozhen12 Oct 21, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

dveeden commented Aug 27, 2021 •

edited

Loading

ti-chi-bot commented Aug 27, 2021 •

edited

Loading