KEYGEN: add doxygen comments

This commit is contained in:
hasufell 2014-05-25 01:11:56 +02:00
parent dda90cabcf
commit 32f2eb2295
No known key found for this signature in database
GPG Key ID: 220CD1C5BDEED020

View File

@ -33,9 +33,25 @@
typedef struct keypair keypair; typedef struct keypair keypair;
/**
* This struct holds the keypair,
* both private and public components.
*/
struct keypair { struct keypair {
/**
* First part of the private key,
* a random polynom.
*/
fmpz_poly_t priv; fmpz_poly_t priv;
/**
* Second part of the private key,
* the priv polynom inverted.
*/
fmpz_poly_t priv_inv; fmpz_poly_t priv_inv;
/**
* The public key, computed as:
* h = p * (Fq * g) mod q
*/
fmpz_poly_t pub; fmpz_poly_t pub;
}; };