Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading argument name in Message::seal_signed #22

Open
olivereanderson opened this issue Jun 8, 2022 · 1 comment
Open

Misleading argument name in Message::seal_signed #22

olivereanderson opened this issue Jun 8, 2022 · 1 comment

Comments

@olivereanderson
Copy link

Hi I have a question about Message::seal_signed.

The signature of Message::seal_signed is as follows:

    pub fn seal_signed(
        self,
        encryption_sender_private_key: &[u8],
        encryption_recipient_public_keys: Option<Vec<Option<Vec<u8>>>>,
        signing_algorithm: SignatureAlgorithm,
        signing_sender_private_key: &[u8],
    ) -> Result<String, Error>

From the name of signing_sender_private_key I expect this to be a private key, however in the case of SignatureAlgorithm::EdDsa it looks like one should supply an actual key pair here as demonstrated in section five of your REAMDE. If it happens to be the case that signing_sender_private_key is standard terminology that is universally understood to be the private key concatenated with the public key in the case of EdDsa then it is of course fine the way it is now and this issue can be immediately closed. If that is however not the case then it would be great if either the name of the argument would be changed to something more descriptive or the documentation could be updated to explain what is expected here.

Thank you for your time and let me know if there is anything I can do to help.

@styvane
Copy link
Member

styvane commented Aug 25, 2022

cc @Exulansis

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants