Remove trailing spaces
This commit is contained in:
parent
149ce5b377
commit
71fb3e3dda
@ -2,8 +2,8 @@
|
||||
#define crypto_box_H
|
||||
|
||||
/** \defgroup apke Authenticated Public-Key Encryption
|
||||
*
|
||||
* Definitions and functions to perform Authenticated Encryption.
|
||||
*
|
||||
* Definitions and functions to perform Authenticated Encryption.
|
||||
*
|
||||
* Authentication encryption provides guarantees towards the:
|
||||
*
|
||||
@ -22,13 +22,13 @@
|
||||
* open_after functions.
|
||||
*
|
||||
*
|
||||
* \warning
|
||||
* \warning
|
||||
* THREAD SAFETY: crypto_box_keypair() is thread-safe,
|
||||
* provided that you called sodium_init() once before using any
|
||||
* other libsodium function.
|
||||
* Other functions are always thread-safe.
|
||||
*
|
||||
* @{
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include <stddef.h>
|
||||
@ -42,7 +42,7 @@ extern "C" {
|
||||
|
||||
|
||||
#define crypto_box_PUBLICKEYBYTES crypto_box_curve25519xsalsa20poly1305_PUBLICKEYBYTES
|
||||
/// Size of Public Key.
|
||||
/// Size of Public Key.
|
||||
SODIUM_EXPORT
|
||||
size_t crypto_box_publickeybytes(void);
|
||||
|
||||
@ -67,7 +67,7 @@ SODIUM_EXPORT
|
||||
size_t crypto_box_zerobytes(void);
|
||||
|
||||
#define crypto_box_BOXZEROBYTES crypto_box_curve25519xsalsa20poly1305_BOXZEROBYTES
|
||||
/// No. of leading 0 bytes in the cipher-text.
|
||||
/// No. of leading 0 bytes in the cipher-text.
|
||||
SODIUM_EXPORT
|
||||
size_t crypto_box_boxzerobytes(void);
|
||||
|
||||
@ -82,7 +82,7 @@ SODIUM_EXPORT
|
||||
const char *crypto_box_primitive(void);
|
||||
|
||||
/**
|
||||
* Randomly generates a secret key and a corresponding public key.
|
||||
* Randomly generates a secret key and a corresponding public key.
|
||||
*
|
||||
* @param[out] pk the buffer for the public key
|
||||
* @param[out] sk the buffer for the private key with length crypto_box_SECRETKEYTBYTES
|
||||
@ -111,7 +111,7 @@ int crypto_box_keypair(unsigned char *pk, unsigned char *sk);
|
||||
/**
|
||||
* Partially performs the computation required for both encryption and
|
||||
* decryption of data.
|
||||
*
|
||||
*
|
||||
* @param[out] k the result of the computation.
|
||||
* @param[in] pk the receivers public key, used for encryption.
|
||||
* @param[in] sk the senders private key, used for signing.
|
||||
@ -122,11 +122,11 @@ int crypto_box_keypair(unsigned char *pk, unsigned char *sk);
|
||||
*
|
||||
* Example innvocation:
|
||||
*
|
||||
*~~~~~{.c}
|
||||
*~~~~~{.c}
|
||||
* unsigned char k[crypto_box_BEFORENMBYTES];
|
||||
* const unsigned char pk[crypto_box_PUBLICKEYBYTES];
|
||||
* const unsigned char sk[crypto_box_SECRETKEYBYTES];
|
||||
*
|
||||
*
|
||||
* crypto_box_beforenm(k,pk,sk);
|
||||
*~~~~~
|
||||
*/
|
||||
@ -137,7 +137,7 @@ int crypto_box_beforenm(unsigned char *k,
|
||||
|
||||
/**
|
||||
* Encrypts a given a message m, using partial computed data.
|
||||
*
|
||||
*
|
||||
* @param[out] ctxt the buffer for the cipher-text.
|
||||
* @param[in] msg the message to be encrypted.
|
||||
* @param[in] mlen the length of msg.
|
||||
@ -158,7 +158,7 @@ int crypto_box_beforenm(unsigned char *k,
|
||||
* const unsigned char n[crypto_box_NONCEBYTES];
|
||||
* const unsigned char m[...]; unsigned long long mlen;
|
||||
* unsigned char c[...];
|
||||
*
|
||||
*
|
||||
* crypto_box_afternm(c,m,mlen,n,k);
|
||||
*~~~~~
|
||||
*/
|
||||
@ -189,12 +189,12 @@ int crypto_box_afternm(unsigned char *c,
|
||||
* Example innvocation:
|
||||
*
|
||||
*~~~~~{.c}
|
||||
*
|
||||
*
|
||||
* const unsigned char k[crypto_box_BEFORENMBYTES];
|
||||
* const unsigned char n[crypto_box_NONCEBYTES];
|
||||
* const unsigned char c[...]; unsigned long long clen;
|
||||
* unsigned char m[...];
|
||||
*
|
||||
*
|
||||
* crypto_box_open_afternm(m,c,clen,n,k);
|
||||
*~~~~~
|
||||
*/
|
||||
|
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
* \addgroup hash
|
||||
*
|
||||
*
|
||||
* @TODO document
|
||||
*
|
||||
* @{
|
||||
|
@ -4,7 +4,7 @@
|
||||
#include "crypto_hash_sha512.h"
|
||||
#include "export.h"
|
||||
|
||||
/**
|
||||
/**
|
||||
* \defgroup hash Methods for Hashing
|
||||
*
|
||||
* Utility function to allow for hash computation.
|
||||
|
@ -29,12 +29,12 @@ SODIUM_EXPORT
|
||||
size_t crypto_secretbox_noncebytes(void);
|
||||
|
||||
#define crypto_secretbox_ZEROBYTES crypto_secretbox_xsalsa20poly1305_ZEROBYTES
|
||||
/// No. of leading 0 bytes in the message.
|
||||
/// No. of leading 0 bytes in the message.
|
||||
SODIUM_EXPORT
|
||||
size_t crypto_secretbox_zerobytes(void);
|
||||
|
||||
#define crypto_secretbox_BOXZEROBYTES crypto_secretbox_xsalsa20poly1305_BOXZEROBYTES
|
||||
/// No. of leading 0 bytes in the cipher-text.
|
||||
/// No. of leading 0 bytes in the cipher-text.
|
||||
SODIUM_EXPORT
|
||||
size_t crypto_secretbox_boxzerobytes(void);
|
||||
|
||||
|
@ -34,13 +34,13 @@ SODIUM_EXPORT
|
||||
size_t crypto_sign_seedbytes(void);
|
||||
|
||||
#define crypto_sign_PUBLICKEYBYTES crypto_sign_ed25519_PUBLICKEYBYTES
|
||||
/// length of verification key.
|
||||
/// length of verification key.
|
||||
|
||||
SODIUM_EXPORT
|
||||
size_t crypto_sign_publickeybytes(void);
|
||||
|
||||
#define crypto_sign_SECRETKEYBYTES crypto_sign_ed25519_SECRETKEYBYTES
|
||||
/// length of signing key.
|
||||
/// length of signing key.
|
||||
SODIUM_EXPORT
|
||||
size_t crypto_sign_secretkeybytes(void);
|
||||
|
||||
@ -100,7 +100,7 @@ int crypto_sign_keypair(unsigned char *pk, unsigned char *sk);
|
||||
* unsigned long long mlen;
|
||||
* unsigned char sm[...];
|
||||
* unsigned long long smlen;
|
||||
*
|
||||
*
|
||||
* crypto_sign(sm,&smlen,m,mlen,sk);
|
||||
*~~~~~
|
||||
*/
|
||||
@ -131,7 +131,7 @@ int crypto_sign(unsigned char *sm, unsigned long long *smlen,
|
||||
* const unsigned char pk[crypto_sign_PUBLICKEYBYTES];
|
||||
* const unsigned char sm[...]; unsigned long long smlen;
|
||||
* unsigned char m[...]; unsigned long long mlen;
|
||||
*
|
||||
*
|
||||
* crypto_sign_open(m,&mlen,sm,smlen,pk);
|
||||
*~~~~~
|
||||
*/
|
||||
|
@ -4,7 +4,7 @@
|
||||
/** \defgroup symenc Symmetric Encryption
|
||||
*
|
||||
* Definitions and functions for symmetric encryption.
|
||||
*
|
||||
*
|
||||
* Alongside the standard interface there also exists a
|
||||
* pre-computation interface. In the event that applications are
|
||||
* required to send several messages to the same receiver, speed can
|
||||
@ -49,7 +49,7 @@ const char *crypto_stream_primitive(void);
|
||||
|
||||
/**
|
||||
* Generates a stream using the given secret key and nonce.
|
||||
*
|
||||
*
|
||||
* @param[out] stream the generated stream.
|
||||
* @param[out] slen the length of the generated stream.
|
||||
* @param[in] nonce the nonce used to generate the stream.
|
||||
@ -77,7 +77,7 @@ int crypto_stream(unsigned char *c, unsigned long long clen,
|
||||
|
||||
/**
|
||||
* Encrypts the given message using the given secret key and nonce.
|
||||
*
|
||||
*
|
||||
* The crypto_stream_xor function guarantees that the ciphertext is
|
||||
* the plaintext (xor) the output of crypto_stream. Consequently
|
||||
* crypto_stream_xor can also be used to decrypt.
|
||||
@ -94,7 +94,7 @@ int crypto_stream(unsigned char *c, unsigned long long clen,
|
||||
* @pre nonce must have length minimum crypto_stream_NONCEBYTES.
|
||||
* @pre key must have length minimum crpyto_stream_KEYBYTES
|
||||
* @post first mlen bytes of ctxt will contain the ciphertext.
|
||||
*
|
||||
*
|
||||
* Example invocation:
|
||||
*
|
||||
*~~~~~{.c}
|
||||
|
Loading…
Reference in New Issue
Block a user