Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mccoyp committed Sep 11, 2023
1 parent 12c8c2c commit 5894e85
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Changelog
* Added support for obtaining X.509 certificate signing request signature
algorithm parameters (including PSS) via
:meth:`~cryptography.x509.CertificateSigningRequest.signature_algorithm_parameters`.
* Added `mgf` property to
:class:`~cryptography.hazmat.primitives.asymmetric.padding.PSS`.
* Added `algorithm` and `mgf` properties to
:class:`~cryptography.hazmat.primitives.asymmetric.padding.OAEP`.

.. _v41-0-3:

Expand Down
24 changes: 24 additions & 0 deletions docs/hazmat/primitives/asymmetric/rsa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,14 @@ Padding
Pass this attribute to ``salt_length`` to automatically determine the
salt length when verifying. Raises ``ValueError`` if used when signing.

.. attribute:: mgf

:type: :class:`~cryptography.hazmat.primitives.asymmetric.padding.MGF`

.. versionadded:: 42.0.0

The padding's mask generation function (MGF).

.. class:: OAEP(mgf, algorithm, label)

.. versionadded:: 0.4
Expand All @@ -335,6 +343,22 @@ Padding
:param bytes label: A label to apply. This is a rarely used field and
should typically be set to ``None`` or ``b""``, which are equivalent.

.. attribute:: algorithm

:type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`

.. versionadded:: 42.0.0

The padding's hash algorithm.

.. attribute:: mgf

:type: :class:`~cryptography.hazmat.primitives.asymmetric.padding.MGF`

.. versionadded:: 42.0.0

The padding's mask generation function (MGF).

.. class:: PKCS1v15()

.. versionadded:: 0.3
Expand Down

0 comments on commit 5894e85

Please sign in to comment.