Add support for TLS servers #1210

ok-john · 2023-02-05T06:10:57Z

This PR adds support for TLS servers by adding additional command line arguments for domain, cert and key which represent the url, path to certificate and key files respectively.

This PR also adds a build option make static which generates all the static assets required to compile the project. This needs to be run before first build and the only location this info exists is in your documentation under contributing.

I tested this on my own servers and it works.

sundowndev

Thanks for your PR 👍🏻

I left few comments about the default paths and CLI options. Also could you add a few lines in the docs just to let the users know we support TLS ? See this file.

sundowndev · 2023-02-05T09:06:16Z

cmd/serve.go

+func fmtLetsEncrypt(sitename string) (string, string) {
+	return fmt.Sprintf("/etc/letsencrypt/live/%s/fullchain.pem", sitename),
+		fmt.Sprintf("/etc/letsencrypt/live/%s/privkey.pem", sitename)
+}
+


This function is not windows-compatible. Anyway I think it's not worth to guess the cert and key paths, if the user doesn't specify it, just don't use TLS.

sundowndev · 2023-02-05T09:42:11Z

cmd/serve.go

+			if len(opts.Domain) != 0 {
+				if len(opts.CertfilePath) == 0 || len(opts.KeyfilePath) == 0 {
+					opts.CertfilePath, opts.KeyfilePath = fmtLetsEncrypt(opts.Domain)
+				}
+				if err := srv.ListenAndServeTLS(opts.Domain+":443", opts.CertfilePath, opts.KeyfilePath); err != nil && err != http.ErrServerClosed {
+					log.Fatalf("listen: %s\n", err)
+				}
+			}
+


I just noticed we don't have a addr flag to listen to a different address. I think it's worth adding a new --addr flag and use it for both TLS and non-TLS.

--addr should be empty by default and we should use TLS when --cert or --key is not empty

We can use Port option to listen to port 443, instead of hard-coding it

In the Gin's server implementation, it's the same option for both methods.

ok-john · 2023-02-05T18:45:14Z

Hey @sundowndev,

Thanks for the comments - at the moment my availability is a bit limited.

Next time I'm free I'll look at getting to those comments, if you or someone else would like to address those changes and push to this PR that's cool too.

Thanks.

… verify step.

…ptional arguments, a path to manual download if the automatic checks fail, and fallbacks to curl if wget is not installed.

…f =~ to match as a regex rather than literally.

1. SC2155 (warning): Declare and assign separately to avoid masking return values. 2. SC2061 (warning): Quote the parameter to -name so the shell won't interpret it.

Bumps [actions/setup-go](https://github.com/actions/setup-go) from 3.2.0 to 3.5.0. - [Release notes](https://github.com/actions/setup-go/releases) - [Commits](actions/setup-go@v3.2.0...v3.5.0) --- updated-dependencies: - dependency-name: actions/setup-go dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [goreleaser/goreleaser-action](https://github.com/goreleaser/goreleaser-action) from 4.1.1 to 4.2.0. - [Release notes](https://github.com/goreleaser/goreleaser-action/releases) - [Commits](goreleaser/goreleaser-action@v4.1.1...v4.2.0) --- updated-dependencies: - dependency-name: goreleaser/goreleaser-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [docker/login-action](https://github.com/docker/login-action) from 1.14.1 to 2.1.0. - [Release notes](https://github.com/docker/login-action/releases) - [Commits](docker/login-action@v1.14.1...v2.1.0) --- updated-dependencies: - dependency-name: docker/login-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4.3.1 to 4.5.0. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](actions/setup-python@v4.3.1...v4.5.0) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 3.0.0 to 3.3.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3.0.0...v3.3.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Move golangci-lint install command into install-tools task

Bumps [actions/checkout](https://github.com/actions/checkout) from 3.3.0 to 3.4.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3.3.0...v3.4.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 3.4.0 to 3.5.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3.4.0...v3.5.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/setup-go](https://github.com/actions/setup-go) from 3.5.0 to 4.0.0. - [Release notes](https://github.com/actions/setup-go/releases) - [Commits](actions/setup-go@v3.5.0...v4.0.0) --- updated-dependencies: - dependency-name: actions/setup-go dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 3.5.0 to 3.5.2. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3.5.0...v3.5.2) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4.5.0 to 4.6.0. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](actions/setup-python@v4.5.0...v4.6.0) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

sundowndev · 2024-02-16T08:41:13Z

It's been a year, any news on this @ok-john ?

ok-john · 2024-05-22T11:12:50Z

It's been a year, any news on this @ok-john ?

I could work on this now i have time - is this still a requested feature?

sundowndev · 2024-05-23T08:01:32Z

@ok-john At this time it's not requested. If you'd like to request it, please create an issue first then create a PR. If you don't need this feature, then I think we can close this PR.

Add support for TLS servers

62a3bd8

ok-john requested a review from sundowndev as a code owner February 5, 2023 06:10

sundowndev requested changes Feb 5, 2023

View reviewed changes

richwrightnyc and others added 26 commits May 6, 2023 18:53

Fixed an issue with the install script failing on mac on the checksum…

97cc7c4

… verify step.

Fixed no newline at end of file

4d6a635

refactor installer script to make it more robust and flexible. Adds o…

827e2c1

…ptional arguments, a path to manual download if the automatic checks fail, and fallbacks to curl if wget is not installed.

fixed some typos

0e7ddd8

squashed some bugs, further testing needed

6f66cb4

fixed a few typos, should be ready for review

2f64f4f

removed one additional debug item. ready for review

5cd121d

fix shellcheck SC2076 (warning): Remove quotes from right-hand side o…

303055b

…f =~ to match as a regex rather than literally.

fixed 2 shellcheck issues:

4f3b888

1. SC2155 (warning): Declare and assign separately to avoid masking return values. 2. SC2061 (warning): Quote the parameter to -name so the shell won't interpret it.

docs: install instructions

1d35c51

docs: readme

719bc31

ci: create homebrew workflow

f6fcd89

chore: update makefile

ae667a8

Move golangci-lint install command into install-tools task

docs: add homebrew installation

7e303f6

docs: contribute

bc1e54a

docs: contribute

6d55658

ci: homebrew workflow

d32c5e0

dependabot bot and others added 3 commits May 6, 2023 18:53

fix: colored text on windows

8969e7b

fix: server logs output

a672534

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for TLS servers #1210

Add support for TLS servers #1210

ok-john commented Feb 5, 2023

sundowndev left a comment

sundowndev Feb 5, 2023 •

edited

sundowndev Feb 5, 2023 •

edited

ok-john commented Feb 5, 2023

sundowndev commented Feb 16, 2024

ok-john commented May 22, 2024

sundowndev commented May 23, 2024

Add support for TLS servers #1210

Are you sure you want to change the base?

Add support for TLS servers #1210

Conversation

ok-john commented Feb 5, 2023

sundowndev left a comment

Choose a reason for hiding this comment

sundowndev Feb 5, 2023 • edited

Choose a reason for hiding this comment

sundowndev Feb 5, 2023 • edited

Choose a reason for hiding this comment

ok-john commented Feb 5, 2023

sundowndev commented Feb 16, 2024

ok-john commented May 22, 2024

sundowndev commented May 23, 2024

sundowndev Feb 5, 2023 •

edited

sundowndev Feb 5, 2023 •

edited