Skip to content

Commit

Permalink
Rename data_to_* to message
Browse files Browse the repository at this point in the history
  • Loading branch information
William Tisäter committed Oct 29, 2023
1 parent 9ca480e commit 61653e2
Show file tree
Hide file tree
Showing 54 changed files with 21 additions and 9,307 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/site
/target
/.shadowenv.d
*.so
Expand Down
16 changes: 8 additions & 8 deletions python/rsmime/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ class Rsmime:
key_file: Path to private key on disk.
Raises:
CertificateError: If there is an error reading the certificate or key.
exceptions.CertificateError: If there is an error reading the certificate or key.
"""
...
def sign(self, data_to_sign: bytes, *, detached: bool = False) -> bytes:
def sign(self, message: bytes, *, detached: bool = False) -> bytes:
"""Sign a message and return the signed S/MIME message.
Parameters:
data_to_sign: Data to sign.
message: Message to sign.
detached: Whether to return a detached signature. When set to `True`, the
return value will be a multipart message with the signature in the
plain text in the first part and the signature in the second part. When
Expand All @@ -25,25 +25,25 @@ class Rsmime:
Signed S/MIME message.
Raises:
SignError: If there is an error signing the data.
exceptions.SignError: If there is an error signing the data.
"""
...
@staticmethod
def verify(data_to_verify: bytes, raise_on_expired: bool = False) -> bytes:
def verify(message: bytes, raise_on_expired: bool = False) -> bytes:
"""Verify a signed message and return the raw message data.
Parameters:
data_to_verify: The signed message to verify.
message: The signed message to verify.
raise_on_expired: Whether to raise an exception if any certificate
in the message has expired.
Returns:
Raw message data.
Raises:
VerifyError: If there is an error verifying the message.
CertificateExpiredError: If any certificate in the message has expired.
exceptions.VerifyError: If there is an error verifying the message.
exceptions.CertificateExpiredError: If any certificate in the message has expired.
Raise only if `raise_on_expired` is `True`.
"""
...
327 changes: 0 additions & 327 deletions site/404.html

This file was deleted.

Loading

0 comments on commit 61653e2

Please sign in to comment.