[EDGORDERS-83-ENV]. Refactor for TLS configuration for Spring-based Environment #105
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SerhiiNosko
reviewed
May 24, 2024
SerhiiNosko
reviewed
May 24, 2024
SerhiiNosko
reviewed
May 24, 2024
SerhiiNosko
reviewed
May 24, 2024
SerhiiNosko
reviewed
May 24, 2024
azizbekxm
reviewed
May 24, 2024
SerhiiNosko
reviewed
May 24, 2024
src/main/java/org/folio/edge/core/utils/SslConfigurationUtil.java
Outdated
Show resolved
Hide resolved
SerhiiNosko
reviewed
May 24, 2024
src/main/java/org/folio/edge/core/utils/SslConfigurationUtil.java
Outdated
Show resolved
Hide resolved
SerhiiNosko
approved these changes
May 24, 2024
azizbekxm
approved these changes
May 24, 2024
README.md
Outdated
Comment on lines
175
to
179
| | `SPRING_SSL_BUNDLE_JKS_WEB-SERVER_KEYSTORE_TYPE` | `NA` | (Required). Set the type of the keystore. Common types include `JKS`, `PKCS12`, and `BCFKS` | | ||
| | `SPRING_SSL_BUNDLE_JKS_WEB-SERVER_KEYSTORE_LOCATION` | `NA` | (Required). Set the location of the keystore file in the local file system | | ||
| | `SPRING_SSL_BUNDLE_JKS_WEB-SERVER_KEYSTORE_PASSWORD` | `NA` | (Required). Set the password for the keystore | | ||
| | `SPRING_SSL_BUNDLE_JKS_WEB-SERVER_KEY_ALIAS` | `NA` | Set the alias of the key within the keystore. | | ||
| | `SPRING_SSL_BUNDLE_JKS_WEB-SERVER_KEY_PASSWORD` | `NA` | Optional param that points to a password of `KEY_ALIAS` if it protected | |
There was a problem hiding this comment.
Remove any dashes (WEB-SERVER -> WEBSERVER):
https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables
Comment on lines
29
to
33
| public static final String SPRING_SSL_BUNDLE_JKS_WEB_SERVER_KEYSTORE_TYPE = "SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEYSTORE_TYPE"; | ||
| public static final String SPRING_SSL_BUNDLE_JKS_WEB_SERVER_KEYSTORE_LOCATION = "SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEYSTORE_LOCATION"; | ||
| public static final String SPRING_SSL_BUNDLE_JKS_WEB_SERVER_KEYSTORE_PASSWORD = "SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEYSTORE_PASSWORD"; | ||
| public static final String SPRING_SSL_BUNDLE_JKS_WEB_SERVER_KEY_ALIAS = "SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEY_ALIAS"; | ||
| public static final String SPRING_SSL_BUNDLE_JKS_WEB_SERVER_KEY_PASSWORD = "SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEY_PASSWORD"; |
There was a problem hiding this comment.
The variable name should also be renamed: WEB_SERVER -> WEBSERVER
There was a problem hiding this comment.
Should I do the same for the FOLIO_CLIENT_TLS_* variables?
Comment on lines
37
to
39
| public static final String FOLIO_CLIENT_TLS_TRUST_STORE_TYPE = "FOLIO_CLIENT_TLS_TRUSTSTORETYPE"; | ||
| public static final String FOLIO_CLIENT_TLS_TRUST_STORE_PATH = "FOLIO_CLIENT_TLS_TRUSTSTOREPATH"; | ||
| public static final String FOLIO_CLIENT_TLS_TRUST_STORE_PASSWORD = "FOLIO_CLIENT_TLS_TRUSTSTOREPASSWORD"; |
There was a problem hiding this comment.
Renaming the variable name gives a better indication of the content:
TRUST_STORE_TYPE -> TRUSTSTORETYPE
TRUST_STORE_PATH -> TRUSTSTOREPATH
TRUST_STORE_PASSWORD -> TRUSTSTOREPASSWORD
There was a problem hiding this comment.
Acknowledged
README.md
Outdated
| @@ -165,34 +165,31 @@ Configuration information is specified in two forms: | |||
| | `request_timeout_ms` | `30000` | Request Timeout | | |||
| | `api_key_sources` | `PARAM,HEADER,PATH` | Defines the sources (order of precendence) of the API key. | | |||
|
|
|||
| ### System Properties for TLS configuration for Http server | |||
| ### Env variables for TLS configuration for Http server | |||
|
|
|||
| To configure Transport Layer Security (TLS) for the HTTP server in an edge module, the following configuration parameters should be used. | |||
| Parameters marked as Required are required only in case when ssl_enabled is set to true. | |||
There was a problem hiding this comment.
ssl_enabled has been replaced with checking whether SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEYSTORE_TYPE is defined.
Co-authored-by: julianladisch <[email protected]>
|
This was referenced May 24, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use Spring ENV vars