doc/source/api.rst

   1 API Documentation
   2 =================
   3
   4 Types
   5 -----
   6
   7 .. c:type:: dipe_param_t
   8
   9    Stores public parameters used in DIPE. Initialized by :c:func:`dipe_init()` and freed by :c:func:`dipe_free_param`
  10
  11 .. c:type:: dipe_master_secretkey_t
  12 .. c:type:: dipe_master_publickey_t
  13 .. c:type:: dipe_secretkey_t
  14 .. c:type:: dipe_ctxt_t
  15
  16 Functions
  17 ---------
  18
  19 Initialization
  20 ~~~~~~~~~~~~~~
  21
  22 .. c:function:: void dipe_init(FILE* configfp, dipe_param_t* param)
  23
  24    initializes public parameters as well as the PBC library
  25
  26    :param configfp: File structure holding the pairing group definition as understood by PBC
  27
  28 Key Generation
  29 ~~~~~~~~~~~~~~
  30
  31 .. c:function:: void dipe_master_keygen(dipe_param_t param, size_t dimension, dipe_master_publickey_t* pk, dipe_master_secretkey_t* sk);
  32
  33 .. c:function:: void dipe_keygen(dipe_param_t param, dipe_master_secretkey_t msk, char* cid, element_t* y, dipe_secretkey_t* sk);
  34
  35    :param cid: Client ID, expected to be 16 bytes
  36    :param y: Policy vector for the secret key that is to be generated. Must match with the dimensions when `msk` was generated
  37    :type y: Array of Zn elements
  38
  39 En/Decryption
  40 ~~~~~~~~~~~~~
  41
  42 .. c:function:: void dipe_encrypt(dipe_param_t param, dipe_master_publickey mpk, element_t* x, element_t ptxt, dipe_ctxt_t* ctxt)
  43 .. c:function:: void dipe_decrypt(dipe_param_t param, dipe_secretkey_t sk, char* cid, element_t* y, dipe_ctxt_t ctxt, element_t* ptxt)
  44
  45    :param result: It is the responsibility of the caller to initialize the element to GT and to free it after usage
  46    :type result: :c:type:`element_t`
  47
  48 Memory Management
  49 ~~~~~~~~~~~~~~~~~
  50
  51 .. c:function:: void dipe_free_param(dipe_param_t param);
  52 .. c:function:: void dipe_free_master_secretkey(dipe_master_secretkey_t sk);
  53 .. c:function:: void dipe_free_master_publickey(dipe_master_publickey_t pk);
  54 .. c:function:: void dipe_free_secretkey(dipe_secretkey_t sk);
  55
  56
  57