End to End TLS SSL step #2

sdk/keyvault/azure-security-keyvault-jca/README.md

@@ -1,26 +1,22 @@
-# JCA Provider for Azure Key Vault
+# Azure Key Vault JCA client library for Java
+
+# Getting started
+
+# Key concepts
 
 The JCA Provider for Azure Key Vault is a JCA provider for certificates in 
 Azure Key Vault. It is built on four principles:
 
-1. Must be extremely thin to run within a JVM
-1. Must not introduce any library version conflicts with Java app code dependencies
-1. Must not introduce any class loader hierarchy conflicts with Java app code dependencies
+1. Must be extremely thin to run within a JVM.
+1. Must not introduce any library version conflicts with Java app code dependencies.
+1. Must not introduce any class loader hierarchy conflicts with Java app code dependencies.
 1. Must be ready for "never trust, always verify and credential-free" Zero Trust environments.
 
-## Testing the version under development
-
-If you want to test the current version under development you will have to
-build and install it into your local Maven repository. To do so use the 
-following command line:
-
-```
-  mvn clean install -DskipTests=true
-```
+# Examples
 
 ## Server side SSL
 
-If you are looking to integrate the JCA provider to create a SSLServerSocket
+If you are looking to integrate the JCA provider to create an SSLServerSocket
 see the example below.
 
 ```java
@@ -45,7 +41,7 @@ see the example below.
     SSLServerSocket serverSocket = (SSLServerSocket) factory.createServerSocket(8765);
 ```
 
-Note if you want to use Azure managed identity, you should set the value
+Note if you want to use Azure Managed Identity, you should set the value
 of `azure.keyvault.uri`, and the rest of the parameters would be `null`.
 
 ## Client side SSL
@@ -104,24 +100,26 @@ connections, see the Apache HTTP client example below.
 Note if you want to use Azure managed identity, you should set the value
 of `azure.keyvault.uri`, and the rest of the parameters would be `null`.
 
+# Troubleshooting
+
+# Next steps
+
 ## Spring Boot
 
-For Spring Boot applications see our [Spring Boot starter]<!--(../../spring/azure-spring-boot-starter-keyvault-certificates/README.md)-->.
+For Spring Boot applications see our [Spring Boot starter](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/spring/azure-spring-boot-starter-keyvault-certificates/README.md).
 
 ## Reference
 
 1. [Java Cryptography Architecture (JCA) Reference Guide](https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html)
 
-# Azure KeyVault JCA client library for Java
-
-# Getting started
-
-# Key concepts
-
-# Examples
+# Contributing
 
-# Troubleshooting
+## Testing the version under development
 
-# Next steps
+If you want to test the current version under development you will have to
+build and install it into your local Maven repository. To do so use the 
+following command line:
 
-# Contributing
+```
+  mvn clean install -DskipTests=true
+```

sdk/keyvault/azure-security-keyvault-jca/pom.xml

@@ -16,7 +16,7 @@
     <artifactId>azure-security-keyvault-jca</artifactId>
     <version>1.0.0-beta.2</version> <!-- {x-version-update;com.azure:azure-security-keyvault-jca;current} -->
     <name>JCA Provider for Azure Key Vault</name>
-    <description>The Java Crypto Architecture (JCA) Provider for Azure KeyVault</description>
+    <description>The Java Crypto Architecture (JCA) Provider for Azure Key Vault</description>
     <build>
         <plugins>
             <plugin>
@@ -195,7 +195,7 @@
 
               To run the integration tests pass in the following system properties
 
-              - azure.keyvault.uri    - the KeyVault URI
+              - azure.keyvault.uri    - the Azure Key Vault URI
               - azure.tenant.id       - your tenant ID
               - azure.client.id       - the (application) client ID
               - azure.client.secret   - the (application) client secret

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultCertificate.java

@@ -19,7 +19,7 @@
 import java.util.Set;
 
 /**
- * The KeyVault certificate.
+ * The Azure Key Vault certificate.
  */
 class KeyVaultCertificate extends X509Certificate {
 

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultClient.java

@@ -34,7 +34,7 @@
 import static java.util.logging.Level.WARNING;
 
 /**
- * The REST client specific to Azure KeyVault.
+ * The REST client specific to Azure Key Vault.
  */
 class KeyVaultClient extends DelegateRestClient {
 
@@ -49,7 +49,7 @@ class KeyVaultClient extends DelegateRestClient {
     private static final String API_VERSION_POSTFIX = "?api-version=7.1";
 
     /**
-     * Stores the KeyVault URI.
+     * Stores the Azure Key Vault URI.
      */
     private final String keyVaultUri;
 
@@ -71,11 +71,11 @@ class KeyVaultClient extends DelegateRestClient {
     /**
      * Constructor.
      *
-     * @param keyVaultUri the KeyVault URI.
+     * @param keyVaultUri the Azure Key Vault URI.
      */
     KeyVaultClient(String keyVaultUri) {
         super(RestClientFactory.createClient());
-        LOGGER.log(INFO, "Using KeyVault: {0}", keyVaultUri);
+        LOGGER.log(INFO, "Using Azure Key Vault: {0}", keyVaultUri);
         if (!keyVaultUri.endsWith("/")) {
             keyVaultUri = keyVaultUri + "/";
         }
@@ -85,7 +85,7 @@ class KeyVaultClient extends DelegateRestClient {
     /**
      * Constructor.
      *
-     * @param keyVaultUri the KeyVault URI.
+     * @param keyVaultUri the Azure Key Vault URI.
      * @param tenantId the tenant ID.
      * @param clientId the client ID.
      * @param clientSecret the client secret.
@@ -212,8 +212,8 @@ public Key getKey(String alias, char[] password) {
                                        .orElse(false);
         if (isExportable) {
             // Because the certificate is exportable the private key is
-            // available. So we'll use the KeyVault Secrets API to get the 
-            // private key.
+            // available. So we'll use the Azure Key Vault Secrets API to get
+            // the private key.
             String certificateSecretUri = certificateBundle.getSid();
             HashMap<String, String> headers = new HashMap<>();
             headers.put("Authorization", "Bearer " + getAccessToken());

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultJcaProvider.java

@@ -10,7 +10,7 @@
 import java.util.Collections;
 
 /**
- * The Azure KeyVault security provider.
+ * The Azure Key Vault security provider.
  */
 public class KeyVaultJcaProvider extends Provider {
 
@@ -22,7 +22,7 @@ public class KeyVaultJcaProvider extends Provider {
     /**
      * Stores the information.
      */
-    private static final String INFO = "Azure KeyVault JCA Provider";
+    private static final String INFO = "Azure Key Vault JCA Provider";
 
     /**
      * Stores the name.

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultKeyManager.java

@@ -22,7 +22,7 @@
 import static java.util.logging.Level.WARNING;
 
 /**
- * The KeyVault variant of the X509ExtendedKeyManager.
+ * The Azure Key Vault variant of the X509ExtendedKeyManager.
  */
 public class KeyVaultKeyManager extends X509ExtendedKeyManager {
 
@@ -63,8 +63,8 @@ public String chooseClientAlias(String[] keyType, Principal[] issuers, Socket so
         String alias = null;
         try {
             /*
-             * If we only have one alias and the keystore type is not 'AzureKeyVault'
-             * return that alias as a match.
+             * If we only have one alias and the keystore type is not 
+             * 'AzureKeyVault' return that alias as a match.
              */
             if (!keystore.getProvider().getName().equals("AzureKeyVault")
                 && keystore.size() == 1) {
@@ -87,8 +87,8 @@ public String chooseServerAlias(String keyType, Principal[] issuers, Socket sock
         String alias = null;
         try {
             /*
-             * If we only have one alias and the keystore type is not 'AzureKeyVault'
-             * return that alias as a match.
+             * If we only have one alias and the keystore type is not 
+             * 'AzureKeyVault' return that alias as a match.
              */
             if (!keystore.getProvider().getName().equals("AzureKeyVault")
                 && keystore.size() == 1) {

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultKeyManagerFactory.java

@@ -12,7 +12,7 @@
 import java.util.logging.Logger;
 
 /**
- * The KeyVault variant of the KeyManagerFactory.
+ * The Azure Key Vault variant of the KeyManagerFactory.
  */
 public class KeyVaultKeyManagerFactory extends KeyManagerFactorySpi {
 

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultKeyStore.java

@@ -32,7 +32,7 @@
 import static java.util.logging.Level.WARNING;
 
 /**
- * The Azure KeyVault implementation of the KeyStoreSpi.
+ * The Azure Key Vault implementation of the KeyStoreSpi.
  */
 public class KeyVaultKeyStore extends KeyStoreSpi {
 

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultLoadStoreParameter.java

@@ -6,7 +6,7 @@
 import java.security.KeyStore;
 
 /**
- * The Azure KeyVault LoadStoreParameter of the KeyStoreSpi.
+ * The Azure Key Vault LoadStoreParameter of the KeyStoreSpi.
  */
 public class KeyVaultLoadStoreParameter implements KeyStore.LoadStoreParameter {
 
@@ -33,7 +33,7 @@ public class KeyVaultLoadStoreParameter implements KeyStore.LoadStoreParameter {
     /**
      * Constructor.
      *
-     * @param uri the KeyVault URI.
+     * @param uri the Azure Key Vault URI.
      * @param tenantId the tenant ID.
      * @param clientId the client ID.
      * @param clientSecret the client secret.

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultTrustManager.java

@@ -17,7 +17,7 @@
 import javax.net.ssl.X509ExtendedTrustManager;
 
 /**
- * The KeyVault variant of the X509TrustManager.
+ * The Azure Key Vault variant of the X509TrustManager.
  */
 public class KeyVaultTrustManager extends X509ExtendedTrustManager implements X509TrustManager {
 

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultTrustManagerFactory.java

@@ -12,7 +12,7 @@
 import java.util.logging.Logger;
 
 /**
- * The KeyVault variant of the TrustManagerFactory.
+ * The Azure Key Vault variant of the TrustManagerFactory.
  */
 public class KeyVaultTrustManagerFactory extends TrustManagerFactorySpi {
 

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/KeyVaultTrustManagerFactoryProvider.java

@@ -8,7 +8,7 @@
 import java.security.Provider;
 
 /**
- * The Azure KeyVault TrustManagerFactory provider.
+ * The Azure Key Vault TrustManagerFactory provider.
  */
 public class KeyVaultTrustManagerFactoryProvider extends Provider {
 
@@ -20,7 +20,7 @@ public class KeyVaultTrustManagerFactoryProvider extends Provider {
     /**
      * Stores the information.
      */
-    private static final String INFO = "Azure KeyVault TrustManagerFactory Provider";
+    private static final String INFO = "Azure Key Vault TrustManagerFactory Provider";
 
     /**
      * Stores the name.

sdk/keyvault/azure-security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/package-info.java

@@ -2,6 +2,6 @@
 // Licensed under the MIT License.
 
 /**
- * The Azure KeyVault JCA Provider package.
+ * The Azure Key Vault JCA Provider package.
  */
 package com.azure.security.keyvault.jca;

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/AuthClientTest.java

@@ -11,8 +11,6 @@
 
 /**
  * The JUnit test for the AuthClient.
- *
- * @author Manfred Riem ([email protected])
  */
 public class AuthClientTest {
 

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/DelegateRestClientTest.java

@@ -9,8 +9,6 @@
 
 /**
  * The JUnit tests for the DelegateRestClient class.
- *
- * @author Manfred Riem ([email protected])
  */
 public class DelegateRestClientTest {
 

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/JacksonJsonConverterTest.java

@@ -12,8 +12,6 @@
 
 /**
  * The JUnit tests for the JsonbJsonConverter class.
- *
- * @author Manfred Riem ([email protected])
  */
 public class JacksonJsonConverterTest {
 

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/KeyVaultCertificateTest.java

@@ -33,8 +33,6 @@
 
 /**
  * The JUnit tests for the KeyVaultCertificate class.
- *
- * @author Manfred Riem ([email protected])
  */
 public class KeyVaultCertificateTest {
 

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/KeyVaultJcaProviderTest.java

@@ -13,8 +13,6 @@
 
 /**
  * The JUnit tests for the KeyVaultProvider class.
- *
- * @author Manfred Riem ([email protected])
  */
 public class KeyVaultJcaProviderTest {
 

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/KeyVaultKeyStoreTest.java

@@ -19,8 +19,6 @@
 
 /**
  * The JUnit tests for the KeyVaultKeyStore class.
- *
- * @author Manfred Riem ([email protected])
  */
 public class KeyVaultKeyStoreTest {
 

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/KeyVaultLoadStoreParameterTest.java

@@ -9,8 +9,6 @@
 
 /**
  * The JUnit tests for the KeyVaultLoadStoreParameter class.
- *
- * @author Manfred Riem ([email protected])
  */
 public class KeyVaultLoadStoreParameterTest {
 

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/LegacyRestClientTest.java

@@ -9,8 +9,6 @@
 
 /**
  * The JUnit tests for the LegacyRestClient class.
- *
- * @author Manfred Riem ([email protected])
  */
 public class LegacyRestClientTest {
 

sdk/keyvault/azure-security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/RestClientFactoryTest.java

@@ -9,8 +9,6 @@
 
 /**
  * The JUnit tests for the RestClientFactory class.
- *
- * @author Manfred Riem ([email protected])
  */
 public class RestClientFactoryTest {