feat(client): Add Google's Identity-Aware-Proxy in client config #600

Kloox · 2023-10-24T11:59:36Z

First of all, thank you for your time spent on Gatus. I really love it.
However, it is missing a feature that I really need so I suggest my pull request.
All details are below.
I would be very happy if my pull request could be merged so feel free to do any feedback if you feel that the pull request is not ready to merge for any reasons.

Checklist

Tested and/or added tests to validate that the changes work as intended, if applicable.
- I did not implement tests because it was necessary to mock the google response &| the credentials. However I'm open to add unit tests if you feel it is necessary.
Updated documentation in README.md, if applicable.
Describe the feature request:
This feature allow the users to generate a oauth2 client using the Google Identity-Aware-Proxy authentication (which does not follow client credentials authorization flow but use a custom flow using the Google Cloud Platform credentials) by specifying the audience in the endpoint config (see example).
Gatus will use the gcloud default credentials within its environment to generate the token.

Example:

endpoints:
  - name: with-custom-iap
    url: "https://my.iap.protected.app/health"
    client:
      identity-aware-proxy:
        audience: "XXXXXXXX-XXXXXXXXXXXX.apps.googleusercontent.com"
    conditions:
      - "[STATUS] == 200"

Why do you personally want this feature to be implemented?
I use gatus in production and I want to monitor my services hosted in Google Cloud Platform which are protected behind IAP.
Merge this feature will allow me to use the official gatus sources for my production docker image instead of forking this project and recompile my custom sources. Furthermore, maybe it will be helpful for others users that use Gatus in a GCP environment.
How long have you been using this project?
Professionally, few weeks. Personally, few months.

client/config.go

TwiN

Looks good, can you resolve the conflict? I'll be able to merge after.

Kloox · 2023-11-28T14:29:45Z

@TwiN

Hello,

I've updated the dependencies, fix the conflict and locally build/run/test gatus. Everything looks good to me.
If you're ready to merge it, so I am.

TwiN · 2023-11-29T03:50:19Z

@Kloox Thank you for your contribution!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | OpenSSF | |---|---|---|---| | [TwiN/gatus](https://togithub.com/TwiN/gatus) | minor | `v5.7.0` -> `v5.8.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/TwiN/gatus/badge)](https://securityscorecards.dev/viewer/?uri=github.com/TwiN/gatus) | --- ### Release Notes <details> <summary>TwiN/gatus (TwiN/gatus)</summary> ### [`v5.8.0`](https://togithub.com/TwiN/gatus/releases/tag/v5.8.0) [Compare Source](https://togithub.com/TwiN/gatus/compare/v5.7.0...v5.8.0) ##### What's Changed - feat(client): Add Google's Identity-Aware-Proxy in client config by [@Kloox](https://togithub.com/Kloox) in [TwiN/gatus#600 - feat(client): Add client network configuration for ICMP endpoint clients by [@n-thumann](https://togithub.com/n-thumann) in [TwiN/gatus#661 - feat(http): enhance HTTP client configuration with proxy support by [@appleboy](https://togithub.com/appleboy) in [TwiN/gatus#668 - feat: add ability to delay startup by [@vax-r](https://togithub.com/vax-r) in [TwiN/gatus#631 - feat: shields.io endpoint badge by [@buroa](https://togithub.com/buroa) in [TwiN/gatus#652 - fix(web): Allow configuration of read-buffer-size by [@TwiN](https://togithub.com/TwiN) in [TwiN/gatus#675 - fix: Allow binding IPv6 addresses for web by [@n-thumann](https://togithub.com/n-thumann) in [TwiN/gatus#650 - build: refine Makefile targets and build command by [@appleboy](https://togithub.com/appleboy) in [TwiN/gatus#666 - refactor(alerting): Use pointer for receiver in AlertProvider.GetDefaultAlert method by [@TwiN](https://togithub.com/TwiN) in [TwiN/gatus#676 - docs(alerting): Fix wrong gitlab terminology (alert key vs. PAT) by [@salim-b](https://togithub.com/salim-b) in [TwiN/gatus#694 - chore(deps): bump actions/setup-go from 4 to 5 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#634 - chore(deps): bump golang.org/x/crypto from 0.14.0 to 0.18.0 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#649 - chore(deps): bump modernc.org/sqlite from 1.26.0 to 1.28.0 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#654 - chore(deps): bump codecov/codecov-action from 3.1.4 to 3.1.6 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#669 - chore(deps): bump codecov/codecov-action from 3.1.6 to 4.0.1 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#671 - chore(deps): bump github.com/prometheus/client_golang from 1.17.0 to 1.18.0 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#658 - chore(deps): bump github.com/gofiber/fiber/v2 from 2.49.2 to 2.52.1 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#682 - chore(deps): bump github.com/TwiN/deepmerge from 0.2.0 to 0.2.1 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#684 - chore(deps): bump golang.org/x/oauth2 from 0.13.0 to 0.18.0 by [@dependabot](https://togithub.com/dependabot) in [TwiN/gatus#701 ##### New Contributors - [@Kloox](https://togithub.com/Kloox) made their first contribution in [TwiN/gatus#600 - [@n-thumann](https://togithub.com/n-thumann) made their first contribution in [TwiN/gatus#650 - [@buroa](https://togithub.com/buroa) made their first contribution in [TwiN/gatus#652 **Full Changelog**: TwiN/gatus@v5.7.0...v5.8.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/chezmoi-sh/nex.rpi).

Kloox added 4 commits October 24, 2023 13:25

client: config: add Google Identity-Aware-Proxy support

ada1aad

Add correct sum and mod

d909a35

Update README.md

715f778

Update README.md

816a359

TwiN requested changes Nov 1, 2023

View reviewed changes

client/config.go Outdated Show resolved Hide resolved

Kloox added 4 commits November 1, 2023 16:37

client: config: add Google Identity-Aware-Proxy support

544d8d2

Add correct sum and mod

557dd46

Update README.md

082bd9a

Update README.md

505f293

Kloox force-pushed the feat/add-client-iap-config branch 3 times, most recently from 605e8e1 to 505f293 Compare November 1, 2023 15:51

Kloox added 4 commits November 1, 2023 16:52

Merge master in

ae08ed2

Change IAP acronym to Identity-Aware-Proxy

74eda17

Change IAP acronym to Identity-Aware-Proxy in README.md

42d09fa

Fix conflict in go.mod

a3daf17

Kloox requested a review from TwiN November 1, 2023 16:14

Kloox force-pushed the feat/add-client-iap-config branch from a7f035c to a3daf17 Compare November 1, 2023 16:26

Kloox added 3 commits November 1, 2023 17:37

Merge remote-tracking branch 'gatus/master' into master-updated

50d128b

merge readme from twin/master

0d1d4d0

Fix typo error in readme.md

b0c87fc

TwiN reviewed Nov 24, 2023

View reviewed changes

client/config.go Outdated Show resolved Hide resolved

Update client/config.go

f6d39e9

TwiN requested changes Nov 24, 2023

View reviewed changes

TwiN added the feature New feature or request label Nov 24, 2023

TwiN changed the title ~~Feature: Add Google Identity-Aware-Proxy in client endpoint config~~ feat(client): Add Google's Identity-Aware-Proxy in client endpoint config Nov 24, 2023

TwiN changed the title ~~feat(client): Add Google's Identity-Aware-Proxy in client endpoint config~~ feat(client): Add Google's Identity-Aware-Proxy in client config Nov 24, 2023

TwiN changed the title ~~feat(client): Add Google's Identity-Aware-Proxy in client config~~ feat(client): Add Google's Identity-Aware-Proxy in config Nov 24, 2023

TwiN changed the title ~~feat(client): Add Google's Identity-Aware-Proxy in config~~ feat(client): Add Google's Identity-Aware-Proxy in client config Nov 24, 2023

update dependencies

c51d895

Merge branch 'master' into feat/add-client-iap-config

50ff440

TwiN merged commit 3c246f0 into TwiN:master Nov 29, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(client): Add Google's Identity-Aware-Proxy in client config #600

feat(client): Add Google's Identity-Aware-Proxy in client config #600

Kloox commented Oct 24, 2023 •

edited

Loading

TwiN left a comment

Kloox commented Nov 28, 2023

TwiN commented Nov 29, 2023

feat(client): Add Google's Identity-Aware-Proxy in client config #600

feat(client): Add Google's Identity-Aware-Proxy in client config #600

Conversation

Kloox commented Oct 24, 2023 • edited Loading

Checklist

TwiN left a comment

Choose a reason for hiding this comment

Kloox commented Nov 28, 2023

TwiN commented Nov 29, 2023

Kloox commented Oct 24, 2023 •

edited

Loading