Surface sensitive pattern as a configurable option

Open
#4,197 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
cli, security

Research direction

Start in History.cs at lines 116-118 and inspect how the sensitive pattern is currently defined and used. Review PSReadLine's existing configuration surface, then determine how to expose the default pattern and any additional patterns; done means sensitive-history matching is configurable without losing the current default behavior.

Written by the indexing model from the issue text.

Description

Issue-Enhancement Needs-Triage :mag:
Prerequisites
  • Write a descriptive title.
Description of the new feature/enhancement

we currently have this regex pattern hardcoded & this could be useful for further extensibility going forward.

https://github.com/PowerShell/PSReadLine/blob/e9122d38e932614393ff61faf57d6518990d7226/PSReadLine/History.cs#L116-L118

Therefore it would be great to surface extensibility of this via either

  1. fully configurable option with this pattern as the default setting
  2. setable property for addtional patterns to match

2 I feel is a better & more secureminded implementation going forward & would enable users to manage asks like #4077 (which we perhaps could pull into the default's as part of this enhancement

Proposed technical implementation details (optional)

No response

Dominant language
C#
Stars
4.4k
Forks
341
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PowerShell/PSReadLine

All issues in PowerShell/PSReadLine

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.