Skip to content

[doc] Improve Pulsar security-tls-transport#5027

Merged
sijie merged 4 commits intoapache:masterfrom
Monica-zy:sec-tls-transport
Aug 29, 2019
Merged

[doc] Improve Pulsar security-tls-transport#5027
sijie merged 4 commits intoapache:masterfrom
Monica-zy:sec-tls-transport

Conversation

@Monica-zy
Copy link
Contributor

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.

@sijie
Copy link
Member

sijie commented Aug 23, 2019

@Anonymitaet ^^ Please review this.

@sijie sijie added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. area/security component/website labels Aug 23, 2019
@sijie sijie added this to the 2.5.0 milestone Aug 23, 2019
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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)).

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Creat TLS Certificates
## Creat TLS certificates

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## TLS Overview
## TLS overview

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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:

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
First, generate the key using the command below.
1. Generate the key using the command below.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Next, use the follwing command to generate the certificate request...
2. Use the following command to generate the certificate request.

Copy link
Member

Choose a reason for hiding this comment

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

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.

@Monica-zy
Copy link
Contributor Author

run java8 tests
run C++/Python tests

@Monica-zy
Copy link
Contributor Author

run cpp tests
run java8 tests

@Monica-zy
Copy link
Contributor Author

run cpp tests

@sijie sijie merged commit 783c4ad into apache:master Aug 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/security doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments