PowerShell / PowerShell/PSScriptAnalyzer
AvoidUsingPlainTextForPassword docs do not cover all checked parameter names
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- C#
- Star
- 2.2k
- Fork
- 414
- Merge trung bình
- 13 giờ 1 phút
- Pull request đã merge (30 ngày)
- 2
Mô tả
I have a script parameter that holds a path to the encrypted credential file named $CredentialFile for which I get the warning:
Parameter '$CredentialFile' should use SecureString, otherwise this will expose sensitive information. See ConvertTo-SecureString for more information.
There is no reason for me use SecureString here and I cannot think of a better alternative to the parameter name, so it would be nice to suppress this message for this particular instance, but not to the whole file or project. Besides, the documentation for PSAvoidUsingPlainTextForPassword needs to include Credential and whatever other strings it gets triggered of, since it only mentions one word: Password.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với quy tắc PSAvoidUsingPlainTextForPassword và mục tài liệu của quy tắc này; issue không nêu đường dẫn tệp hoặc đường dẫn kiểm thử. Xem xét cách các tên tham số như CredentialFile được bao quát, sau đó cập nhật tài liệu để mô tả tất cả các tên áp dụng được và cách được hỗ trợ để loại bỏ một cảnh báo duy nhất, nếu hành vi được ghi nhận cho phép điều đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- powershell
- Lĩnh vực
- documentation, tooling
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100