StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

Clarify that the pass key new function can fail.

Browse Source 
Also clarify that passwords can be empty or NULL.
This commit is contained in:
iphydf 2017-01-08 15:18:36 +00:00
parent 8b4eae4038
commit 6480765222
No known key found for this signature in database
GPG Key ID: 3855DBA2D74403C9
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
toxencryptsave/toxencryptsave.api.h
View File

@ -146,7 +146,7 @@ error for decryption {
* *
* @param plaintext A byte array of length `plaintext_len`. * @param plaintext A byte array of length `plaintext_len`.
* @param plaintext_len The length of the plain text array. Bigger than 0. * @param plaintext_len The length of the plain text array. Bigger than 0.
* @param passphrase The user-provided password. * @param passphrase The user-provided password. Can be empty.
* @param passphrase_len The length of the password. * @param passphrase_len The length of the password.
* @param ciphertext The cipher text array to write the encrypted data to. * @param ciphertext The cipher text array to write the encrypted data to.
* *
@ -164,7 +164,7 @@ static bool pass_encrypt(const uint8_t[plaintext_len] plaintext, const uint8_t[p
* *
* @param ciphertext A byte array of length `ciphertext_len`. * @param ciphertext A byte array of length `ciphertext_len`.
* @param ciphertext_len The length of the cipher text array. At least $PASS_ENCRYPTION_EXTRA_LENGTH. * @param ciphertext_len The length of the cipher text array. At least $PASS_ENCRYPTION_EXTRA_LENGTH.
* @param passphrase The user-provided password. * @param passphrase The user-provided password. Can be empty.
* @param passphrase_len The length of the password. * @param passphrase_len The length of the password.
* @param plaintext The plain text array to write the decrypted data to. * @param plaintext The plain text array to write the decrypted data to.
* *
@ -200,6 +200,9 @@ class pass_Key {
/** /**
* Create a new $this. The initial value of it is indeterminate. To * Create a new $this. The initial value of it is indeterminate. To
* initialise it, use one of the derive_* functions below. * initialise it, use one of the derive_* functions below.
*
* In case of failure, this function returns NULL. The only failure mode at
* this time is memory allocation failure, so this function has no error code.
*/ */
static this new(); static this new();
@ -219,7 +222,7 @@ class pass_Key {
* a password, you also must know the random salt that was used. A * a password, you also must know the random salt that was used. A
* deterministic version of this function is $derive_with_salt. * deterministic version of this function is $derive_with_salt.
* *
* @param passphrase The user-provided password. * @param passphrase The user-provided password. Can be empty.
* @param passphrase_len The length of the password. * @param passphrase_len The length of the password.
* *
* @return true on success. * @return true on success.
@ -230,7 +233,7 @@ class pass_Key {
/** /**
* Same as above, except use the given salt for deterministic key derivation. * Same as above, except use the given salt for deterministic key derivation.
* *
* @param passphrase The user-provided password. * @param passphrase The user-provided password. Can be empty.
* @param passphrase_len The length of the password. * @param passphrase_len The length of the password.
* @param salt An array of at least $PASS_SALT_LENGTH bytes. * @param salt An array of at least $PASS_SALT_LENGTH bytes.
* *

11
toxencryptsave/toxencryptsave.h
View File

@ -195,7 +195,7 @@ typedef enum TOX_ERR_DECRYPTION {
* *
* @param plaintext A byte array of length `plaintext_len`. * @param plaintext A byte array of length `plaintext_len`.
* @param plaintext_len The length of the plain text array. Bigger than 0. * @param plaintext_len The length of the plain text array. Bigger than 0.
* @param passphrase The user-provided password. * @param passphrase The user-provided password. Can be empty.
* @param passphrase_len The length of the password. * @param passphrase_len The length of the password.
* @param ciphertext The cipher text array to write the encrypted data to. * @param ciphertext The cipher text array to write the encrypted data to.
* *
@ -212,7 +212,7 @@ bool tox_pass_encrypt(const uint8_t *plaintext, size_t plaintext_len, const uint
* *
* @param ciphertext A byte array of length `ciphertext_len`. * @param ciphertext A byte array of length `ciphertext_len`.
* @param ciphertext_len The length of the cipher text array. At least TOX_PASS_ENCRYPTION_EXTRA_LENGTH. * @param ciphertext_len The length of the cipher text array. At least TOX_PASS_ENCRYPTION_EXTRA_LENGTH.
* @param passphrase The user-provided password. * @param passphrase The user-provided password. Can be empty.
* @param passphrase_len The length of the password. * @param passphrase_len The length of the password.
* @param plaintext The plain text array to write the decrypted data to. * @param plaintext The plain text array to write the decrypted data to.
* *
@ -252,6 +252,9 @@ typedef struct Tox_Pass_Key Tox_Pass_Key;
/** /**
* Create a new Tox_Pass_Key. The initial value of it is indeterminate. To * Create a new Tox_Pass_Key. The initial value of it is indeterminate. To
* initialise it, use one of the derive_* functions below. * initialise it, use one of the derive_* functions below.
*
* In case of failure, this function returns NULL. The only failure mode at
* this time is memory allocation failure, so this function has no error code.
*/ */
struct Tox_Pass_Key *tox_pass_key_new(void); struct Tox_Pass_Key *tox_pass_key_new(void);
@ -271,7 +274,7 @@ void tox_pass_key_free(struct Tox_Pass_Key *_key);
* a password, you also must know the random salt that was used. A * a password, you also must know the random salt that was used. A
* deterministic version of this function is tox_pass_key_derive_with_salt. * deterministic version of this function is tox_pass_key_derive_with_salt.
* *
* @param passphrase The user-provided password. * @param passphrase The user-provided password. Can be empty.
* @param passphrase_len The length of the password. * @param passphrase_len The length of the password.
* *
* @return true on success. * @return true on success.
@ -282,7 +285,7 @@ bool tox_pass_key_derive(struct Tox_Pass_Key *_key, const uint8_t *passphrase, s
/** /**
* Same as above, except use the given salt for deterministic key derivation. * Same as above, except use the given salt for deterministic key derivation.
* *
* @param passphrase The user-provided password. * @param passphrase The user-provided password. Can be empty.
* @param passphrase_len The length of the password. * @param passphrase_len The length of the password.
* @param salt An array of at least TOX_PASS_SALT_LENGTH bytes. * @param salt An array of at least TOX_PASS_SALT_LENGTH bytes.
* *