Skip to content

Conversation

souvikghosh04
Copy link
Contributor

@souvikghosh04 souvikghosh04 commented May 15, 2025

Why make this change?

  • Handle SSL validation failures in Health check when run in untrusted cert and allow option to run with self signed cert
  • Allow docker container to run on any port internally and allow health check API to use the internal port

What is this change?

  • Added support for specifying self signed cert (true/false) in environment variable- USE_SELF_SIGNED_CERT
  • Added support for running container on different ports as specified in environment variable- ASPNETCORE_URLS=http://+:5000

Usage

  • The internal port is usually 5000 and is set with environment variable ASPNETCORE_URLS which is where is the runtime is started
  • This port is not required to be changed, however, it can be overridden by setting the environment variable ASPNETCORE_URLS to http://+:<internal_port>
  • When using docker run, the --publish <external_port>:<internal_port> must match the internal port, as specified in the ASPNETCORE_URLS environment variable
  • For orchestrated environments, like- ACI, AKS etc, the internal port is set in the same way in environment variable, additionally, the external port is set in the service configuration (or as applicable to the specific orchestration tool)

How was this tested?

Running on same external and internal port. This was the existing way.

docker run --name dab-dev --publish 5000:5000 --detach --mount type=bind,source=$(pwd)/dab-config.json,target=/App/dab-config.json,readonly dab-dev:26may25

Running on different external and internal ports. With this, we can expose an external port which is different than the internal container port.

docker run --name dab-dev --publish 1234:5000 --detach --mount type=bind,source=$(pwd)/dab-config.json,target=/App/dab-config.json,readonly dab-dev:26may25

image

## Sample Request(s)

GET http://localhost:1234/health
Accept: application/json

@souvikghosh04 souvikghosh04 marked this pull request as ready for review May 15, 2025 17:20
@Copilot Copilot AI review requested due to automatic review settings May 15, 2025 17:20
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request updates the HttpClient configuration to support container ports and SSL validation fixes, including handling self-signed certificates.

  • Adds a conditional debugger launch for troubleshooting.
  • Enhances HttpClient configuration by reading the ASPNETCORE_URLS environment variable to dynamically set the port.
  • Introduces support for allowing self-signed certificates via an environment variable.

@Aniruddh25
Copy link
Collaborator

Do we expect customers to run their docker adding the following arguments for these bugs to be fixed?

-e USE_SELF_SIGNED_CERT=false --publish 1234:5001

Copy link
Collaborator

@Aniruddh25 Aniruddh25 left a comment

Choose a reason for hiding this comment

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

Waiting on answers to some usability questions..

@RubenCerna2079
Copy link
Contributor

@souvikghosh04 I think it would be a good idea to create a task so that we can track this

@souvikghosh04
Copy link
Contributor Author

/azp run

Copy link

Azure Pipelines successfully started running 6 pipeline(s).

@souvikghosh04
Copy link
Contributor Author

/azp run

Copy link

Azure Pipelines successfully started running 6 pipeline(s).

@Aniruddh25 Aniruddh25 modified the milestones: 1.6, 1.5 May 28, 2025
Copy link
Contributor

@RubenCerna2079 RubenCerna2079 left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the fix @Souvik04

@Aniruddh25
Copy link
Collaborator

Did we plan to support these environment variables as well?
ASPNETCORE_HTTP_PORTS=80;8080
ASPNETCORE_HTTPS_PORTS=443;8081

@Aniruddh25
Copy link
Collaborator

/azp run

Copy link

Azure Pipelines successfully started running 6 pipeline(s).

Copy link
Collaborator

@Aniruddh25 Aniruddh25 left a comment

Choose a reason for hiding this comment

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

Looks good with support for ASPNETCORE_URLS. But if we need ASPNETCORE_HTTPS_PORTS, please create a separate PR.

@souvikghosh04
Copy link
Contributor Author

/azp run

Copy link

Azure Pipelines successfully started running 6 pipeline(s).

@souvikghosh04 souvikghosh04 enabled auto-merge (squash) May 29, 2025 05:51
@souvikghosh04
Copy link
Contributor Author

@souvikghosh04 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree company="Microsoft"

@souvikghosh04 souvikghosh04 merged commit 433c0b0 into main May 29, 2025
11 checks passed
@souvikghosh04 souvikghosh04 deleted the Usr/sogh/httpclientfixes branch May 29, 2025 07:12
@github-project-automation github-project-automation bot moved this from Review In Progress to Done in Data API builder May 29, 2025
.ConfigurePrimaryHttpMessageHandler(serviceProvider =>
{
// For debug purpose, USE_SELF_SIGNED_CERT can be set to true in Environment variables
bool allowSelfSigned = Environment.GetEnvironmentVariable("USE_SELF_SIGNED_CERT")?.Equals("true", StringComparison.OrdinalIgnoreCase) == true;
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: for bool names try to use a prefix such as is so isSelfSigned or isSelfSignEnabled, or something similar.

if (httpContext is not null &&
httpContext.Request.Headers.TryGetValue("X-Forwarded-Port", out StringValues fwdPortVal) &&
int.TryParse(fwdPortVal.ToString(), out int fwdPort) &&
fwdPort > 0)
Copy link
Contributor

Choose a reason for hiding this comment

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

I presume you're checking fwdPort > 0 as a sanity check to make sure the port number is valid, but shouldn't we add a check on the upper limit then too, so something like fwdPort > 0 && fwdPort < 65536 ?

int colonIndex = trimmed.LastIndexOf(':');
if (colonIndex != -1 &&
int.TryParse(trimmed.Substring(colonIndex + 1), out int wildcardPort) &&
wildcardPort > 0)
Copy link
Contributor

Choose a reason for hiding this comment

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

similar comment as above, should we also check the upper bound for valid ports?

string trimmed = part.Trim();

// Handle wildcard format (e.g. http://+:5002)
if (trimmed.StartsWith($"{scheme}://+:", StringComparison.OrdinalIgnoreCase))
Copy link
Contributor

@aaronburtle aaronburtle May 29, 2025

Choose a reason for hiding this comment

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

should we handle a weak wildcard format as well which uses * instead of +, so http://*:<port> they're mentioned as an option in these docs

https://learn.microsoft.com/en-us/windows/win32/http/urlprefix-strings

likewise, would http://[::]:<port> be valid? and if so, could this break the usage of LastIndexOf(':')? I guess not since its only looking for the last :

RubenCerna2079 pushed a commit that referenced this pull request May 29, 2025
- Handle SSL validation failures in Health check when run in untrusted
cert and allow option to run with self signed cert
- Allow docker container to run on any port internally and allow health
check API to use the internal port

- Added support for specifying self signed cert (true/false) in
environment variable- `USE_SELF_SIGNED_CERT`
- Added support for running container on different ports as specified in
environment variable- `ASPNETCORE_URLS=http://+:5000`

- The internal port is usually 5000 and is set with environment variable
`ASPNETCORE_URLS` which is where is the runtime is started
- This port is not required to be changed, however, it can be overridden
by setting the environment variable `ASPNETCORE_URLS` to
`http://+:<internal_port>`
- When using `docker run`, the `--publish
<external_port>:<internal_port>` must match the internal port, as
specified in the `ASPNETCORE_URLS` environment variable
- For orchestrated environments, like- ACI, AKS etc, the internal port
is set in the same way in environment variable, additionally, the
external port is set in the service configuration (or as applicable to
the specific orchestration tool)

Running on same external and internal port. This was the existing way.

```
docker run --name dab-dev --publish 5000:5000 --detach --mount type=bind,source=$(pwd)/dab-config.json,target=/App/dab-config.json,readonly dab-dev:26may25

```

Running on different external and internal ports. With this, we can
expose an external port which is different than the internal container
port.

```
docker run --name dab-dev --publish 1234:5000 --detach --mount type=bind,source=$(pwd)/dab-config.json,target=/App/dab-config.json,readonly dab-dev:26may25

```

![image](https://github.com/user-attachments/assets/9beb1060-0f14-4491-b93a-905fca620b03)

```

GET http://localhost:1234/health
Accept: application/json

---------

Co-authored-by: Souvik Ghosh <[email protected]>
Co-authored-by: Aniruddh Munde <[email protected]>
RubenCerna2079 pushed a commit that referenced this pull request May 29, 2025
- Handle SSL validation failures in Health check when run in untrusted
cert and allow option to run with self signed cert
- Allow docker container to run on any port internally and allow health
check API to use the internal port

- Added support for specifying self signed cert (true/false) in
environment variable- `USE_SELF_SIGNED_CERT`
- Added support for running container on different ports as specified in
environment variable- `ASPNETCORE_URLS=http://+:5000`

- The internal port is usually 5000 and is set with environment variable
`ASPNETCORE_URLS` which is where is the runtime is started
- This port is not required to be changed, however, it can be overridden
by setting the environment variable `ASPNETCORE_URLS` to
`http://+:<internal_port>`
- When using `docker run`, the `--publish
<external_port>:<internal_port>` must match the internal port, as
specified in the `ASPNETCORE_URLS` environment variable
- For orchestrated environments, like- ACI, AKS etc, the internal port
is set in the same way in environment variable, additionally, the
external port is set in the service configuration (or as applicable to
the specific orchestration tool)

Running on same external and internal port. This was the existing way.

```
docker run --name dab-dev --publish 5000:5000 --detach --mount type=bind,source=$(pwd)/dab-config.json,target=/App/dab-config.json,readonly dab-dev:26may25

```

Running on different external and internal ports. With this, we can
expose an external port which is different than the internal container
port.

```
docker run --name dab-dev --publish 1234:5000 --detach --mount type=bind,source=$(pwd)/dab-config.json,target=/App/dab-config.json,readonly dab-dev:26may25

```

![image](https://github.com/user-attachments/assets/9beb1060-0f14-4491-b93a-905fca620b03)

```

GET http://localhost:1234/health
Accept: application/json

---------

Co-authored-by: Souvik Ghosh <[email protected]>
Co-authored-by: Aniruddh Munde <[email protected]>
aaronburtle added a commit that referenced this pull request May 29, 2025
## Why make this change?

This change is made in order to add all of the commits for milestone 1.5
into its respective branch.

## What is this change?

This change cherry-picks all of the commits that were added after the
first release candidate.
Cherry-picked commits:
 - #2648 
#2657
#2617 
#2659 
#2655 
#2633 
#2667 
#2673 
#2650 
#2695 
#2702 
#2688

## How was this tested?

- [ ] Integration Tests
- [ ] Unit Tests

## Sample Request(s)

---------

Co-authored-by: Sezal Chug <[email protected]>
Co-authored-by: sezalchug <[email protected]>
Co-authored-by: Tommaso Stocchi <[email protected]>
Co-authored-by: Aaron Powell <[email protected]>
Co-authored-by: aaronburtle <[email protected]>
Co-authored-by: Aniruddh Munde <[email protected]>
Co-authored-by: Jerry Nixon <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Michael Staib <[email protected]>
Co-authored-by: souvikghosh04 <[email protected]>
Co-authored-by: Souvik Ghosh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[Bug]: Health / When inside a container, endpoints not found.

6 participants