[doc] Improve Pulsar security-tls-transport#5027
Merged
sijie merged 4 commits intoapache:masterfrom Aug 29, 2019
Merged
Conversation
Member
|
@Anonymitaet ^^ Please review this. |
Anonymitaet
requested changes
Aug 27, 2019
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| TLS is a form of [public key cryptography](https://en.wikipedia.org/wiki/Public-key_cryptography). Using a key pairs consisting of a public key and a private key can perform the encryption. The public key encrpyts the messages and the private key decrypts the messages. | |
| TLS is a form of [public key cryptography](https://en.wikipedia.org/wiki/Public-key_cryptography). Using key pairs consisting of a public key and a private key can perform the encryption. The public key encrypts messages and the private key decrypts messages. |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| For TLS authentication, the server uses the **trust cert** to verify that the client has a key pair that the certificate authority signed. The Common Name of the **client cert** is then used as the client's role token (see [Overview](security-overview.md)). | |
| For TLS authentication, the server uses the **trust cert** to verify that the client has a key pair that the certificate authority signed. The common name of the **client cert** is then used as the client's role token (see [Overview](security-overview.md)). |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| ## Creat TLS Certificates | |
| ## Creat TLS certificates |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| ## TLS Overview | |
| ## TLS overview |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| Follow the abridged guide below to set up a certificate authority. You can also refer to plenty of resources on the internet for a more detailed guide. We recommend [this guide](https://jamielinux.com/docs/openssl-certificate-authority/index.html) for your detailed reference. | |
| Follow the guide below to set up a certificate authority. You can also refer to plenty of resources on the internet for a more detailed guide. We recommend [this guide](https://jamielinux.com/docs/openssl-certificate-authority/index.html) for your detailed reference. |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| Then, run the commands below to create the necessary directories, keys and certs. | |
| 3. Run the commands below to create necessary directories, keys, and certs. |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| After you answer the question prompts, CA-related files are stored in the `./my-ca` directory. Within that directory: | |
| 4. After you answer the question prompts, CA-related files are stored in the `./my-ca` directory. Within that directory: |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| First, generate the key using the command below. | |
| 1. Generate the key using the command below. |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| Next, use the follwing command to generate the certificate request... | |
| 2. Use the following command to generate the certificate request. |
site2/docs/security-tls-transport.md
Outdated
Member
There was a problem hiding this comment.
Suggested change
| ... and sign it with the certificate authority by running the command below. | |
| 3. Sign the certificate request with the certificate authority by running the command below. |
Contributor
Author
|
run java8 tests |
Contributor
Author
|
run cpp tests |
Contributor
Author
|
run cpp tests |
Anonymitaet
approved these changes
Aug 29, 2019
sijie
approved these changes
Aug 29, 2019
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Improve the language and the overall descriptive style of the Transport Encryption using TLS document of Security chapter.
Modifications
Adjust the tone, personal pronouns, voice also some typo errors of some sentences in the document.