greenbone / python-gvm

Greenbone Vulnerability Management Python Library
https://greenbone.github.io/python-gvm/
GNU General Public License v3.0
107 stars 60 forks source link

Allow to auto-generate password and ssh-key for credentials #1152

Closed bjoernricks closed 4 months ago

bjoernricks commented 4 months ago

What

Allow to auto-generate password and ssh-key for credentials

Why

Support auto-generating the password for a username+password credential and the ssh-key for a username+ssh-key credential. This is already supported by GMP since early versions but wasn't implemented in python-gvm.

References

DOS-209

Checklist

github-actions[bot] commented 4 months ago

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Snapshot Warnings

⚠️: No snapshots were found for the head SHA 47171e71fb9f0cfeafb405a7ae52eda25e891ea7.

Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

github-actions[bot] commented 4 months ago

Conventional Commits Report

Type Number
Changed 1

:rocket: Conventional commits found.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.57%. Comparing base (ae1bd44) to head (47171e7).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1152 +/- ## ======================================= Coverage 97.57% 97.57% ======================================= Files 65 65 Lines 4544 4544 Branches 832 832 ======================================= Hits 4434 4434 Misses 74 74 Partials 36 36 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

y0urself commented 3 months ago

@bjoernricks can you explain why the documentation of the function does not contain the new example code blocks? https://greenbone.github.io/python-gvm/api/gmpv224.html#gvm.protocols.gmp.GMPv224.create_credential

bjoernricks commented 3 months ago

Because https://greenbone.github.io/python-gvm/api/gmpv224.html#gvm.protocols.gmp.GMPv224.create_credential is generated from https://github.com/greenbone/python-gvm/blob/main/gvm/protocols/gmp/_gmp224.py#L1916 and I missed updating its docstring.