Skip to content

feat(sdk): plain text policy support #694

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

sujankota
Copy link
Contributor

Adds support for specifying policyType (EmbeddedEncrypted or EmbeddedText) when creating NanoTDFs via the SDK and CLI.

Key Changes:

  • CLI: New --policyType option for NanoTDF encryption.
  • SDK: policyType is now passed through all layers and used in the binary NanoTDF header.
  • Default remains EmbeddedEncrypted if not specified.

Impact:

  • Users can now embed policies as plain text (EmbeddedText) or encrypted (EmbeddedEncrypted).
  • No breaking changes; backward compatible.

@sujankota sujankota requested a review from a team as a code owner July 22, 2025 15:04
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @sujankota, I'm Gemini Code Assist1! 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 enhances the NanoTDF creation process by adding support for specifying the policy embedding type, allowing policies to be either encrypted or stored as plain text directly within the NanoTDF. This provides greater flexibility for policy management for both CLI and SDK users, with no breaking changes to existing functionality.

Highlights

  • Policy Type Option for NanoTDF: Introduced a new --policyType option to the CLI for NanoTDF encryption, allowing users to specify whether the policy should be EmbeddedEncrypted (default) or EmbeddedText (plain text).
  • SDK Integration for Policy Type: The policyType option is now propagated through the SDK's CreateNanoTDFOptions and EncryptOptions, ensuring it's passed down to the core encryption logic for NanoTDF creation.
  • Dynamic Policy Embedding Logic: The underlying NanoTDF encryption function (lib/src/nanotdf/encrypt.ts) has been updated to conditionally encrypt the policy or embed it as plain text based on the policyType provided, affecting how the policy content and its binding are handled.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 or fill out our survey to provide feedback.

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.

Copy link

If these changes look good, signoff on them with:

git pull && git commit --amend --signoff && git push --force-with-lease origin

If they aren't any good, please remove them with:

git pull && git reset --hard HEAD~1 && git push --force-with-lease origin

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds support for specifying a policyType when creating NanoTDFs, allowing for policies to be embedded as plain text. The changes are well-implemented across the CLI and SDK layers. The logic for handling the new policyType is sound, and the refactoring in lib/opentdf.ts to simplify option handling is a good improvement. One suggestion has been provided to improve the robustness of how the policyType command-line argument is parsed.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@dmihalcik-virtru dmihalcik-virtru self-requested a review August 1, 2025 22:16
@sujankota sujankota force-pushed the feat/add-plain-text-policy branch from 6b20a5a to eb60274 Compare August 5, 2025 19:29
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants