Gophish: GoPhish Health Check URL

[gophish-test-user]

Are there any dedicated health check URL and port for GoPhish?

[glennzw]

I'm not sure what you mean by health check, but no. The console output will give you insight into what's going on, and output any errors there.

[S0larflare]

I would guess he means like a heartbeat, to monitor that things are running without an error.

I’d say just monitor the process or port 3333 for the admin interface being available

Sent from my iPhone

On 21 Sep 2020, at 18:23, Glenn Wilkinson [e-mail] wrote:



Closed #1982https://github.com/gophish/gophish/issues/1982.

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHubhttps://github.com/gophish/gophish/issues/1982#event-3789774226, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ACEGR3MBW6DQ4LCPET44GJTSG6D2XANCNFSM4RURG5HQ.

[glennzw]

@S0larflare Ah good point.

@gophish-test-user Feel free to re-open if neither of these answers are what you're looking for.

[gophish-test-user]

@S0larflare - Yes, I need a dedicated path or port that I can use for a health check to monitor if it is running. In fact, I am trying to set up Gophing in a docker container behind an AWS load balancer. So, I need to know what will be the health check path and port. Tried to use path (/) and port 3333, but did not work. But it works if I set up the path to /images.favicon.ico

[jordan-wright]

I have plans to add one soon.

On Sep 22, 2020, at 5:49 AM, gophish-test-user [e-mail] wrote:


@S0larflare - Yes, I need a dedicated path or port that I can use for a health check to monitor if it is running. In fact, I am trying to set up Gophin in a docker container behind an AWS load balancer. So, I need to know what will be the health check path and port. Tried to use path (/) and port 3333, but did not work. But it works if I set up the path to /images.favicon.ico

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub, or unsubscribe.

[glennzw]

I have plans to add one soon.

I think it'd also be useful to return information about the state of gophish in this query. e.g: are any campaigns scheduled, or currently running, are any users logged in and active at the moment, maybe version information about gophish, memory usage.

[edermi]

I have plans to add one soon.

I think it'd also be useful to return information about the state of gophish in this query. e.g: are any campaigns scheduled, or currently running, are any users logged in and active at the moment, maybe version information about gophish, memory usage.

I like the idea, but only when the request is authenticated. Otherwise gophish leaks data to strangers on the Internet. For an unauthenticated request, I'd just return the HTTP status code indicating that everything is OK or not.

[alex4108]

@gophish-test-user You can configure your load balancer health check parameters to accept the 307 code returned when querying on / as a valid health check. By default ELBv2 target groups only accept codes 200-299 as a passing check. I'm not sure of classic load balancer default behavior.

C:\Users\alex4>curl --insecure https://127.0.0.1:3333 -I
HTTP/1.1 307 Temporary Redirect

[skyfox675]

@gophish-test-user You can configure your load balancer health check parameters to accept the 307 code returned when querying on / as a valid health check. By default ELBv2 target groups only accept codes 200-299 as a passing check. I'm not sure of classic load balancer default behavior.

C:\Users\alex4>curl --insecure https://127.0.0.1:3333 -I
HTTP/1.1 307 Temporary Redirect

Appears the ALBs (ELBv2) does now support a 307 HTTP return code as valid for passing of health checks. I am deploying ALBs via the AWS Load Balancer Controller for EKS:
alb.ingress.kubernetes.io/success-codes: 200,301,307

More info here:
https://kubernetes-sigs.github.io/aws-load-balancer-controller/guide/ingress/annotations/#health-check

[gebailey]

@gophish-test-user one other option would be to use /login as a health check endpoint; I'm using that with a AWS loadbalancer and it works OK (returns a 200).