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.

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

End to End TLS SSL step #2 #16708

Merged
merged 12 commits into from
Oct 26, 2020
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
54 changes: 28 additions & 26 deletions sdk/keyvault/azure-security-keyvault-jca/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
# JCA Provider for Azure Key Vault
# Azure Key Vault JCA client library for Java
mnriem marked this conversation as resolved.
Show resolved Hide resolved

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

<!-- embedme src/samples/java/sample/ServerSSLSample.java#L20-L38 -->

```java
KeyVaultJcaProvider provider = new KeyVaultJcaProvider();
Security.addProvider(provider);
Expand All @@ -45,14 +43,16 @@ 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

If you are looking to integrate the JCA provider for client side socket
connections, see the Apache HTTP client example below.

<!-- embedme src/samples/java/sample/ClientSSLSample.java#L29-L73 -->

```java
KeyVaultJcaProvider provider = new KeyVaultJcaProvider();
Security.addProvider(provider);
Expand Down Expand Up @@ -104,24 +104,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
Copy link
Member

Choose a reason for hiding this comment

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

This section should be somewhere other than the bottom to have more visibility. What about as a part of "Getting Started"?


# 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
```
4 changes: 2 additions & 2 deletions sdk/keyvault/azure-security-keyvault-jca/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<artifactId>azure-security-keyvault-jca</artifactId>
mnriem marked this conversation as resolved.
Show resolved Hide resolved
<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>
Expand Down Expand Up @@ -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
Expand Down

This file was deleted.

Loading