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

TKSS-748: Typos in READMEs #749

Merged
merged 1 commit into from
Mar 27, 2024
Merged

TKSS-748: Typos in READMEs #749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions kona-crypto/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ the less the position is, the higher the priority is. The minimum value is 1.
#### Key pair
Generating SM2 key pair is the same as generating the key pairs on other EC curves. It just needs to invoke the standard JDK APIs. `KonaCrypto` provides two `KeyPairGenerator` implementations for generating SM2 key pair:

- The JDK builtin `ECKeyPairGenerator`. In the key pair generated by this implementations, the format of private key is `PKCS#8` and the format of public key is `X.509`.
- A new introduced `SM2KeyPairGenerator`. In the key pair generated by this implementations, the format of the both keys is `RAW`. The length of private key is 32-bytes. The length of public key is 65-bytes, The format is `04||x||y`. `04` represents the uncompressed format; `x` and `y` are the coordinates of the public point in the curve, and both are 32-bytes.
- The JDK builtin `ECKeyPairGenerator`. In the key pair generated by this implementation, the format of private key is `PKCS#8` and the format of public key is `X.509`.
- A new introduced `SM2KeyPairGenerator`. In the key pair generated by this implementation, the format of the both keys is `RAW`. The length of private key is 32-bytes. The length of public key is 65-bytes, The format is `04||x||y`. `04` represents the uncompressed format; `x` and `y` are the coordinates of the public point in the curve, and both are 32-bytes.

Create `KeyPairGenerator` implementation on `ECKeyPairGenerator`.

Expand Down Expand Up @@ -81,7 +81,7 @@ SM2 private key is 32-bytes length without any format.
byte[] encodedPrivateKey = privateKey.getEncoded();
```

For more infomation on key pair generation, please refer to the official [KeyPairGenerator] docs.
For more information on key pair generation, please refer to the official [KeyPairGenerator] docs.

#### Prepare public key and private key
Generally, in the signing and encrypting operations, the key pairs are already generated. They are not generated on the runtime. It just reads the existing public key and private key to create PublicKey and PrivateKey instances respectively.
Expand Down
3 changes: 0 additions & 3 deletions kona-ssl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,5 @@ Please read the official [SSLContext] reference for understanding it deeply.
[RFC 8998]:
<https://datatracker.ietf.org/doc/html/rfc8998>

[JSSE reference]:
<https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-jsse-reference-guide.html#GUID-93DEEE16-0B70-40E5-BBE7-55C3FD432345>

[SSLContext]:
<https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-jsse-reference-guide.html#GUID-C281CAF3-275F-4DE4-8B47-4A84363CF39F>
Loading