feat: Expose cryptoservice

[elizabethhealy]

This pull request enables the dependency injection of a custom CryptoService. This change provides greater flexibility for developers, allowing them to supply alternative cryptographic implementations, such as those required for FIPS compliance, instead of relying solely on the default browser-native Web Crypto API. The OpenTDF class now accepts an optional cryptoService in its constructor options and propagates it to the underlying TDF3Client, ensuring that all cryptographic operations within the client adhere to the specified service.

[gemini-code-assist]

Summary of Changes

Hello @elizabethhealy, I'm Gemini Code Assist¹! 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 introduces a significant enhancement to the OpenTDF client by enabling the dependency injection of a custom CryptoService. This change provides greater flexibility for developers, allowing them to supply alternative cryptographic implementations, such as those required for FIPS compliance, instead of relying solely on the default browser-native Web Crypto API. The OpenTDF class now accepts an optional cryptoService in its constructor options and propagates it to the underlying TDF3Client, ensuring that all cryptographic operations within the client adhere to the specified service.

Highlights

• CryptoService Exposure: The CryptoService interface is now exposed, allowing for custom cryptographic implementations to be provided to the OpenTDF client.
• Configurable CryptoService: The OpenTDFOptions interface has been extended with an optional cryptoService property, enabling users to inject their own crypto service.
• Default to Native Crypto: If no custom cryptoService is provided, the OpenTDF client will default to using the browser's native Web Crypto API.
• TDF3Client Integration: The provided or default CryptoService is now passed down to the internal TDF3Client instance, ensuring consistent cryptographic operations throughout.
• Comprehensive Testing: New unit tests have been added to validate the proper injection and defaulting behavior of the CryptoService within the OpenTDF client.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

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.

Customization

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.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 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.

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.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request successfully introduces the ability to inject a custom CryptoService into the OpenTDF class, enhancing flexibility for cryptographic operations, such as supporting FIPS-compliant implementations. The changes are well-implemented, including necessary imports, interface updates, class property declarations, and constructor modifications. The new unit tests effectively validate both the custom service injection and the fallback to the default crypto service. Overall, this is a valuable addition to the SDK.

[github-actions]

X-Test Results

opentdf-sdk-lib
opentdf-ctl
✅ go-v0.4.34
✅ java-v0.4.34
✅ go-main
✅ js-v0.4.34
✅ java-main
✅ js-main

[github-actions]

X-Test Failure Report

opentdf-sdk-lib
opentdf-ctl

[github-actions]

X-Test Failure Report

opentdf-sdk-lib
opentdf-ctl
✅ go-main
❌ go-v0.9.0
✅ java-main
❌ java-v0.9.0
❌ js-v0.9.0
✅ js-main

[github-actions]

X-Test Failure Report

opentdf-sdk-lib
opentdf-ctl
❌ go-v0.9.0
✅ go-main
❌ java-v0.9.0
✅ java-main
❌ js-v0.9.0
✅ js-main

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

X-Test Results

opentdf-sdk-lib
opentdf-ctl
✅ go-main
✅ go-v0.9.0
✅ java-v0.9.0
✅ java-main
✅ js-v0.9.0
✅ js-main