Skip to end of metadata
Go to start of metadata


All clients share the same username and password. Given these credentials client1 can see configuration for client2. This affects /client/registration and /client/{clientId}/sync.
This becomes a problem if clients are preregistered and simple/natural clientIds are used. An attacker with access to the shared username/password can then guess the clientId and get access to another party's ApplicationConfig.

Roles and access control

Path Access Comment
/health Anonymous  
/client/registration Shared client registration/sign-up credentials ConfigService Client API, login.user/login.password
/client/{clientId}/sync client credentials ConfigService Client API, clientId/clientSecret
All other paths admin ConfigService Admin API, login.admin.user/login.admin.password

TODO: CS Dashboard should be possible to set up CS Dashboard with a user which cannot change any data OR a user with rw privileges to enable admin features from CS dashboard.

How does it work

  1. When a new Client is created, a clientSecret string is set using UUID.randomUUID().
    1. /client//registration, the clientSecret is returned to the client and persisted using ConfigServiceClient.saveApplicationState. The clientSecret is afterwards included whenever the client checkForUpdate (client/{clientId}/sync).
    2. PUT /client/{clientId}
  2. The clientSecret is validated when a client calls client/{clientId}/sync. This validation is off by default, but can be enabled with the property client.secret.validation.enabled.

Implementation notes

  1. Backward compatible: It should be possible to continue to support the existing behavior. I.e.,
    1. Read login.admin.user and login.admin.password from and create or update these credentials in the database. All permissions for all paths.
    2. Read login.user and login.password from and create or update these credentials in the database. Access to /client.
  2. Extend Preregister Client with specific ApplicationConfig to also create a user with username=clientId and generate a password if password is omitted?
  1. Write clientSecret
    1. ClientResource.registerClient (ClientService.registerClient)
    2. ClientAdminResource.putClient
  2. Read
    1. ClientResource.sync
  3. Perstence client side
    1. clientSecret is returned from ClientResource.registerClient (in ClientConfig) and persisted by ClientService.saveApplicationState
  4. Client secret validation check is feature-toggled using property client.secret.validation.enabled


Note! Current implementation does not use Spring Security or SQL db.

  • clientPassword must be set on the client side and provided with every request to /client/{clientId}/sync. Password should be stored on each Client.


Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.