Skip to content

[easy] Add an example script that masks a secret key for safe logging #113

Description

@davedumto

Summary

Add a standalone example script under contrib/examples/ that masks all but the first few characters of a secret key string, suitable for safe logging.

Requirements

  • File lives under contrib/examples/mask-secret/ with a short README.
  • Exposes a small maskSecret function used by the script.
  • Never logs or prints the full unmasked secret anywhere in the script.
  • Include a few example inputs and expected masked outputs in the README.

Constraints

  • Fork the repo, then create your branch from the drips branch (NOT main).
  • Do ALL your work inside the contrib/ folder. Do not add, edit, rename,
    or delete any file outside contrib/.
  • Open your PR against the drips branch. PRs targeting main are
    auto-closed. PRs targeting drips that touch files outside contrib/ are
    also auto-closed.
  • Save your work under contrib/examples/ named after this issue (for example,
    contrib/examples/issue-42-name/).

Acceptance Criteria

  • The change is entirely inside contrib/.
  • The PR base branch is drips.
  • Reviewed and approved by a maintainer before merge to drips.
  • The maintainer will merge drips into main separately.

Activity

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

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave program

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions