-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Fix SSL certificate lookup for HTTPS URLs with custom ports #3665
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dicnunz
wants to merge
1
commit into
bluewave-labs:develop
Choose a base branch
from
dicnunz:fix-ssl-expiry-nonstandard-port-3646
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| import { describe, expect, it, jest } from "@jest/globals"; | ||
| import { fetchMonitorCertificate } from "../../../src/controllers/controllerUtils.ts"; | ||
| import type { Monitor } from "../../../src/types/index.ts"; | ||
| import type { SSLDetails } from "ssl-checker"; | ||
|
|
||
| const certificate: SSLDetails = { | ||
| daysRemaining: 30, | ||
| valid: true, | ||
| validFrom: "2026-01-01T00:00:00.000Z", | ||
| validTo: "2026-06-01T00:00:00.000Z", | ||
| validFor: ["checkmate.example.org"], | ||
| }; | ||
|
|
||
| const makeMonitor = (overrides?: Partial<Monitor>): Monitor => | ||
| ({ | ||
| id: "monitor-1", | ||
| teamId: "team-1", | ||
| url: "https://checkmate.example.org", | ||
| ignoreTlsErrors: false, | ||
| ...overrides, | ||
| }) as Monitor; | ||
|
|
||
| describe("controllerUtils", () => { | ||
| describe("fetchMonitorCertificate", () => { | ||
| it("checks the explicit HTTPS URL port when present", async () => { | ||
| const checker = jest.fn().mockResolvedValue(certificate); | ||
|
|
||
| await fetchMonitorCertificate(checker as any, makeMonitor({ url: "https://checkmate.example.org:54321/status" })); | ||
|
|
||
| expect(checker).toHaveBeenCalledWith("checkmate.example.org", { port: 54321 }); | ||
| }); | ||
|
|
||
| it("uses the monitor port when the URL does not include one", async () => { | ||
| const checker = jest.fn().mockResolvedValue(certificate); | ||
|
|
||
| await fetchMonitorCertificate(checker as any, makeMonitor({ url: "https://checkmate.example.org/status", port: 8443 })); | ||
|
|
||
| expect(checker).toHaveBeenCalledWith("checkmate.example.org", { port: 8443 }); | ||
| }); | ||
|
|
||
| it("keeps the previous default-port behavior when no port is configured", async () => { | ||
| const checker = jest.fn().mockResolvedValue(certificate); | ||
|
|
||
| await fetchMonitorCertificate(checker as any, makeMonitor()); | ||
|
|
||
| expect(checker).toHaveBeenCalledWith("checkmate.example.org", undefined); | ||
| }); | ||
|
|
||
| it("throws when no certificate expiry is returned", async () => { | ||
| const checker = jest.fn().mockResolvedValue({ ...certificate, validTo: undefined }); | ||
|
|
||
| await expect(fetchMonitorCertificate(checker as any, makeMonitor())).rejects.toThrow("Certificate not found"); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should probably be inverted, an explicit port set in the URL should probably take precedence over the
monitor.portfield.This is a design decision, but I think the visually prominent port in the monitor URL should take precedence over a field that is not readily visible in the monitor config 🤔
Consider the case where a user has set their url to be
https://www.myurl.com:52345/healthand accidentally set port 443 on the monitor config. We will silently be checking on 443 while the user would be left wondering why port 52345 as declared in their URL is not responding.Again a design decision, but I think probably the right call here.