Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gogatekeeper/gatekeeper

An OpenID / Proxy service
https://github.com/gogatekeeper/gatekeeper

authentication authorization oidc-proxy opa uma

Last synced: 3 months ago
JSON representation

An OpenID / Proxy service

Awesome Lists containing this project

README

        

![gogatekeeper](docs/static/logo/gate-readme.png)


This repository is a work in progress and contains the source code for the Gatekeeper. You should be able to see what's being planned at our [milestones page](https://github.com/gogatekeeper/gatekeeper/milestones).

## Help and Documentation

* [Gatekeeper documentation](https://gogatekeeper.github.io/gatekeeper)
* [Gatekeeper security issues](SECURITY.md)
* [Gatekeeper chat](https://discord.com/invite/zRqVXXTMCv)
* [Helm chart](https://github.com/gogatekeeper/helm-gogatekeeper)
* [Issue Tracker](https://github.com/gogatekeeper/gatekeeper/issues) - Issue tracker for bugs and feature requests

## Reporting an issue

If you believe you have discovered a defect in Gatekeeper please open an issue in our [Issue Tracker](https://github.com/gogatekeeper/gatekeeper/issues).
Please remember to provide a good summary, description as well as steps to reproduce the issue.

## Getting started

To run Gatekeeper, you can build it using this command:

```bash
docker buildx build --platform linux/amd64,linux/arm64 -t quay.io/gogatekeeper/gatekeeper:2.14.2 .
```

or you can use aleady existing Docker image by running:

```bash
docker run -it --rm quay.io/gogatekeeper/gatekeeper:2.14.2 \
--listen 127.0.0.1:8080 \
--upstream-url http://127.0.0.1:80 \
--discovery-url https://keycloak.example.com/realms/ \
--client-id
```

For more details refer to the [Documentation](https://gogatekeeper.github.io/gatekeeper).

### Verifying Download

Beside links to archives of binaries we provide also checksum file containing checksums
for archives. You can download file gatekeeper-checksum.txt, it contains sha512 checksums e.g.:

```
324b34ece86b6214f835ba9fd79e185864a9005f514458796c22c053de63f428235d2d2a04864065a49c090ad81d2daeb45546544fdd9531a8dea1a43145b8f0 gatekeeper_2.14.2_windows_amd64.zip
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_2.14.2_linux_amd64.tar.gz
f5322e41b3d78017191246bdd54f99e9b3dd8d5ff9d224e7e81b678a952c1d5aae125ea4c251928969b0a0ea0dc59724308c918993c8227f384f61896f58cbd0 gatekeeper_2.14.2_macOS_amd64.tar.gz
```

After you download archive of binary you can calculate it's checksum by using e.g. sha512sum Linux utility:

```
sha512sum /my/path/gatekeeper_2.14.2_linux_amd64.tar.gz
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_2.14.2_linux_amd64.tar.g
```

As you can see output of command is checksum, you can compare it with the one in gatekeeper-checksum.txt.

Additionally to verify gatekeeper-checksum.txt is valid we provide also signature of checksum file gatekeeper-checksum.txt.sig.

You can validate signature with these steps:

1. Download and save gpg public key:

```
cat > /tmp/gpg <
sub rsa4096 2021-02-22 [E]

```

3. Import gpg public key

```
cat /tmp/gpg | gpg --import
```

4. Verify signature

```
gpg --verify gatekeeper-checksum.txt.sig
```

## Contributing

Before contributing to Gatekeeper please read our [contributing guidelines](CONTRIBUTING.md).

## Other Keycloak Projects

* [Keycloak](https://github.com/keycloak/keycloak) - Keycloak Server and Java adapters
* [Keycloak Documentation](https://github.com/keycloak/keycloak-documentation) - Documentation for Keycloak
* [Keycloak QuickStarts](https://github.com/keycloak/keycloak-quickstarts) - QuickStarts for getting started with Keycloak

## License

* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)