Skip to content

docs(auth export): documment --unmasked flag#366

Open
secustor wants to merge 2 commits intogoogleworkspace:mainfrom
secustor:docs/document-unmasked
Open

docs(auth export): documment --unmasked flag#366
secustor wants to merge 2 commits intogoogleworkspace:mainfrom
secustor:docs/document-unmasked

Conversation

@secustor
Copy link

@secustor secustor commented Mar 10, 2026

Description

Document --unmasked flag for gws auth export

Checklist:

  • My code follows the AGENTS.md guidelines (no generated google-* crates).
  • I have run cargo fmt --all to format the code perfectly.
  • I have run cargo clippy -- -D warnings and resolved all warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have provided a Changeset file (e.g. via pnpx changeset) to document my changes.

@changeset-bot
Copy link

changeset-bot bot commented Mar 10, 2026

🦋 Changeset detected

Latest commit: eefbe52

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@googleworkspace/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@google-cla
Copy link

google-cla bot commented Mar 10, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 focuses on enhancing the clarity and usability of the gws command-line tool by updating its documentation. Specifically, it informs users about the --unmasked flag available with the auth export command, which controls the masking of sensitive credential information. Additionally, it improves code readability by adding a doc comment to a key function responsible for credential export.

Highlights

  • Documentation Update: The --unmasked flag for the auth export command has been documented, clarifying its purpose to print full credentials including secrets.
  • Code Clarity: A documentation comment was added to the handle_export asynchronous function, explaining its role in exporting credentials to standard output.
Changelog
  • src/auth_commands.rs
    • Documented the --unmasked flag for the auth export command.
    • Added a documentation comment to the handle_export function.
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 Generative AI Prohibited Use Policy, 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
Contributor

@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 documentation for the --unmasked flag of the auth export command. The changes correctly document the flag in the help text and add a doc comment to the handle_export function. However, I've identified a critical security vulnerability in the handle_export function where it could leak unmasked secrets to stdout if the credential file is corrupted. I've left a comment with details on how to fix this.

.map(|s| s.to_string())
}

/// Export credentials to stdout
Copy link
Contributor

Choose a reason for hiding this comment

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

critical

This function has a potential security vulnerability. When unmasked is false, it attempts to parse the decrypted credentials as JSON to mask secrets. However, if the JSON parsing fails (e.g., due to file corruption), the else block on line 426 will print the raw, unmasked contents to stdout. This could leak secrets.

Instead of printing the raw content on parsing failure, the function should return an error. For example:

// ...
} else {
    match serde_json::from_str::<serde_json::Value>(&contents) {
        Ok(mut creds) => {
            // ... masking logic ...
            println!("{}", serde_json::to_string_pretty(&creds).unwrap());
        }
        Err(e) => {
            return Err(GwsError::Validation(format!("Failed to parse credentials for masking: {e}")));
        }
    }
}
// ...

@github-actions
Copy link
Contributor

/gemini review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants