Skip to content

Commit

Permalink
Breaking change correction (#44695)
Browse files Browse the repository at this point in the history
* fixes #43828

* whoops extra line
  • Loading branch information
CamSoper authored Feb 7, 2025
1 parent 90c1904 commit 2ce6cc6
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/core/compatibility/10.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,10 @@ If you're migrating an app to .NET 10, the breaking changes listed here might af

## Cryptography

| Title | Type of change | Introduced version |
|--------------------------------------------------------------------------------------------------------|-------------------|--------------------|
| [X500DistinguishedName validation is stricter](cryptography/10.0/x500distinguishedname-validation.md) | Behavioral change | Preview 1 |
| Title | Type of change | Introduced version |
|------------------------------------------------------------------------------------------------------------|-------------------|--------------------|
| [X500DistinguishedName validation is stricter](cryptography/10.0/x500distinguishedname-validation.md) | Behavioral change | Preview 1 |
| [Environment variable renamed to DOTNET_OPENSSL_VERSION_OVERRIDE](cryptography/10.0/version-override.md) | Behavioral change | Preview 1 |

## Windows Forms

Expand Down
38 changes: 38 additions & 0 deletions docs/core/compatibility/cryptography/10.0/version-override.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Breaking change: Environment variable renamed to DOTNET_OPENSSL_VERSION_OVERRIDE"
description: Learn about the .NET 10 breaking change in .NET cryptography where the environment variable CLR_OPENSSL_VERSION_OVERRIDE was renamed to DOTNET_OPENSSL_VERSION_OVERRIDE.
ms.date: 02/05/2025
ai-usage: ai-assisted
---

# Environment variable renamed to DOTNET_OPENSSL_VERSION_OVERRIDE

.NET previously supported a configuration-switch environment variable called `CLR_OPENSSL_VERSION_OVERRIDE`, which allowed users to specify the preferred OpenSSL library version for apps running on Linux. In .NET 10, this environment variable has been renamed to `DOTNET_OPENSSL_VERSION_OVERRIDE` to align with the naming convention of other configuration switch environment variables in .NET.

## Previous behavior

The `CLR_OPENSSL_VERSION_OVERRIDE` environment variable was used to specify the preferred OpenSSL version to be loaded in the application.

## New behavior

The `DOTNET_OPENSSL_VERSION_OVERRIDE` environment variable is used to specify the preferred OpenSSL version to be loaded in the application.

## Version introduced

.NET 10 Preview 1

## Type of breaking change

This change is a [behavioral change](../../categories.md#behavioral-change).

## Reason for change

This change ensures the environment variable is consistent with the naming convention used for all [.NET environment variables](../../../tools/dotnet-environment-variables.md).

## Recommended action

If you have a .NET 10 app that previously used the `CLR_OPENSSL_VERSION_OVERRIDE` environment variable, use `DOTNET_OPENSSL_VERSION_OVERRIDE` instead.

## Affected APIs

N/A
4 changes: 4 additions & 0 deletions docs/core/compatibility/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ items:
items:
- name: X500DistinguishedName validation is stricter
href: cryptography/10.0/x500distinguishedname-validation.md
- name: Environment variable renamed to DOTNET_OPENSSL_VERSION_OVERRIDE
href: cryptography/10.0/version-override.md
- name: Globalization
items:
- name: Environment variable renamed to DOTNET_ICU_VERSION_OVERRIDE
Expand Down Expand Up @@ -1584,6 +1586,8 @@ items:
items:
- name: X500DistinguishedName validation is stricter
href: cryptography/10.0/x500distinguishedname-validation.md
- name: Environment variable renamed to DOTNET_OPENSSL_VERSION_OVERRIDE
href: cryptography/10.0/version-override.md
- name: .NET 9
items:
- name: SafeEvpPKeyHandle.DuplicateHandle up-refs the handle
Expand Down

0 comments on commit 2ce6cc6

Please sign in to comment.