Skip to content

Latest commit

 

History

History
166 lines (133 loc) · 7.99 KB

README.md

File metadata and controls

166 lines (133 loc) · 7.99 KB

Java CI

AuthBox - Oauth2 server and management panel

AuthBox is a free, open-source Oauth2 server implemented using Java. AuthBox consists of 2 applications: Oauth2 server auth-box-server and management portal auth-box-web. Management portal provides a UI and restful API for querying and management of Oauth2 server.

Table of Contents

  1. Demo
  2. Features
  3. Application configuration setup
  4. Oauth2 server auth-box-server configuration
  5. Management panel auth-box-web configuration
  6. Build and run
  7. Support & contribution
  8. License

Demo

Full deployment of AuthBox (Oauth2 server and web management panel) is running on

https://oauth2.cloud

  • Software: OpenJDK 17, Spring-Boot, MySql

Please create an account to see complete functionality. Registration process will create the following:

  • Oauth2 management panel Admin account.
  • Oauth2 client for service-to-service auth (client_credentials) which uses standard Oauth2 token.
  • Oauth2 client for user auth (password, authorization_code, refresh_token) which uses JWT (RSA 2048 bit private key signed) token.
  • One Oauth2 scope which is assigned to both clients.
  • Oauth2 user (username: test; password: test) to demo user authentication or/and authorization.

Features

AuthBox is RFC 6749 compliant Oauth2 server implementation. It features the following available grant types: password, client_credentials, authorization_code, and refresh_token. As part of authorization_code it provides ability to use Two Factor Authentication (2FA) using Google Authenticator or Authy

By default, Oauth2 server auth-box-server and management portal auth-box-web utilize MySql for data storage

auth-box-server and auth-box-web are docker/k8s ready and come with Dockerfile(s) and docker-compose scripts.

Application configuration setup

Oauth2 server auth-box-server and management portal auth-box-web use spring-boot internally and therefore can be configured using following methods:

Injecting custom properties using custom.properties file

# When running application from command line using Java executable
java -jar auth-box-server.jar --spring.config.location=/some/where/custom.properties
# or
java -Dspring.config.location=/some/where/custom.properties -jar auth-box-server.jar

Injecting individual custom properties, for example server.port=12345

# When running application from command line using Java executable
java -jar auth-box-server.jar --server.port=12345
# or
java -Dserver.port=12345 -jar auth-box-server.jar
# or using environment variables 
# (note: config property names should have "_" instead of ".", so "server.port" would be "SERVER_PORT")
export SERVER_PORT=12345
java -jar auth-box-server.jar

Oauth2 server auth-box-server configuration

Configuration property Description Default value
info.app.name Application name @project.name@
info.app.description Application description Auth box server
info.app.version Application version @project.version@
info.app.domain Application domain oauth2.cloud
info.app.protocol Application protocol https
info.app.accessQueueProcessingIdle Duration for processing queue when idle 5s
info.app.accessQueueProcessingPull Duration for processing queue when pulling 1s
info.app.allowTokenDetailsWithoutClientCredentials Allow token details endpoint call without client credentials provided true
server.port Server listening port 9999
spring.datasource.url Database JDBC url jdbc:mysql://${MYSQL_HOST:localhost}:3306/authbox?serverTimezone=UTC&useLegacyDatetimeCode=false
spring.datasource.username Database username root
spring.datasource.password Database password r00t
spring.flyway.enabled Flyway database migration flag true
spring.cache.type DAO cache type (possible values are: caffeine/none) none
spring.cache.cache-names Cache names to enable in csv list (possible values are OauthClient,OauthScope,OauthToken,OauthUser,Organization,User) N/A

Management panel auth-box-web configuration

Configuration property Description Default value
info.app.name Application name @project.name@
info.app.description Application description Auth box web
info.app.version Application version @project.version@
info.app.domain Application domain oauth2.cloud
info.app.registration-enabled Registration of new Organizations/Users enabled true
info.app.accessQueueProcessingIdle Duration for processing queue when idle 5s
info.app.accessQueueProcessingPull Duration for processing queue when pulling 1s
info.app.registrationEnabled Registration is enabled oauth2.cloud
info.app.allowTokenDetailsWithoutClientCredentials Allow token details endpoint call without client credentials provided true
server.port Server listening port 8888
spring.datasource.url Database JDBC url jdbc:mysql://${MYSQL_HOST:localhost}:3306/authbox?serverTimezone=UTC&useLegacyDatetimeCode=false
spring.datasource.username Database username root
spring.datasource.password Database password r00t
spring.flyway.enabled Flyway database migration flag true
spring.cache.type DAO cache type (possible values are: caffeine/none) none
spring.cache.cache-names Cache names to enable in csv list (possible values are OauthClient,OauthScope,OauthToken,OauthUser,Organization,User) N/A
ipstack.url IP details api url https://api.ipstack.com/{ip}?access_key=YOUR_API_KEY
ipstack.enabled IP details functionality enabled false

Build and run

# Run maven clean package
mvn clean package

Build auth-box-server docker container

docker build -f docker/auth-box-server.dockerfile -t auth-box-server .

Build auth-box-web docker container

docker build -f docker/auth-box-web.dockerfile -t auth-box-web .

Start all demo (mysql, auth-box-web, auth-box-server) on localhost:8888 (web UI portal) and localhost:9999 (oauth2 server)

docker-compose -f docker/demo-docker-compose.yml up
#   Once the docker services startes use the following:
#   Management Panel (auth-box-web): http://localhost:8888 
#   Management Panel API (auth-box-web api): http://localhost:8888/swagger-ui/index.html
#   Oauth2 Server API (auth-box-server api): http://localhost:9999/swagger-ui/index.html
#   Default management panel login: (user:admin, password: admin)

MySql container (i386)

docker run -p 3306:3306 --rm --name mysql -e MYSQL_ROOT_PASSWORD=r00t -e MYSQL_DATABASE=authbox -it mysql:latest

Support & contribution

To contribute to this project - please create a PR 😃

License

GNU General Public License v3

  • the freedom to use the software for any purpose,
  • the freedom to change the software to suit your needs,
  • the freedom to share the software with your friends and neighbors
  • the freedom to share the changes you make.