Document SensitiveParameter attribute in callbacks

Open Beginner friendly
#5,734 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
php
Domain
documentation

Research direction

Start with the curl.constants.php page and locate the CURLOPT_SSH_HOSTKEYFUNCTION callback signature. Update the $key parameter documentation to show the SensitiveParameter attribute, then verify that the published signature matches the suggested improvement and retains the string type.

Written by the indexing model from the issue text.

Description

enhancement
Affected page

https://www.php.net/manual/en/curl.constants.php

Current issue

E.g. CURLOPT_SSH_HOSTKEYFUNCTION:

The callback must have the following signature:

function callback(
resource $curlHandle,
int $keyType,
string $key,
int $keyLength
): int

Suggested improvement

I think it would be better if it said #[\SensitiveParameter]string $key.

Additional context (optional)

PHP: SensitiveParameter - Manual

Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Contributor guide

No contributing guide indexed for this repository

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 php/doc-en

All issues in php/doc-en

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.