Skip to content

Commit efbe18c

Browse files
Merge pull request #108972 from TimShererWithAquent/us1679050af
Change SSL to TLS per 1679050
2 parents 65bed05 + eb2d9ad commit efbe18c

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

articles/cosmos-db/local-emulator-export-ssl-certificates.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Export the Azure Cosmos DB Emulator certificates
3-
description: When developing in languages and runtimes that do not use the Windows Certificate Store you will need to export and manage the SSL certificates. This post gives step by step instructions.
3+
description: When developing in languages and runtimes that do not use the Windows Certificate Store you will need to export and manage the TLS/SSL certificates. This post gives step by step instructions.
44
ms.service: cosmos-db
55
ms.topic: conceptual
66
ms.date: 05/23/2019
@@ -13,13 +13,13 @@ ms.author: dech
1313

1414
[**Download the Emulator**](https://aka.ms/cosmosdb-emulator)
1515

16-
The Azure Cosmos DB Emulator provides a local environment that emulates the Azure Cosmos DB service for development purposes including its use of SSL connections. This post demonstrates how to export the SSL certificates for use in languages and runtimes that do not integrate with the Windows Certificate Store such as Java which uses its own [certificate store](https://docs.oracle.com/cd/E19830-01/819-4712/ablqw/index.html) and Python which uses [socket wrappers](https://docs.python.org/2/library/ssl.html) and Node.js which uses [tlsSocket](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback). You can read more about the emulator in [Use the Azure Cosmos DB Emulator for development and testing](./local-emulator.md).
16+
The Azure Cosmos DB Emulator provides a local environment that emulates the Azure Cosmos DB service for development purposes including its use of TLS connections. This post demonstrates how to export the TLS/SSL certificates for use in languages and runtimes that do not integrate with the Windows Certificate Store such as Java which uses its own [certificate store](https://docs.oracle.com/cd/E19830-01/819-4712/ablqw/index.html) and Python which uses [socket wrappers](https://docs.python.org/2/library/ssl.html) and Node.js which uses [tlsSocket](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback). You can read more about the emulator in [Use the Azure Cosmos DB Emulator for development and testing](./local-emulator.md).
1717

1818
This tutorial covers the following tasks:
1919

2020
> [!div class="checklist"]
2121
> * Rotating certificates
22-
> * Exporting SSL certificate
22+
> * Exporting TLS/SSL certificate
2323
> * Learning how to use the certificate in Java, Python, and Node.js
2424
2525
## Certification rotation
@@ -30,7 +30,7 @@ Both certificates can be regenerated by clicking **Reset Data** as shown below f
3030

3131
![Azure Cosmos DB local emulator reset data](./media/local-emulator-export-ssl-certificates/database-local-emulator-reset-data.png)
3232

33-
## How to export the Azure Cosmos DB SSL certificate
33+
## How to export the Azure Cosmos DB TLS/SSL certificate
3434

3535
1. Start the Windows Certificate manager by running certlm.msc and navigate to the Personal->Certificates folder and open the certificate with the friendly name **DocumentDbEmulatorCertificate**.
3636

@@ -70,23 +70,23 @@ When running Java applications or MongoDB applications that use the Java client
7070

7171
Follow the instructions in the [Adding a Certificate to the Java CA Certificates Store](https://docs.microsoft.com/azure/java-add-certificate-ca-store) to import the X.509 certificate into the default Java certificate store. Keep in mind you will be working in the %JAVA_HOME% directory when running keytool.
7272

73-
Once the "CosmosDBEmulatorCertificate" SSL certificate is installed your application should be able to connect and use the local Azure Cosmos DB Emulator. If you continue to have trouble you may want to follow the [Debugging SSL/TLS Connections](https://docs.oracle.com/javase/7/docs/technotes/guides/security/jsse/ReadDebug.html) article. It is very likely the certificate is not installed into the %JAVA_HOME%/jre/lib/security/cacerts store. For example if you have multiple installed versions of Java your application may be using a different cacerts store than the one you updated.
73+
Once the "CosmosDBEmulatorCertificate" TLS/SSL certificate is installed your application should be able to connect and use the local Azure Cosmos DB Emulator. If you continue to have trouble you may want to follow the [Debugging SSL/TLS Connections](https://docs.oracle.com/javase/7/docs/technotes/guides/security/jsse/ReadDebug.html) article. It is very likely the certificate is not installed into the %JAVA_HOME%/jre/lib/security/cacerts store. For example if you have multiple installed versions of Java your application may be using a different cacerts store than the one you updated.
7474

7575
## How to use the certificate in Python
7676

77-
By default the [Python SDK(version 2.0.0 or higher)](sql-api-sdk-python.md) for the SQL API will not try and use the SSL certificate when connecting to the local emulator. If however you want to use SSL validation you can follow the examples in the [Python socket wrappers](https://docs.python.org/2/library/ssl.html) documentation.
77+
By default the [Python SDK(version 2.0.0 or higher)](sql-api-sdk-python.md) for the SQL API will not try and use the TLS/SSL certificate when connecting to the local emulator. If however you want to use TLS validation you can follow the examples in the [Python socket wrappers](https://docs.python.org/2/library/ssl.html) documentation.
7878

7979
## How to use the certificate in Node.js
8080

81-
By default the [Node.js SDK(version 1.10.1 or higher)](sql-api-sdk-node.md) for the SQL API will not try and use the SSL certificate when connecting to the local emulator. If however you want to use SSL validation you can follow the examples in the [Node.js documentation](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback).
81+
By default the [Node.js SDK(version 1.10.1 or higher)](sql-api-sdk-node.md) for the SQL API will not try and use the TLS/SSL certificate when connecting to the local emulator. If however you want to use TLS validation you can follow the examples in the [Node.js documentation](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback).
8282

8383
## Next steps
8484

8585
In this tutorial, you've done the following:
8686

8787
> [!div class="checklist"]
8888
> * Rotated certificates
89-
> * Exported the SSL certificate
89+
> * Exported the TLS/SSL certificate
9090
> * Learned how to use the certificate in Java, Python and Node.js
9191
9292
You can now proceed to the concepts section for more information about Azure Cosmos DB.

articles/cosmos-db/sql-api-nodejs-get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Now that your app exists, you need to make sure it can talk to Azure Cosmos DB.
120120
```
121121

122122
> [!Note]
123-
> If connecting to the **Cosmos DB Emulator**, disable SSL verification for your node process:
123+
> If connecting to the **Cosmos DB Emulator**, disable TLS verification for your node process:
124124
> ```
125125
> process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
126126
> const client = new CosmosClient({ endpoint, key });

articles/cosmos-db/sql-api-sdk-node.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ Not always the most visible changes, but they help our team ship better code, fa
314314
### <a name="1.11.0"/>1.11.0</a>
315315
* Added the support for aggregation queries (COUNT, MIN, MAX, SUM, and AVG).
316316
* Added the option for controlling degree of parallelism for cross partition queries.
317-
* Added the option for disabling SSL verification when running against Azure Cosmos DB Emulator.
317+
* Added the option for disabling TLS verification when running against Azure Cosmos DB Emulator.
318318
* Lowered minimum throughput on partitioned collections from 10,100 RU/s to 2500 RU/s.
319319
* Fixed the continuation token bug for single partition collection. GitHub issue #107.
320320
* Fixed the executeStoredProcedure bug in handling 0 as single param. GitHub issue #155.
@@ -324,7 +324,7 @@ Not always the most visible changes, but they help our team ship better code, fa
324324
* Minor code cleanup.
325325

326326
### <a name="1.10.1"/>1.10.1</a>
327-
* Disabling SSL verification when using the SDK to target the emulator(hostname=localhost).
327+
* Disabling TLS verification when using the SDK to target the emulator(hostname=localhost).
328328
* Added support for enabling script logging during stored procedure execution.
329329

330330
### <a name="1.10.0"/>1.10.0</a>

articles/cosmos-db/storage-explorer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,14 +210,14 @@ There are a few reasons you may be seeing this error, the two most common ones a
210210

211211
+ You're behind a *transparent proxy*, which means someone (such as your IT department) is intercepting HTTPS traffic, decrypting it, and then encrypting it using a self-signed certificate.
212212

213-
+ You're running software, such as anti-virus software, which is injecting a self-signed SSL certificates into the HTTPS messages you receive.
213+
+ You're running software, such as anti-virus software, which is injecting a self-signed TLS/SSL certificates into the HTTPS messages you receive.
214214

215215
When Storage Explorer encounters one of these "self-signed certificates", it can no longer know if the HTTPS message it's receiving has been tampered with. If you have a copy of the self-signed certificate though, then you can tell Storage Explorer to trust it. If you're unsure of who is injecting the certificate, then you can try to find it yourself by doing the following steps:
216216

217-
1. Install Open SSL
217+
1. Install OpenSSL
218218
- [Windows](https://slproweb.com/products/Win32OpenSSL.html) (any of the light versions is ok)
219219
- Mac and Linux: Should be included with your operating system
220-
2. Run Open SSL
220+
2. Run OpenSSL
221221
- Windows: Go to the install directory, then **/bin/**, then double-click on **openssl.exe**.
222222
- Mac and Linux: execute **openssl** from a terminal
223223
3. Execute `s_client -showcerts -connect microsoft.com:443`

articles/cosmos-db/tutorial-setup-ci-cd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,4 +172,4 @@ If you are setting up the CI/CD pipeline by using a YAML task, you can define th
172172
173173
To learn more about using the emulator for local development and testing, see [Use the Azure Cosmos DB Emulator for local development and testing](https://docs.microsoft.com/azure/cosmos-db/local-emulator).
174174
175-
To export emulator SSL certificates, see [Export the Azure Cosmos DB Emulator certificates for use with Java, Python, and Node.js](https://docs.microsoft.com/azure/cosmos-db/local-emulator-export-ssl-certificates)
175+
To export emulator TLS/SSL certificates, see [Export the Azure Cosmos DB Emulator certificates for use with Java, Python, and Node.js](https://docs.microsoft.com/azure/cosmos-db/local-emulator-export-ssl-certificates)

0 commit comments

Comments
 (0)