.NETCore Kestrel HTTPs 502 Bad Gateway nginx with port forwarding

[warrenbuckley]

Summary

Unable to browse to a dotnet new WebApp template on HTTPs 5001 port. A 502 Bad Gateway error is shown from nginx

Terminal Output

@warrenbuckley ➜ /workspaces/CodeSpace-NetCore-HTTPS/testing (main ✗) $ dotnet run
Building...
warn: Microsoft.AspNetCore.DataProtection.Repositories.FileSystemXmlRepository[60]
      Storing keys in a directory '/root/.aspnet/DataProtection-Keys' that may not be persisted outside of the container. Protected data will be unavailable when container is destroyed.
warn: Microsoft.AspNetCore.Server.Kestrel[0]
      Unable to bind to https://localhost:5001 on the IPv6 loopback interface: 'Cannot assign requested address'.
warn: Microsoft.AspNetCore.Server.Kestrel[0]
      Unable to bind to http://localhost:5000 on the IPv6 loopback interface: 'Cannot assign requested address'.
info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:5001
info: Microsoft.Hosting.Lifetime[0]
      Now listening on: http://localhost:5000
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: /workspaces/CodeSpace-NetCore-HTTPS/testing

Steps to Reproduce:

1. Create a new blank repository with readme
2. Open new repo in Github Codespaces
3. Add DevContainer configuration for .NET C# with MSSQL
4. Add Github CLI & Azure CLI as optional extras
5. From terminal dotnet new webapp --name Testing
6. cd Testing and then dotnet restore
7. dotnet build and dotnet run
8. See error/warning about missing local HTTPS certificates

Microsoft.AspNetCore.Server.Kestrel[0]
      Unable to start Kestrel.
      System.InvalidOperationException: Unable to configure HTTPS endpoint. No server certificate was specified, and the default developer certificate could not be found or is out of date.
      To generate a developer certificate run 'dotnet dev-certs https'. To trust the certificate (Windows and macOS only) run 'dotnet dev-certs https --trust'.

9. Run dotnet dev-certs https --trust
10. Rerun dotnet-run
11. Wait for notification prompt about Auto Port Forwarding for 5000 and 5001
12. Try to browse to the HTTPS url which uses port 5001
13. 502 Bad Gateway error from nginx (see screenshot)

[Chuxel]

I mentioned this in another location you logged this, but try this using VS Code client instead of the web. I don't believe that web port forwarding would support a custom SSL certificate (unless @derekbekoe or @lostintangent correct me). When using VS Code client, on your local machine this would be mapped to localhost as a straight TCP port and would then work.

You would also have to configure your local browser with the SSL certificate since dotnet new generates a custom one. Generally a better approach is to create one locally and copy it into a Codespace instead (e.g. as described at https://github.com/microsoft/vscode-dev-containers/tree/main/containers/dotnet#enabling-https-in-aspnet)

EDIT: While forwarding a custom cert is not supported, the web URI should switch from the custom cert to a codespaces one if the port is set in https mode. There is a bug with this right now.

[warrenbuckley]

Hi @Chuxel /cc @lostintangent & @derekbekoe
Thanks for this info. I have done as you suggested and used VSCode locally on my machine connected to the GitHub Codespace and this works locally.

Potential bug ?

With the exception that the 5001 port in the ports pane from Codespaces in VSCode is mapped to http and not https.

In the Ports panel from Codespaces VSCode extension that lists out the ports, the privacy and process etc, I have then tried to set the port 5001 to use HTTPS Port Protocol, but instead this seems to use the 5001.githubpreview.dev domain and then this does not work if you try to browse to the site from this approach.

Browsing to it directly with CTRL + Click from the terminal from the output of dotnet run command works with no issues as long as you have not changed the Port protocol from the ports pane.

Questions

With me doing the steps for the development SSL certificate from my machine into the Codespace. If any colleagues, team mates or anyone else who would fork or work on this repo. Would the certificate work for them without issues or does each new person working on the repository need to repeat these steps?

I am planning on creating a GitHub Repository template, with the goal for someone to have a specific .NETCore project ready for them to go and work with direct in GitHub Codespaces. How could I automate the SSL certificate export so its one less step for people to worry about to get up and running.

Are there any plans to support the githubpreview.dev for HTTPS as it would make a nicer experience to allow developing direct in the browser. Additionally with port forwarding for HTTPS not working I am then unable to use the Port Privacy feature to make it public to get peer feedback of a .NETCore site running.

Do you know if anyone in the .NETCore team has tried to use some of the dotnet new web templates in Codespaces?
As I assume they might have run into similar teething issues that I seem to be having.

Look forward to making Codespaces a super great place to build and work with .NETCore WebApp development

[warrenbuckley]

Ok so if I understand correctly then this is a bug and HTTPS will work with CodeSpaces web port forwarding url?

Is there any issue to follow along to get updates or insights so I know when to try this out again?

[Chuxel]

Correct - This is the right spot to watch!

[warrenbuckley]

@Chuxel any updates or feedback on this from you and the relevant teams ?

[Chuxel]

This should be resolved! Change the protocol for port that is forwarded HTTPS and it will translate. Either right click and update the port in the ports view in VS Code, or use the portsAttributes property in devcontainer.json.

"portsAttributes": {
    "7062": {
        "protocol": "https"
    }
}

Note that your app may also do redirects that hard code localhost, so if hitting the http port (rather than the https port) is resulting in an error, that's likely what is going on. Forwarded ports follow the form ${CODESPACE_NAME}-<port>.githubpreview.dev (where CODESPACE_NAME is an environment variable in the codespace) on port 443 and will be used in https mode from local VS Code client as well.

[micya]

Came across this today. Go to "Ports" tab, right click on port, select "Change port protocol", and select "HTTPS".

[joshjohanning]

We were able to get ours to load after

1. manually flipping port 5001 to https - it was set to http
2. waiting like a minute

Then it came up

[Scryptium-DamonB]

Thank you for mentioning waiting like a minute! Mine was setup with a different port. Changed the port protocol from http to https, and this was key: waited (5 minutes while I answered the front door), tried and it worked! I had flipped the port protocol earlier, but didn't wait for a bit before trying again. Good to know for anyone new to this way of developing software.

[skavor]

Delete this line if you are using .net core 6. it has worked for me

[joshjohanning]

This is what I ended up doing! Rely on server-side HTTPS redirection (like in azure app settings) instead of putting in the app.

[AgileMindExec]

I was working on this project on Codespaces and got the same error: https://github.com/LinkedInLearning/hands-on-aspnet-razor-pages-3084715

Commenting this line number 16 helped solve the issue.

[rajbos]

Thanks for adding that @AgileMindExec! It will be helpful for the next person!

I would suspect then that you also can check the forwarded ports setting in the devContainer.json file. Maybe that is not configured for https then?

[AgileMindExec]

That's weird because it was set to https! I tried switching both before commenting it out and neither of those settings worked.