spiffe
/
java-spiffe
mirror of https://github.com/spiffe/java-spiffe.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor typo and grammar fixes. 

Signed-off-by: Max Lambrecht <maxlambrecht@gmail.com>
This commit is contained in:
Max Lambrecht 2020-06-19 15:14:30 -03:00
parent 57076ef4f5
commit fbbf17d0a3
5 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
java-spiffe-core/src/main/java/io/spiffe/spiffeid/SpiffeIdUtils.java
View File

@ -61,7 +61,7 @@ public class SpiffeIdUtils {
/** /**
* Return the list of the SPIFFE IDs parsed from the String parameter, using the default separator (comma) * Return the list of the SPIFFE IDs parsed from the String parameter, using the default separator (comma)
* *
* @param spiffeIds a String representing a list of SPIFFE IDs separeated by comma * @param spiffeIds a String representing a list of SPIFFE IDs separated by comma
* @return a list of {@link SpiffeId} instances * @return a list of {@link SpiffeId} instances
* @throws IllegalArgumentException is the string provided is blank * @throws IllegalArgumentException is the string provided is blank
*/ */

4
java-spiffe-helper/README.md
View File

@ -55,7 +55,7 @@ It is **strongly recommended** to set restrictive file permissions for KeyStore
`chmod 600 keystore_file_name` `chmod 600 keystore_file_name`
Make sure that the process running the JAVA-SPIFFE Helper has _write_ permission on the KeyStores files. Make sure the process running the JAVA-SPIFFE Helper has _write_ permission on the KeyStores files.
### Debug ### Debug
@ -63,7 +63,7 @@ To check that the certs are being stored in the KeyStore:
`keytool -list -v -keystore keystore.path -storepass example123` `keytool -list -v -keystore keystore.path -storepass example123`
The ouput should a `PrivateKeyEntry`: The output should be a `Private Key Entry`:
``` ```
Keystore type: PKCS12 Keystore type: PKCS12

4
java-spiffe-provider/README.md
View File

@ -100,7 +100,7 @@ The property `ssl.spiffe.accept` can also be defined through a System property p
#### Accept all SPIFFE IDs #### Accept all SPIFFE IDs
By default, only the SPIFFE IDs defined in the property `ssl.spiffe.accept` are accepted for a TLS connection. Thus By default, only the SPIFFE IDs defined in the property `ssl.spiffe.accept` are accepted for a TLS connection. Thus,
if the property is empty or not defined, no SPIFFE ID will be accepted. To accept all SPIFFE IDs it should be used if the property is empty or not defined, no SPIFFE ID will be accepted. To accept all SPIFFE IDs it should be used
the property `ssl.spiffe.acceptAll` and set as `true` in the Security properties file: the property `ssl.spiffe.acceptAll` and set as `true` in the Security properties file:
@ -153,7 +153,7 @@ A Tomcat TLS connector that uses the `Spiffe` KeyStore can be configured as foll
Prerequisite: Having the SPIFFE Provided configured through the `java.security`. Prerequisite: Having the SPIFFE Provided configured through the `java.security`.
A `GRPC Server` using a SSL context backed by the Workload API: A `GRPC Server` using an SSL context backed by the Workload API:
``` ```
KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(SpiffeProviderConstants.ALGORITHM, SpiffeProviderConstants.PROVIDER_NAME); KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(SpiffeProviderConstants.ALGORITHM, SpiffeProviderConstants.PROVIDER_NAME);

2
java-spiffe-provider/src/main/java/io/spiffe/provider/SpiffeSslContextFactory.java
View File

@ -29,7 +29,7 @@ public final class SpiffeSslContextFactory {
* @param options {@link SslContextOptions}. The option {@link X509Source} must be not null. * @param options {@link SslContextOptions}. The option {@link X509Source} must be not null.
* If the option acceptedSpiffeIdsSupplier is not provided, the list of accepted SPIFFE IDs * If the option acceptedSpiffeIdsSupplier is not provided, the list of accepted SPIFFE IDs
* is read from the Security or System Property ssl.spiffe.accept. * is read from the Security or System Property ssl.spiffe.accept.
* If the sslProcotol is not provided, the default TLSv1.2 is used. * If the sslProtocol is not provided, the default TLSv1.2 is used.
* @return a {@link SSLContext} * @return a {@link SSLContext}
* @throws IllegalArgumentException if the X509Source is not provided in the options * @throws IllegalArgumentException if the X509Source is not provided in the options
* @throws NoSuchAlgorithmException if there is a problem creating the SSL context * @throws NoSuchAlgorithmException if there is a problem creating the SSL context

2
java-spiffe-provider/src/main/java/io/spiffe/provider/X509SourceManager.java
View File

@ -7,7 +7,7 @@ import io.spiffe.workloadapi.X509Source;
/** /**
* Singleton that handles an instance of a {@link X509Source}. * Singleton that handles an instance of a {@link X509Source}.
* <p> * <p>
* The default SPIFFE socket enpoint address is used to create a X.509 Source backed by the * The default SPIFFE socket endpoint address is used to create a X.509 Source backed by the
* Workload API. * Workload API.
* <p> * <p>
* If the environment variable is not defined, it will throw an <code>IllegalStateException</code>. * If the environment variable is not defined, it will throw an <code>IllegalStateException</code>.