Skip to content

Commit 75a8922

Browse files
authored
Merge pull request #110373 from TimShererWithAquent/us1679050dt
Change SSL to TLS per 1679050
2 parents 170edaa + 56469df commit 75a8922

12 files changed

+28
-28
lines changed

articles/azure-cache-for-redis/cache-aspnet-output-cache-provider.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ Configure the attributes with the values from your cache blade in the Microsoft
4848
| Attribute | Type | Default | Description |
4949
| --------- | ---- | ------- | ----------- |
5050
| *host* | string | "localhost" | The Redis server IP address or host name |
51-
| *port* | positive integer | 6379 (non-SSL)<br/>6380 (SSL) | Redis server port |
51+
| *port* | positive integer | 6379 (non-TLS/SSL)<br/>6380 (TLS/SSL) | Redis server port |
5252
| *accessKey* | string | "" | Redis server password when Redis authorization is enabled. The value is empty string by default, which means the session state provider won’t use any password when connecting to Redis server. **If your Redis server is in a publicly accessible network like Azure Redis Cache, be sure to enable Redis authorization to improve security, and provide a secure password.** |
53-
| *ssl* | boolean | **false** | Whether to connect to Redis server via SSL. This value is **false** by default because Redis doesn’t support SSL out of the box. **If you are using Azure Redis Cache which supports SSL out of the box, be sure to set this to true to improve security.**<br/><br/>The non-SSL port is disabled by default for new caches. Specify **true** for this setting to use the SSL port. For more information about enabling the non-SSL port, see the [Access Ports](cache-configure.md#access-ports) section in the [Configure a cache](cache-configure.md) topic. |
53+
| *ssl* | boolean | **false** | Whether to connect to Redis server via TLS. This value is **false** by default because Redis doesn’t support TLS out of the box. **If you are using Azure Redis Cache which supports SSL out of the box, be sure to set this to true to improve security.**<br/><br/>The non-TLS port is disabled by default for new caches. Specify **true** for this setting to use the TLS port. For more information about enabling the non-TLS port, see the [Access Ports](cache-configure.md#access-ports) section in the [Configure a cache](cache-configure.md) topic. |
5454
| *databaseIdNumber* | positive integer | 0 | *This attribute can be specified only through either web.config or AppSettings.*<br/><br/>Specify which Redis database to use. |
5555
| *connectionTimeoutInMilliseconds* | positive integer | Provided by StackExchange.Redis | Used to set *ConnectTimeout* when creating StackExchange.Redis.ConnectionMultiplexer. |
5656
| *operationTimeoutInMilliseconds* | positive integer | Provided by StackExchange.Redis | Used to set *SyncTimeout* when creating StackExchange.Redis.ConnectionMultiplexer. |

articles/azure-cache-for-redis/cache-aspnet-session-state-provider.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ The commented section provides an example of the attributes and sample settings
7676
Configure the attributes with the values from your cache blade in the Microsoft Azure portal, and configure the other values as desired. For instructions on accessing your cache properties, see [Configure Azure Cache for Redis settings](cache-configure.md#configure-azure-cache-for-redis-settings).
7777

7878
* **host** – specify your cache endpoint.
79-
* **port** – use either your non-SSL port or your SSL port, depending on the ssl settings.
79+
* **port** – use either your non-TLS/SSL port or your TLS/SSL port, depending on the TLS settings.
8080
* **accessKey** – use either the primary or secondary key for your cache.
81-
* **ssl** – true if you want to secure cache/client communications with ssl; otherwise false. Be sure to specify the correct port.
82-
* The non-SSL port is disabled by default for new caches. Specify true for this setting to use the SSL port. For more information about enabling the non-SSL port, see the [Access Ports](cache-configure.md#access-ports) section in the [Configure a cache](cache-configure.md) topic.
81+
* **ssl** – true if you want to secure cache/client communications with TLS; otherwise false. Be sure to specify the correct port.
82+
* The non-TLS port is disabled by default for new caches. Specify true for this setting to use the TLS port. For more information about enabling the non-TLS port, see the [Access Ports](cache-configure.md#access-ports) section in the [Configure a cache](cache-configure.md) topic.
8383
* **throwOnError** – true if you want an exception to be thrown if there is a failure, or false if you want the operation to fail silently. You can check for a failure by checking the static Microsoft.Web.Redis.RedisSessionStateProvider.LastException property. The default is true.
8484
* **retryTimeoutInMilliseconds** – Operations that fail are retried during this interval, specified in milliseconds. The first retry occurs after 20 milliseconds, and then retries occur every second until the retryTimeoutInMilliseconds interval expires. Immediately after this interval, the operation is retried one final time. If the operation still fails, the exception is thrown back to the caller, depending on the throwOnError setting. The default value is 0, which means no retries.
8585
* **databaseId** – Specifies which database to use for cache output data. If not specified, the default value of 0 is used.

articles/azure-cache-for-redis/cache-configure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,10 @@ The following settings are configured on the **Advanced settings** blade.
113113
* [Keyspace notifications (advanced settings)](#keyspace-notifications-advanced-settings)
114114

115115
#### Access Ports
116-
By default, non-SSL access is disabled for new caches. To enable the non-SSL port, click **No** for **Allow access only via SSL** on the **Advanced settings** blade and then click **Save**.
116+
By default, non-TLS/SSL access is disabled for new caches. To enable the non-TLS port, click **No** for **Allow access only via SSL** on the **Advanced settings** blade and then click **Save**.
117117

118118
> [!NOTE]
119-
> SSL access to Azure Cache for Redis supports TLS 1.0, 1.1 and 1.2 currently, but versions 1.0 and 1.1 are being retired soon. Please read our [Remove TLS 1.0 and 1.1 page](cache-remove-tls-10-11.md) for more details.
119+
> TLS access to Azure Cache for Redis supports TLS 1.0, 1.1 and 1.2 currently, but versions 1.0 and 1.1 are being retired soon. Please read our [Remove TLS 1.0 and 1.1 page](cache-remove-tls-10-11.md) for more details.
120120
121121
![Azure Cache for Redis Access Ports](./media/cache-configure/redis-cache-access-ports.png)
122122

articles/azure-cache-for-redis/cache-faq.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The following FAQs cover basic concepts and questions about Azure Cache for Redi
4848
* [What are Redis databases?](#what-are-redis-databases)
4949

5050
## Security FAQs
51-
* [When should I enable the non-SSL port for connecting to Redis?](#when-should-i-enable-the-non-ssl-port-for-connecting-to-redis)
51+
* [When should I enable the non-TLS/SSL port for connecting to Redis?](#when-should-i-enable-the-non-tlsssl-port-for-connecting-to-redis)
5252

5353
## Production FAQs
5454
* [What are some production best practices?](#what-are-some-production-best-practices)
@@ -106,7 +106,7 @@ The following are considerations for choosing a Cache offering.
106106
<a name="cache-performance"></a>
107107

108108
### Azure Cache for Redis performance
109-
The following table shows the maximum bandwidth values observed while testing various sizes of Standard and Premium caches using `redis-benchmark.exe` from an IaaS VM against the Azure Cache for Redis endpoint. For SSL throughput, redis-benchmark is used with stunnel to connect to the Azure Cache for Redis endpoint.
109+
The following table shows the maximum bandwidth values observed while testing various sizes of Standard and Premium caches using `redis-benchmark.exe` from an IaaS VM against the Azure Cache for Redis endpoint. For TLS throughput, redis-benchmark is used with stunnel to connect to the Azure Cache for Redis endpoint.
110110

111111
>[!NOTE]
112112
>These values are not guaranteed and there is no SLA for these numbers, but should be typical. You should load test your own application to determine the right cache size for your application.
@@ -238,7 +238,7 @@ You can use any of the commands listed at [Redis commands](https://redis.io/comm
238238
* `redis-cli -h <Azure Cache for Redis name>.redis.cache.windows.net -a <key>`
239239

240240
> [!NOTE]
241-
> The Redis command-line tools do not work with the SSL port, but you can use a utility such as `stunnel` to securely connect the tools to the SSL port by following the directions in the [How to use the Redis command-line tool with Azure Cache for Redis](https://docs.microsoft.com/azure/azure-cache-for-redis/cache-how-to-redis-cli-tool) article.
241+
> The Redis command-line tools do not work with the TLS port, but you can use a utility such as `stunnel` to securely connect the tools to the TLS port by following the directions in the [How to use the Redis command-line tool with Azure Cache for Redis](https://docs.microsoft.com/azure/azure-cache-for-redis/cache-how-to-redis-cli-tool) article.
242242
>
243243
>
244244
@@ -275,15 +275,15 @@ Redis Databases are just a logical separation of data within the same Redis inst
275275

276276
<a name="cache-ssl"></a>
277277

278-
### When should I enable the non-SSL port for connecting to Redis?
279-
Redis server does not natively support SSL, but Azure Cache for Redis does. If you are connecting to Azure Cache for Redis and your client supports SSL, like StackExchange.Redis, then you should use SSL.
278+
### When should I enable the non-TLS/SSL port for connecting to Redis?
279+
Redis server does not natively support TLS, but Azure Cache for Redis does. If you are connecting to Azure Cache for Redis and your client supports TLS, like StackExchange.Redis, then you should use TLS.
280280

281281
>[!NOTE]
282-
>The non-SSL port is disabled by default for new Azure Cache for Redis instances. If your client does not support SSL, then you must enable the non-SSL port by following the directions in the [Access ports](cache-configure.md#access-ports) section of the [Configure a cache in Azure Cache for Redis](cache-configure.md) article.
282+
>The non-TLS port is disabled by default for new Azure Cache for Redis instances. If your client does not support TLS, then you must enable the non-TLS port by following the directions in the [Access ports](cache-configure.md#access-ports) section of the [Configure a cache in Azure Cache for Redis](cache-configure.md) article.
283283
>
284284
>
285285
286-
Redis tools such as `redis-cli` do not work with the SSL port, but you can use a utility such as `stunnel` to securely connect the tools to the SSL port by following the directions in the [Announcing ASP.NET Session State Provider for Redis Preview Release](https://blogs.msdn.com/b/webdev/archive/2014/05/12/announcing-asp-net-session-state-provider-for-redis-preview-release.aspx) blog post.
286+
Redis tools such as `redis-cli` do not work with the TLS port, but you can use a utility such as `stunnel` to securely connect the tools to the TLS port by following the directions in the [Announcing ASP.NET Session State Provider for Redis Preview Release](https://blogs.msdn.com/b/webdev/archive/2014/05/12/announcing-asp-net-session-state-provider-for-redis-preview-release.aspx) blog post.
287287

288288
For instructions on downloading the Redis tools, see the [How can I run Redis commands?](#cache-commands) section.
289289

@@ -306,7 +306,7 @@ For instructions on downloading the Redis tools, see the [How can I run Redis co
306306
* Develop your system such that it can handle connection blips [due to patching and failover](https://gist.github.com/JonCole/317fe03805d5802e31cfa37e646e419d#file-azureredis-patchingexplained-md).
307307

308308
#### Performance testing
309-
* Start by using `redis-benchmark.exe` to get a feel for possible throughput before writing your own perf tests. Because `redis-benchmark` does not support SSL, you must [enable the Non-SSL port through the Azure portal](cache-configure.md#access-ports) before you run the test. For examples, see [How can I benchmark and test the performance of my cache?](#how-can-i-benchmark-and-test-the-performance-of-my-cache)
309+
* Start by using `redis-benchmark.exe` to get a feel for possible throughput before writing your own perf tests. Because `redis-benchmark` does not support TLS, you must [enable the Non-TLS port through the Azure portal](cache-configure.md#access-ports) before you run the test. For examples, see [How can I benchmark and test the performance of my cache?](#how-can-i-benchmark-and-test-the-performance-of-my-cache)
310310
* The client VM used for testing should be in the same region as your Azure Cache for Redis instance.
311311
* We recommend using Dv2 VM Series for your client as they have better hardware and should give the best results.
312312
* Make sure your client VM you choose has at least as much computing and bandwidth capability as the cache you are testing.

articles/azure-cache-for-redis/cache-how-to-premium-clustering.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,15 @@ You can connect to your cache using the same [endpoints](cache-configure.md#prop
119119
### Can I directly connect to the individual shards of my cache?
120120
The clustering protocol requires that the client make the correct shard connections. So the client should do this correctly for you. With that said, each shard consists of a primary/replica cache pair, collectively known as a cache instance. You can connect to these cache instances using the redis-cli utility in the [unstable](https://redis.io/download) branch of the Redis repository at GitHub. This version implements basic support when started with the `-c` switch. For more information, see [Playing with the cluster](https://redis.io/topics/cluster-tutorial#playing-with-the-cluster) on [https://redis.io](https://redis.io) in the [Redis cluster tutorial](https://redis.io/topics/cluster-tutorial).
121121

122-
For non-ssl, use the following commands.
122+
For non-TLS, use the following commands.
123123

124124
Redis-cli.exe –h <<cachename>> -p 13000 (to connect to instance 0)
125125
Redis-cli.exe –h <<cachename>> -p 13001 (to connect to instance 1)
126126
Redis-cli.exe –h <<cachename>> -p 13002 (to connect to instance 2)
127127
...
128128
Redis-cli.exe –h <<cachename>> -p 1300N (to connect to instance N)
129129

130-
For ssl, replace `1300N` with `1500N`.
130+
For TLS, replace `1300N` with `1500N`.
131131

132132
### Can I configure clustering for a previously created cache?
133133
Yes. First ensure that your cache is premium, by scaling if is not. Next, you should be able to see the cluster configuration options, including an option to enable cluster. You can change the cluster size after the cache is created, or after you have enabled clustering for the first time.

articles/azure-cache-for-redis/cache-how-to-premium-vnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ There are eight inbound port range requirements. Inbound requests in these range
136136
There are network connectivity requirements for Azure Cache for Redis that may not be initially met in a virtual network. Azure Cache for Redis requires all the following items to function properly when used within a virtual network.
137137

138138
* Outbound network connectivity to Azure Storage endpoints worldwide. This includes endpoints located in the same region as the Azure Cache for Redis instance, as well as storage endpoints located in **other** Azure regions. Azure Storage endpoints resolve under the following DNS domains: *table.core.windows.net*, *blob.core.windows.net*, *queue.core.windows.net*, and *file.core.windows.net*.
139-
* Outbound network connectivity to *ocsp.msocsp.com*, *mscrl.microsoft.com*, and *crl.microsoft.com*. This connectivity is needed to support SSL functionality.
139+
* Outbound network connectivity to *ocsp.msocsp.com*, *mscrl.microsoft.com*, and *crl.microsoft.com*. This connectivity is needed to support TLS/SSL functionality.
140140
* The DNS configuration for the virtual network must be capable of resolving all of the endpoints and domains mentioned in the earlier points. These DNS requirements can be met by ensuring a valid DNS infrastructure is configured and maintained for the virtual network.
141141
* Outbound network connectivity to the following Azure Monitoring endpoints, which resolve under the following DNS domains: shoebox2-black.shoebox2.metrics.nsatc.net, north-prod2.prod2.metrics.nsatc.net, azglobal-black.azglobal.metrics.nsatc.net, shoebox2-red.shoebox2.metrics.nsatc.net, east-prod2.prod2.metrics.nsatc.net, azglobal-red.azglobal.metrics.nsatc.net.
142142

articles/azure-cache-for-redis/cache-how-to-redis-cli-tool.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ In this section, you will retrieve the keys from the Azure portal.
3333

3434
## Enable access for redis-cli.exe
3535

36-
With Azure Cache for Redis, only the SSL port (6380) is enabled by default. The `redis-cli.exe` command-line tool doesn't support SSL. You have two configuration choices to use it:
36+
With Azure Cache for Redis, only the TLS port (6380) is enabled by default. The `redis-cli.exe` command-line tool doesn't support TLS. You have two configuration choices to use it:
3737

38-
1. [Enable the non-SSL port (6379)](cache-configure.md#access-ports) - **This configuration is not recommended** because in this configuration, the access keys are sent via TCP in clear text. This change can compromise access to your cache. The only scenario where you might consider this configuration is when you are just accessing a test cache.
38+
1. [Enable the non-TLS port (6379)](cache-configure.md#access-ports) - **This configuration is not recommended** because in this configuration, the access keys are sent via TCP in clear text. This change can compromise access to your cache. The only scenario where you might consider this configuration is when you are just accessing a test cache.
3939

4040
2. Download and install [stunnel](https://www.stunnel.org/downloads.html).
4141

@@ -69,7 +69,7 @@ redis-cli.exe -p 6380 -a YourAccessKey
6969
7070
![stunnel with redis-cli](media/cache-how-to-redis-cli-tool/cache-redis-cli-stunnel.png)
7171
72-
If you're using a test cache with the **unsecure** non-SSL port, run `redis-cli.exe` and pass your *host name*, *port*, and *access key* (primary or secondary) to connect to the test cache.
72+
If you're using a test cache with the **unsecure** non-TLS port, run `redis-cli.exe` and pass your *host name*, *port*, and *access key* (primary or secondary) to connect to the test cache.
7373
7474
```
7575
redis-cli.exe -h yourcachename.redis.cache.windows.net -p 6379 -a YourAccessKey

articles/azure-cache-for-redis/cache-java-get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public class App
7979
String cacheHostname = System.getenv("REDISCACHEHOSTNAME");
8080
String cachekey = System.getenv("REDISCACHEKEY");
8181

82-
// Connect to the Azure Cache for Redis over the SSL port using the key.
82+
// Connect to the Azure Cache for Redis over the TLS/SSL port using the key.
8383
JedisShardInfo shardInfo = new JedisShardInfo(cacheHostname, 6380, useSsl);
8484
shardInfo.setPassword(cachekey); /* Use your access key. */
8585
Jedis jedis = new Jedis(shardInfo);

0 commit comments

Comments
 (0)