oauth2proxy-sample-for-developper

A simple oauth2-proxy sample project using keycloak and python moc application

Run application

1. deploy oauth2-proxy

Get oauth2-proxy binary file from git repository or by building yourself. And put it in the oauth2proxy/src/ folder.

2. write hosts entry

Write the following entry in hosts file.

127.0.0.1 oauth2proxy.localhost.com
127.0.0.1 keycloak.localhost.com
127.0.0.1 pymocserver.localhost.com

3. start containers

Containers can be started, stopped or restarted using docker-compose command

To start containers

docker-compose up

To delete containers

docker-compose down

To restart a particular container

docker-compsoe restart oauth2proxy

4. sign in to moc server

Endpoints are described in endpoints.
Moc server can be signed in by accessing http://oauth2proxy.localhost.com:4180/oauth2/sign_in with using user1 to user6.

URL	Description
http://oauth2proxy.localhost.com:4180	Oauth2Proxy server
http://keycloak.localhost.com:8080	Keycloak console
http://pymocserver.localhost.com:8000	python moc server

Useres are created in the keycloak in advance.
admin user is used to sign in the keycloak console and others are python moc server.

Username	Password	Email	First Name	Last Name	User Enabled	Email Verified
admin	password	[email protected]	adminFirst	adminLast	true	true
user1	password	[email protected]	u1First	u1Last	true	true
user2	password	[email protected]	u2First	u2Last	true	true
user3	password	[email protected]	u3First	u3Last	true	true
user4	password	[email protected]	u4First	u4Last	false	true
user5	password	[email protected]	u5First	u5Last	true	false
user6	password	[email protected]	u6First	u6Last	false	false

oauth2-proxy configuration

In this sample application, oauth2proxy/oauth2-proxy.cfg is used for configureing the oauth2-proxy.

Client information

oauth2-proxy is configured in the keycloak with

• Realm : dev_oauth2proxy
• Client ID : oauth2proxy
• Client Secret : r4jwmwLU4GEsf53TnGkqJWfNtAdwWhqU
• well-known URL : http://keycloak.localhost.com:8080/auth/realms/dev_oauth2proxy/.well-known/openid-configuration

Build oauth2-proxy from source code

go build command

Build oauth2-proxy with go build command.

go build

Makefile

Building oauth2-proxy using a Makefile requires installation of gcc, make in addition to golang.
Here shows how to build oauth2-proxy using docker container.
Source codes should be in the oauth2proxy/src/ folder.

docker run -it --rm -v ${PWD}/oauth2proxy/src:/go/src golang:1.18.0 bash -c "cd /go/src && make build"

Export keycloak settings

Keycloak configurations can be exported with the following command.
Running the command overwrite existing configuration in keycloak/realm-config/.

docker exec -it keycloak /opt/jboss/keycloak/bin/standalone.sh -Djboss.socket.binding.port-offset=1000 -Dkeycloak.migration.action=export -Dkeycloak.migration.provider=dir -Dkeycloak.migration.dir=/opt/keycloak/realm-config

References

• https://github.com/oauth2-proxy/oauth2-proxy
• https://www.dumels.com/diagram/3c1550f5-3736-43da-824e-42a75a0194a3