Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

operator documentation missing: server encryption #3771

Open
sven-dmlr opened this issue Dec 30, 2024 · 0 comments
Open

operator documentation missing: server encryption #3771

sven-dmlr opened this issue Dec 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation encryption operation
Milestone

Comments

@sven-dmlr
Copy link
Member

sven-dmlr commented Dec 30, 2024

Situation

There is no documentation in https://mercedes-benz.github.io/sechub/latest/sechub-operations.html how to setup server encryption.

There are snippets in

...but nowhere is explained how to create an encryption key (which is needed for the environment variable for activating encryption)

Wanted

Append documentation to the sechub-operations document on how to set up SecHub server encryption.

It should contain for SecHub server as well as for PDS:

  • how to query the current encryption status
  • how to create an encryption key for each algorithm
    • create a random 16- (AES_GCM_SIV_128) or 32-character string (AES_GCM_SIV_256) <string> and
      echo -n "<string>" | base64
    • and a hint how to use the developer-admin-ui for creating keys
  • steps to prepare (which environment variables have to be set)
  • how to enable encryption (or renew the encryption key / key rotation)
  • how to verify that encryption is now working
@sven-dmlr sven-dmlr added documentation Improvements or additions to documentation operation encryption labels Dec 30, 2024
@sven-dmlr sven-dmlr added this to the Server 2.5.0 milestone Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation encryption operation
Projects
None yet
Development

No branches or pull requests

1 participant