[SPARK-49104][CORE][DOCS] Document JWSFilter usage in Spark UI and REST API and rename parameter to secretKey
#47596
Conversation
This file contains hidden or 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
…REST API and rename parameter to `secretKey`
dongjoon-hyun
commented
Aug 4, 2024
| <tr> | ||
| <td><code>spark.redaction.regex</code></td> | ||
| <td>(?i)secret|password|token|access[.]key</td> | ||
| <td>(?i)secret|password|token|access[.]?key</td> |
There was a problem hiding this comment.
Actually, this is missed at #47392 .
dongjoon-hyun
commented
Aug 4, 2024
| */ | ||
| override def init(config: FilterConfig): Unit = { | ||
| key = Keys.hmacShaKeyFor(Decoders.BASE64URL.decode(config.getInitParameter("key"))); | ||
| key = Keys.hmacShaKeyFor(Decoders.BASE64URL.decode(config.getInitParameter("secretKey"))); |
There was a problem hiding this comment.
Currently, key can be exposed if spark.ui.filters configuration is removed mistakenly.
There was a problem hiding this comment.
secretKey will be redact by Spark, right?
There was a problem hiding this comment.
As you make the change #47596 (comment), do we still need to change this param to secretKey?
|
Could you review this, @viirya ? |
|
Could you review this PR, @yaooqinn ? |
viirya
approved these changes
Aug 4, 2024
HyukjinKwon
approved these changes
Aug 4, 2024
|
Merged to master. |
|
Thank you, @viirya and @HyukjinKwon . To @viirya , yes. We need to rename
|
|
Late LGTM |
fusheng9399
pushed a commit
to fusheng9399/spark
that referenced
this pull request
Aug 6, 2024
…REST API and rename parameter to `secretKey`
### What changes were proposed in this pull request?
This PR aims the following.
- Document `JWSFilter` and its usage in `Spark UI` and `REST API`
- `Spark UI` section of `Configuration` page
- `Spark Security` page
- `Spark Standalone` page
- Rename the parameter `key` to `secretKey` to redact it in Spark Driver UI and Spark Master UI.
### Why are the changes needed?
To apply recent new security features
- apache#47575
- apache#47595
### Does this PR introduce _any_ user-facing change?
No because this is a new feature of Apache Spark 4.0.0.
### How was this patch tested?
Pass the CIs and manual review.
- `spark-standalone.html`
- `security.html`
- `configuration.html`
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes apache#47596 from dongjoon-hyun/SPARK-49104.
Authored-by: Dongjoon Hyun <dhyun@apple.com>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
szehon-ho
pushed a commit
to szehon-ho/spark
that referenced
this pull request
Aug 7, 2024
…REST API and rename parameter to `secretKey`
This PR aims the following.
- Document `JWSFilter` and its usage in `Spark UI` and `REST API`
- `Spark UI` section of `Configuration` page
- `Spark Security` page
- `Spark Standalone` page
- Rename the parameter `key` to `secretKey` to redact it in Spark Driver UI and Spark Master UI.
To apply recent new security features
- apache#47575
- apache#47595
No because this is a new feature of Apache Spark 4.0.0.
Pass the CIs and manual review.
- `spark-standalone.html`
- `security.html`
- `configuration.html`
No.
Closes apache#47596 from dongjoon-hyun/SPARK-49104.
Authored-by: Dongjoon Hyun <dhyun@apple.com>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
attilapiros
pushed a commit
to attilapiros/spark
that referenced
this pull request
Oct 4, 2024
…REST API and rename parameter to `secretKey`
### What changes were proposed in this pull request?
This PR aims the following.
- Document `JWSFilter` and its usage in `Spark UI` and `REST API`
- `Spark UI` section of `Configuration` page
- `Spark Security` page
- `Spark Standalone` page
- Rename the parameter `key` to `secretKey` to redact it in Spark Driver UI and Spark Master UI.
### Why are the changes needed?
To apply recent new security features
- apache#47575
- apache#47595
### Does this PR introduce _any_ user-facing change?
No because this is a new feature of Apache Spark 4.0.0.
### How was this patch tested?
Pass the CIs and manual review.
- `spark-standalone.html`
- `security.html`
- `configuration.html`
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes apache#47596 from dongjoon-hyun/SPARK-49104.
Authored-by: Dongjoon Hyun <dhyun@apple.com>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
himadripal
pushed a commit
to himadripal/spark
that referenced
this pull request
Oct 19, 2024
…REST API and rename parameter to `secretKey`
### What changes were proposed in this pull request?
This PR aims the following.
- Document `JWSFilter` and its usage in `Spark UI` and `REST API`
- `Spark UI` section of `Configuration` page
- `Spark Security` page
- `Spark Standalone` page
- Rename the parameter `key` to `secretKey` to redact it in Spark Driver UI and Spark Master UI.
### Why are the changes needed?
To apply recent new security features
- apache#47575
- apache#47595
### Does this PR introduce _any_ user-facing change?
No because this is a new feature of Apache Spark 4.0.0.
### How was this patch tested?
Pass the CIs and manual review.
- `spark-standalone.html`
- `security.html`
- `configuration.html`
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes apache#47596 from dongjoon-hyun/SPARK-49104.
Authored-by: Dongjoon Hyun <dhyun@apple.com>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
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.
What changes were proposed in this pull request?
This PR aims the following.
JWSFilterand its usage inSpark UIandREST APISpark UIsection ofConfigurationpageSpark SecuritypageSpark StandalonepagekeytosecretKeyto redact it in Spark Driver UI and Spark Master UI.Why are the changes needed?
To apply recent new security features
JWSFilter#47575spark.master.rest.filters#47595Does this PR introduce any user-facing change?
No because this is a new feature of Apache Spark 4.0.0.
How was this patch tested?
Pass the CIs and manual review.
spark-standalone.htmlsecurity.htmlconfiguration.htmlWas this patch authored or co-authored using generative AI tooling?
No.