Skip to content

Latest commit

 

History

History
105 lines (84 loc) · 4.3 KB

readme.md

File metadata and controls

105 lines (84 loc) · 4.3 KB
Raw

Spring Cloud Config Server with JWT security

A docker image of Spring Cloud Config Server with JWT security.

Based on the hyness/spring-cloud-config-server docker image.

The JWT support is as follows:

  • Update the application.yml to have a jwt.secret=the-signing-key with the JWT signing key or use environment variable JWT_SECRET=the-signing-key. You can have a comma-separated list of secrets to enable secret rotation.

  • The JWT must have a scope property with an array of ant path patterns of allowed urls:

    {
  "sub": "app1",
  "scope": ["/app1/dev/**", "/app1/qa/**"]
}

    This is flexible enough to allow one app to have access to multiple configurations and to have different tokens per profile (dev vs prod)

  • The signing key algorithm is HS512. The default secret is SomeSecretForJWTGeneration. Make sure to change it!

  • Sample request

    curl --header "Authorization: Bearer <JWT>" http://localhost/foo/development

  • You can use a website like https://jwt.io/ to generate tokens.

It's highly recommended that you configure the image to accept HTTPS traffic. You can configure it like any Spring Boot application, if you are not familiar, this is a good guide on how to enable it.

Usage

docker run -it --name=spring-cloud-config-server \
      -p 80:80 \
      -v </path/to/config>:/config \
      epignosisx/spring-cloud-config-server-jwt

Parameters

  • -p 80 Server port
  • -v /config Mounted configuration

Configuring Spring Cloud Config Server

Spring Cloud Config Server is a normal Spring Boot application, it can be configured through all the ways a Spring Boot application can be configured. You may use environment variables or you can mount configuration in the provided volume. The configuration file must be named application and may be a properties or yaml file. See the Spring Boot documentation for further information on how to use and configure Spring Boot.

Configuration examples

# Using a mounted config Directory
docker run -it -p 80:80 \
      -v /path/to/config/dir:/config \
      epignosisx/spring-cloud-config-server-jwt

# Using a mounted application.yml
docker run -it -p 80:80 \
      -v /path/to/application.yml:/config/application.yml \
      epignosisx/spring-cloud-config-server-jwt

# Configure through environment variables without a configuration file
docker run -it -p 80:80 \
      -e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/spring-cloud-samples/config-repo \
      -e JWT_SECRET=your-signing-key \
      epignosisx/spring-cloud-config-server-jwt

# Configure through command line arguments without a configuration file
docker run -it -p 80:80 \
      epignosisx/spring-cloud-config-server-jwt \
      --spring.cloud.config.server.git.uri=https://github.com/spring-cloud-samples/config-repo \
      --jwt.secret=your-signing-key

Verify Samples Above

$ curl --header "Authorization Bearer <Enter JWT>" http://localhost/foo/development

Required Backend Configuration

Spring Cloud Config Server requires that you configure a backend to serve your configuration files. There are currently 3 backends to choose from...

Git

# Github example
docker run -it -p 80:80 \
      -e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/spring-cloud-samples/config-repo \
      epignosisx/spring-cloud-config-server-jwt

# Local git repo example
docker run -it -p 80:80 \
      -v /path/to/config/files/dir:/config \
      -e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=file:/config/my-local-git-repo \
      epignosisx/spring-cloud-config-server-jwt

Filesystem

docker run -it -p 80:80 \
      -v /path/to/config/files/dir:/config \
      -e SPRING_PROFILES_ACTIVE=native \
      epignosisx/spring-cloud-config-server-jwt

Vault

docker run -it -p 80:80 \
      -e SPRING_PROFILES_ACTIVE=vault \
      epignosisx/spring-cloud-config-server-jwt