You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "clairemcginty (via GitHub)" <gi...@apache.org> on 2025/11/13 15:09:20 UTC
[PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
clairemcginty opened a new pull request, #36809:
URL: https://github.com/apache/beam/pull/36809
See: https://github.com/apache/avro/pull/3376/files
In Avro 1.11.4+, schemas that utilize the `java-class` annotation throw runtime decoding errors.
For example, applying a specific AvroCoder to a record with the following schema:
```
{
"type": "record",
"name": "TestJavaClassProp",
"namespace": "com.test",
"fields": [
{
"name": "bd",
"type": {
"type": "string",
"java-class": "java.math.BigDecimal"
}
}
]
}
```
throws:
```
Caused by: java.lang.SecurityException: Forbidden java.math.BigDecimal! This class is not trusted to be included in Avro schemas using java-class. Please set the system property org.apache.avro.SERIALIZABLE_CLASSES to the comma separated list of classes you trust. You can also set the system property org.apache.avro.SERIALIZABLE_PACKAGES to the comma separated list of the packages you trust.
at org.apache.avro.specific.SpecificDatumReader.checkSecurity(SpecificDatumReader.java:188)
at org.apache.avro.specific.SpecificDatumReader.getPropAsClass(SpecificDatumReader.java:159)
at org.apache.avro.specific.SpecificDatumReader.findStringClass(SpecificDatumReader.java:143)
at com.spotify.scio.avro.SpecificRecordDatumFactory$ScioSpecificDatumReader.findStringClass(AvroDatumFactory.scala:80)
at org.apache.avro.generic.GenericDatumReader$ReaderCache.lambda$getStringClass$1(GenericDatumReader.java:567)
at java.base/java.util.concurrent.ConcurrentHashMap.computeIfAbsent(ConcurrentHashMap.java:1708)
at org.apache.avro.generic.GenericDatumReader$ReaderCache.getStringClass(GenericDatumReader.java:567)
at org.apache.avro.generic.GenericDatumReader.readString(GenericDatumReader.java:455)
at org.apache.avro.generic.GenericDatumReader.readWithoutConversion(GenericDatumReader.java:192)
at org.apache.avro.specific.SpecificDatumReader.readField(SpecificDatumReader.java:232)
at org.apache.avro.generic.GenericDatumReader.readRecord(GenericDatumReader.java:248)
at org.apache.avro.specific.SpecificDatumReader.readRecord(SpecificDatumReader.java:219)
at org.apache.avro.generic.GenericDatumReader.readWithoutConversion(GenericDatumReader.java:180)
at org.apache.avro.generic.GenericDatumReader.read(GenericDatumReader.java:161)
at org.apache.avro.generic.GenericDatumReader.read(GenericDatumReader.java:154)
at org.apache.beam.sdk.extensions.avro.coders.AvroCoder.decode(AvroCoder.java:476)
```
The fix, per https://github.com/apache/avro/pull/3376/files, is to set the sys prop `org.apache.avro.SERIALIZABLE_CLASSES`. We can do that easily with DirectRunner, but there's no way to set it on Dataflow unless we create a custom worker image
This PR adds a proposed worker harness option allowing the user to specify trusted classes.
An alternative would be to simply set a reasonable default; for example in the Avro project itself they set the [following default value](https://github.com/apache/avro/blob/release-1.11.5/lang/java/avro/pom.xml#L75-L77):
```xml
<systemProperties>
<org.apache.avro.SERIALIZABLE_CLASSES>java.math.BigDecimal,java.math.BigInteger,java.net.URI,java.net.URL,java.io.File,java.lang.Integer,org.apache.avro.reflect.TestReflect$R10</org.apache.avro.SERIALIZABLE_CLASSES>
</systemProperties>
```
this would also solve my use case :)
Let me know what you all think. If this looks good I can polish the javadoc/add tests/etc.
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on code in PR #36809:
URL: https://github.com/apache/beam/pull/36809#discussion_r2534584238
##########
sdks/java/container/boot.go:
##########
@@ -276,6 +276,14 @@ func main() {
args = append(args, "--add-modules="+module.GetStringValue())
}
}
+ // Add trusted Avro serializable classes
+ if serializableClasses, ok := pipelineOptions.GetStructValue().GetFields()["avroSerializableClasses"]; ok {
Review Comment:
Yeah, for classes already caused regressions ("java.math.BigDecimal", and if there are others) we can add it here for users
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "clairemcginty (via GitHub)" <gi...@apache.org>.
clairemcginty commented on code in PR #36809:
URL: https://github.com/apache/beam/pull/36809#discussion_r2535583845
##########
runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.java:
##########
@@ -266,4 +267,30 @@ public String create(PipelineOptions options) {
List<String> getJdkAddOpenModules();
void setJdkAddOpenModules(List<String> options);
+
+ class AvroSerializableClassesFactory implements DefaultValueFactory<List<String>> {
Review Comment:
I guess the downside of that implementation is that if the user explicitly sets `avroSerializableClasses` to an empty list (e.g. maybe they have a security concern and want to disallow all java classes), it would be overridden to the default args. I pushed a slightly different implementation that I think would support an explicitly empty list (if pipeline option serialization works the way I think it does 😅)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "clairemcginty (via GitHub)" <gi...@apache.org>.
clairemcginty commented on code in PR #36809:
URL: https://github.com/apache/beam/pull/36809#discussion_r2535554615
##########
runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.java:
##########
@@ -266,4 +267,30 @@ public String create(PipelineOptions options) {
List<String> getJdkAddOpenModules();
void setJdkAddOpenModules(List<String> options);
+
+ class AvroSerializableClassesFactory implements DefaultValueFactory<List<String>> {
Review Comment:
makes sense to me! I'll update 👍
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #36809:
URL: https://github.com/apache/beam/pull/36809#issuecomment-3528256366
## Summary of Changes
Hello @clairemcginty, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request proposes a solution to a runtime `SecurityException` encountered in Dataflow jobs using Avro 1.11.4+ when Avro schemas contain `java-class` annotations for certain types (e.g., `java.math.BigDecimal`). The change introduces a new `DataflowPipelineOption` called `avroSerializableClasses`. This option allows users to provide a comma-separated list of trusted classes, which the Dataflow worker then uses to set the `org.apache.avro.SERIALIZABLE_CLASSES` system property, thereby resolving the security error without requiring custom worker images.
### Highlights
* **Avro Compatibility Fix**: Addresses a `SecurityException` in Avro 1.11.4+ when using `java-class` annotations in schemas, specifically for classes like `java.math.BigDecimal`, which previously caused runtime decoding errors on Dataflow.
* **New Pipeline Option**: Introduces a new `DataflowPipelineOption` named `avroSerializableClasses`. This option allows users to specify a list of trusted serializable classes directly through pipeline options.
* **Dataflow Worker Integration**: Modifies the Dataflow worker boot process (`boot.go`) to read the new `avroSerializableClasses` option and dynamically set the `org.apache.avro.SERIALIZABLE_CLASSES` Java system property for the worker JVM, resolving the security issue without requiring custom worker images.
<details>
<summary><b>Using Gemini Code Assist</b></summary>
<br>
The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips.
<b>Invoking Gemini</b>
You can request assistance from Gemini at any point by creating a comment using either `/gemini <command>` or `@gemini-code-assist <command>`. Below is a summary of the supported commands on the current page.
Feature | Command | Description
--- | --- | ---
Code Review | `/gemini review` | Performs a code review for the current pull request in its current state.
Pull Request Summary | `/gemini summary` | Provides a summary of the current pull request in its current state.
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help | `/gemini help` | Displays a list of available commands.
<b>Customization</b>
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a `.gemini/` folder in the base of the repository. Detailed instructions can be found [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github).
<b>Limitations & Feedback</b>
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up [here](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG).
<b>You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the [Gemini Code Assist IDE Extension](https://cloud.google.com/products/gemini/code-assist).</b>
</details>
[^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on code in PR #36809:
URL: https://github.com/apache/beam/pull/36809#discussion_r2538999438
##########
runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.java:
##########
@@ -266,4 +267,30 @@ public String create(PipelineOptions options) {
List<String> getJdkAddOpenModules();
void setJdkAddOpenModules(List<String> options);
+
+ class AvroSerializableClassesFactory implements DefaultValueFactory<List<String>> {
Review Comment:
tested that it mostly work as intented
- without setting `avroSerializableClasses`, I indeed get java command `Executing: java -Xmx5835282432 -XX:+UseParallelGC ... -Dorg.apache.avro.SERIALIZABLE_CLASSES=java.math.BigDecimal,java.math.BigInteger,java.net.URI,java.net.URL,java.io.File,java.lang.Integer... org.apache.beam.fn.harness.FnHarness`
- set pipeline option `--avroSerializableClasses=`, however, I get java command `-Dorg.apache.avro.SERIALIZABLE_CLASSES= `. This is because the pipeline option get parsed to an empty string, then it is a list of size 1, instead of zero.
We probably want to change to
```
if len(serializableClassesList) > 0 && !(len(serializableClassesList) == 1 && len(numbersArray[0]) == 0) {
```
or better use an utility format to check string list non-empty or contains only one empty string
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "clairemcginty (via GitHub)" <gi...@apache.org>.
clairemcginty commented on code in PR #36809:
URL: https://github.com/apache/beam/pull/36809#discussion_r2539211190
##########
runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.java:
##########
@@ -266,4 +267,30 @@ public String create(PipelineOptions options) {
List<String> getJdkAddOpenModules();
void setJdkAddOpenModules(List<String> options);
+
+ class AvroSerializableClassesFactory implements DefaultValueFactory<List<String>> {
Review Comment:
thanks for checking! updated it to just:
```go
if serializableClasses, ok := pipelineOptions.GetStructValue().GetFields()["avroSerializableClasses"]; ok {
for _, cls := range serializableClasses.GetListValue().GetValues() {
if cls.GetStringValue() != "" {
serializableClassesList = append(serializableClassesList, cls.GetStringValue())
}
}
}
```
I did some googling/compared the rest of the Go code style in the Beam project and it seems that `str != ""` is the canonical way to check for an empty string 🤔
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on PR #36809:
URL: https://github.com/apache/beam/pull/36809#issuecomment-3549519990
testWriteUnboundedWithCustomBatchParameters (org.apache.beam.sdk.io.TextIOWriteTest) failed not related to the change. Merging for now
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36809:
URL: https://github.com/apache/beam/pull/36809#issuecomment-3528822402
Assigning reviewers:
R: @chamikaramj for label java.
Note: If you would like to opt out of this review, comment `assign to next reviewer`.
Available commands:
- `stop reviewer notifications` - opt out of the automated review tooling
- `remind me after tests pass` - tag the comment author after tests pass
- `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
The PR bot will only process comments in the main thread (not review comments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "clairemcginty (via GitHub)" <gi...@apache.org>.
clairemcginty commented on PR #36809:
URL: https://github.com/apache/beam/pull/36809#issuecomment-3528838774
cc @Abacn - I think you merged the original upgrade from Avro 1.8 -> 1.11 :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn merged PR #36809:
URL: https://github.com/apache/beam/pull/36809
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "kellen (via GitHub)" <gi...@apache.org>.
kellen commented on code in PR #36809:
URL: https://github.com/apache/beam/pull/36809#discussion_r2524660938
##########
sdks/java/container/boot.go:
##########
@@ -276,6 +276,14 @@ func main() {
args = append(args, "--add-modules="+module.GetStringValue())
}
}
+ // Add trusted Avro serializable classes
+ if serializableClasses, ok := pipelineOptions.GetStructValue().GetFields()["avroSerializableClasses"]; ok {
Review Comment:
We could have both; a default that matches avro and this option to override when needed. Ideally the avro default list should be public so users can extend/modify it as required.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on code in PR #36809:
URL: https://github.com/apache/beam/pull/36809#discussion_r2535391424
##########
runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.java:
##########
@@ -266,4 +267,30 @@ public String create(PipelineOptions options) {
List<String> getJdkAddOpenModules();
void setJdkAddOpenModules(List<String> options);
+
+ class AvroSerializableClassesFactory implements DefaultValueFactory<List<String>> {
Review Comment:
I wonder if the default logic should be handled in boot.go. Technically sdks/java/container/boot.go, the SDK harness binary isn't limited to Dataflow. All portable runners use this container. Also in the case of Python/Yaml pipeline Java SDK harness container spinned up without go through this runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.java
Consider the following, in boot.go,
```
if serializableClasses, ok := pipelineOptions.GetStructValue().GetFields()["avroSerializableClasses"]; ok && <serializableClasses not empty> {
...} else {
// default args
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Proposal] Allow users to specify trusted Avro serializable classes to Dataflow worker [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on code in PR #36809:
URL: https://github.com/apache/beam/pull/36809#discussion_r2535393626
##########
runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.java:
##########
@@ -266,4 +267,30 @@ public String create(PipelineOptions options) {
List<String> getJdkAddOpenModules();
void setJdkAddOpenModules(List<String> options);
+
+ class AvroSerializableClassesFactory implements DefaultValueFactory<List<String>> {
+ @Override
+ public List<String> create(PipelineOptions options) {
+ return Arrays.asList(
+ "java.math.BigDecimal",
+ "java.math.BigInteger",
+ "java.net.URI",
+ "java.net.URL",
+ "java.io.File",
+ "java.lang.Integer");
+ }
+ }
+
+ /**
+ * The Avro spec supports the `java-class` schema annotation, which allows fields to be serialized
+ * and deserialized via their toString/String constructor. As of Avro 1.11.4+, allowed Java
+ * classes must be explicitly specified via the jvm option. The comma-separated String value of
+ * this pipeline option will be passed to the Dataflow worker via the
+ * -Dorg.apache.avro.SERIALIZABLE_CLASSES jvm option.
+ */
+ @Description("Serializable classes required by java-class props in Avro 1.11.4+")
+ @Default.InstanceFactory(AvroSerializableClassesFactory.class)
+ List<String> getAvroSerializableClasses();
+
+ void setAvroSerializableClasses(List<String> options);
Review Comment:
That said this should be an "SDKHarnessOptions": https://github.com/apache/beam/blob/master/sdks/java/core/src/main/java/org/apache/beam/sdk/options/SdkHarnessOptions.java
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org