KEYGEN: add doxygen comments
This commit is contained in:
parent
dda90cabcf
commit
32f2eb2295
@ -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;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user