From 78705d5a49d7066a01b832546d2507456a3c5d2c Mon Sep 17 00:00:00 2001 From: "Schanzenbach, Martin" Date: Thu, 4 Jan 2018 15:28:02 +0100 Subject: -cleanup doc; fixes --- src/credential/credential.h | 2 +- src/credential/credential_api.c | 18 ++--- src/credential/credential_misc.c | 3 +- src/credential/credential_serialization.c | 13 ++- src/credential/gnunet-credential.c | 16 +--- src/credential/gnunet-service-credential.c | 116 +++++---------------------- src/credential/plugin_gnsrecord_credential.c | 2 +- src/credential/plugin_rest_credential.c | 43 ++-------- 8 files changed, 41 insertions(+), 172 deletions(-) (limited to 'src/credential') diff --git a/src/credential/credential.h b/src/credential/credential.h index f16249c1b..66a4636fc 100644 --- a/src/credential/credential.h +++ b/src/credential/credential.h @@ -20,7 +20,7 @@ /** * @file credential/credential.h * @brief IPC messages between CREDENTIAL API and CREDENTIAL service - * @author Adnan Husain + * @author Martin Schanzenbach */ #ifndef CREDENTIAL_H #define CREDENTIAL_H diff --git a/src/credential/credential_api.c b/src/credential/credential_api.c index ca54137ad..677cb9ad4 100644 --- a/src/credential/credential_api.c +++ b/src/credential/credential_api.c @@ -20,7 +20,7 @@ /** * @file credential/credential_api.c * @brief library to access the CREDENTIAL service - * @author Adnan Husain + * @author Martin Schanzenbach */ #include "platform.h" #include "gnunet_util_lib.h" @@ -189,7 +189,7 @@ mq_error_handler (void *cls, * Check validity of message received from the CREDENTIAL service * * @param cls the `struct GNUNET_CREDENTIAL_Handle *` - * @param loookup_msg the incoming message + * @param vr_msg the incoming message */ static int check_result (void *cls, @@ -204,7 +204,7 @@ check_result (void *cls, * Handler for messages received from the CREDENTIAL service * * @param cls the `struct GNUNET_CREDENTIAL_Handle *` - * @param loookup_msg the incoming message + * @param vr_msg the incoming message */ static void handle_result (void *cls, @@ -348,15 +348,15 @@ GNUNET_CREDENTIAL_disconnect (struct GNUNET_CREDENTIAL_Handle *handle) * @param lr the verify request to cancel */ void -GNUNET_CREDENTIAL_request_cancel (struct GNUNET_CREDENTIAL_Request *vr) +GNUNET_CREDENTIAL_request_cancel (struct GNUNET_CREDENTIAL_Request *lr) { - struct GNUNET_CREDENTIAL_Handle *handle = vr->credential_handle; + struct GNUNET_CREDENTIAL_Handle *handle = lr->credential_handle; GNUNET_CONTAINER_DLL_remove (handle->request_head, handle->request_tail, - vr); - GNUNET_MQ_discard (vr->env); - GNUNET_free (vr); + lr); + GNUNET_MQ_discard (lr->env); + GNUNET_free (lr); } @@ -369,8 +369,6 @@ GNUNET_CREDENTIAL_request_cancel (struct GNUNET_CREDENTIAL_Request *vr) * @param issuer_key the issuer public key * @param issuer_attribute the issuer attribute * @param subject_key the subject public key - * @param credential_count number of credentials provided - * @param credentials subject credentials * @param proc function to call on result * @param proc_cls closure for processor * @return handle to the queued request diff --git a/src/credential/credential_misc.c b/src/credential/credential_misc.c index 7849e81e6..c94c33919 100644 --- a/src/credential/credential_misc.c +++ b/src/credential/credential_misc.c @@ -20,7 +20,7 @@ /** - * @file credential/credential_mic.c + * @file credential/credential_misc.c * @brief Misc API for credentials * * @author Martin Schanzenbach @@ -113,7 +113,6 @@ GNUNET_CREDENTIAL_credential_from_string (const char* s) /** * Issue an attribute to a subject * - * @param handle handle to the Credential service * @param issuer the ego that should be used to issue the attribute * @param subject the subject of the attribute * @param attribute the name of the attribute diff --git a/src/credential/credential_serialization.c b/src/credential/credential_serialization.c index 1fc72c203..1d23bb08c 100644 --- a/src/credential/credential_serialization.c +++ b/src/credential/credential_serialization.c @@ -34,11 +34,10 @@ /** * Calculate how many bytes we will need to serialize - * the given delegation chain and credential + * the given delegation chain * - * @param d_count number of delegation chain entries - * @param dd array of #GNUNET_CREDENTIAL_Delegation - * @param cd a #GNUNET_CREDENTIAL_Credential + * @param ds_count number of delegation chain entries + * @param dsr array of #GNUNET_CREDENTIAL_DelegationSet * @return the required size to serialize */ size_t @@ -62,8 +61,7 @@ GNUNET_CREDENTIAL_delegation_set_get_size (unsigned int ds_count, * Serizalize the given delegation chain entries and credential * * @param d_count number of delegation chain entries - * @param dd array of #GNUNET_CREDENTIAL_Delegation - * @param cd a #GNUNET_CREDENTIAL_Credential + * @param dsr array of #GNUNET_CREDENTIAL_DelegationSet * @param dest_size size of the destination * @param dest where to store the result * @return the size of the data, -1 on failure @@ -108,8 +106,7 @@ GNUNET_CREDENTIAL_delegation_set_serialize (unsigned int d_count, * @param len size of the serialized delegation chain and cred * @param src the serialized data * @param d_count the number of delegation chain entries - * @param dd where to put the delegation chain entries - * @param cd where to put the credential data + * @param dsr where to put the delegation chain entries * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int diff --git a/src/credential/gnunet-credential.c b/src/credential/gnunet-credential.c index 4a6dc5ccd..03f959b95 100644 --- a/src/credential/gnunet-credential.c +++ b/src/credential/gnunet-credential.c @@ -20,7 +20,7 @@ /** * @file gnunet-credential.c * @brief command line tool to access command line Credential service - * @author Adnan Husain + * @author Martin Schanzenbach */ #include "platform.h" #include @@ -158,13 +158,6 @@ do_timeout (void *cls) GNUNET_SCHEDULER_shutdown (); } -/** - * Function called with the result of a Credential lookup. - * - * @param cls the 'const char *' name that was resolved - * @param cd_count number of records returned - * @param cd array of @a cd_count records with the results - */ static void handle_collect_result (void *cls, unsigned int d_count, @@ -192,13 +185,6 @@ handle_collect_result (void *cls, } -/** - * Function called with the result of a Credential lookup. - * - * @param cls the 'const char *' name that was resolved - * @param cd_count number of records returned - * @param cd array of @a cd_count records with the results - */ static void handle_verify_result (void *cls, unsigned int d_count, diff --git a/src/credential/gnunet-service-credential.c b/src/credential/gnunet-service-credential.c index be75e485e..be88839e9 100644 --- a/src/credential/gnunet-service-credential.c +++ b/src/credential/gnunet-service-credential.c @@ -18,9 +18,9 @@ Boston, MA 02110-1301, USA. */ /** - * @file gns/gnunet-service-credential.c - * @brief GNU Credential Service (main service) - * @author Adnan Husain + * @file credential/gnunet-service-credential.c + * @brief GNUnet Credential Service (main service) + * @author Martin Schanzenbach */ #include "platform.h" #include "gnunet_util_lib.h" @@ -377,16 +377,11 @@ cleanup_delegation_set (struct DelegationSetQueueEntry *ds_entry) } GNUNET_free (dq_entry); } - if (NULL != ds_entry->issuer_key) - GNUNET_free (ds_entry->issuer_key); - if (NULL != ds_entry->lookup_attribute) - GNUNET_free (ds_entry->lookup_attribute); - if (NULL != ds_entry->issuer_attribute) - GNUNET_free (ds_entry->issuer_attribute); - if (NULL != ds_entry->unresolved_attribute_delegation) - GNUNET_free (ds_entry->unresolved_attribute_delegation); - if (NULL != ds_entry->attr_trailer) - GNUNET_free (ds_entry->attr_trailer); + GNUNET_free_non_null (ds_entry->issuer_key); + GNUNET_free_non_null (ds_entry->lookup_attribute); + GNUNET_free_non_null (ds_entry->issuer_attribute); + GNUNET_free_non_null (ds_entry->unresolved_attribute_delegation); + GNUNET_free_non_null (ds_entry->attr_trailer); if (NULL != ds_entry->lookup_request) { GNUNET_GNS_lookup_cancel (ds_entry->lookup_request); @@ -394,10 +389,8 @@ cleanup_delegation_set (struct DelegationSetQueueEntry *ds_entry) } if (NULL != ds_entry->delegation_chain_entry) { - if (NULL != ds_entry->delegation_chain_entry->subject_attribute) - GNUNET_free (ds_entry->delegation_chain_entry->subject_attribute); - if (NULL != ds_entry->delegation_chain_entry->issuer_attribute) - GNUNET_free (ds_entry->delegation_chain_entry->issuer_attribute); + GNUNET_free_non_null (ds_entry->delegation_chain_entry->subject_attribute); + GNUNET_free_non_null (ds_entry->delegation_chain_entry->issuer_attribute); GNUNET_free (ds_entry->delegation_chain_entry); } GNUNET_free (ds_entry); @@ -415,8 +408,7 @@ cleanup_handle (struct VerifyRequestHandle *vrh) vrh->lookup_request = NULL; } cleanup_delegation_set (vrh->root_set); - if (NULL != vrh->issuer_attribute) - GNUNET_free (vrh->issuer_attribute); + GNUNET_free_non_null (vrh->issuer_attribute); for (cr_entry = vrh->cred_chain_head; NULL != vrh->cred_chain_head; cr_entry = vrh->cred_chain_head) @@ -424,19 +416,12 @@ cleanup_handle (struct VerifyRequestHandle *vrh) GNUNET_CONTAINER_DLL_remove (vrh->cred_chain_head, vrh->cred_chain_tail, cr_entry); - if (NULL != cr_entry->credential); - GNUNET_free (cr_entry->credential); + GNUNET_free_non_null (cr_entry->credential); GNUNET_free (cr_entry); } GNUNET_free (vrh); } -/** - * Task run during shutdown. - * - * @param cls unused - * @param tc unused - */ static void shutdown_task (void *cls) { @@ -475,11 +460,6 @@ shutdown_task (void *cls) -/** - * Send. - * - * @param handle the handle to the request - */ static void send_lookup_response (struct VerifyRequestHandle *vrh) { @@ -491,12 +471,11 @@ send_lookup_response (struct VerifyRequestHandle *vrh) struct CredentialRecordEntry *cd; struct CredentialRecordEntry *tmp; size_t size; - int i; GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending response\n"); dce = vrh->delegation_chain_head; - for (i=0;idelegation_chain_size;i++) + for (uint32_t i=0;idelegation_chain_size;i++) { dd[i].issuer_key = dce->issuer_key; dd[i].subject_key = dce->subject_key; @@ -537,7 +516,7 @@ send_lookup_response (struct VerifyRequestHandle *vrh) * Append at the end of rmsg */ cd = vrh->cred_chain_head; - for (i=0;icred_chain_size;i++) + for (uint32_t i=0;icred_chain_size;i++) { cred[i].issuer_key = cd->credential->issuer_key; cred[i].subject_key = cd->credential->subject_key; @@ -598,8 +577,6 @@ backward_resolution (void* cls, struct DelegationQueueEntry *dq_entry; char *expanded_attr; char *lookup_attribute; - int i; - int j; current_set = cls; @@ -610,7 +587,7 @@ backward_resolution (void* cls, "Got %d attrs\n", rd_count); // Each OR - for (i=0; i < rd_count; i++) + for (uint32_t i=0; i < rd_count; i++) { if (GNUNET_GNSRECORD_TYPE_ATTRIBUTE != rd[i].record_type) continue; @@ -637,7 +614,7 @@ backward_resolution (void* cls, current_set->queue_entries_tail, dq_entry); // Each AND - for (j=0; jset_count); j++) + for (uint32_t j=0; jset_count); j++) { ds_entry = GNUNET_new (struct DelegationSetQueueEntry); if (NULL != current_set->attr_trailer) @@ -793,8 +770,6 @@ backward_resolution (void* cls, * Result from GNS lookup. * * @param cls the closure (our client lookup handle) - * @param rd_count the number of records in @a rd - * @param rd the record data */ static void delegation_chain_resolution_start (void* cls) @@ -858,13 +833,6 @@ delegation_chain_resolution_start (void* cls) ds_entry); } -/** - * Checks a #GNUNET_MESSAGE_TYPE_CREDENTIAL_VERIFY message - * - * @param cls client sending the message - * @param v_msg message of type `struct VerifyMessage` - * @return #GNUNET_OK if @a v_msg is well-formed - */ static int check_verify (void *cls, const struct VerifyMessage *v_msg) @@ -893,13 +861,6 @@ check_verify (void *cls, return GNUNET_OK; } -/** - * Handle Credential verification requests from client - * - * @param cls the closure - * @param client the client - * @param message the message - */ static void handle_verify (void *cls, const struct VerifyMessage *v_msg) @@ -909,7 +870,6 @@ handle_verify (void *cls, struct CredentialRecordEntry *cr_entry; uint32_t credentials_count; uint32_t credential_data_size; - int i; char attr[GNUNET_CREDENTIAL_MAX_LENGTH + 1]; char issuer_attribute[GNUNET_CREDENTIAL_MAX_LENGTH + 1]; char *attrptr = attr; @@ -958,7 +918,7 @@ handle_verify (void *cls, return; } - for (i=0;icredential = GNUNET_malloc (sizeof (struct GNUNET_CREDENTIAL_Credential) + credentials[i].issuer_attribute_len); @@ -979,9 +939,6 @@ handle_verify (void *cls, } -/** - * We encountered an error while collecting - */ static void handle_cred_collection_error_cb (void *cls) { @@ -1001,9 +958,6 @@ collect_next (void *cls) GNUNET_NAMESTORE_zone_iterator_next (vrh->cred_collection_iter); } -/** - * Store credential - */ static void handle_cred_collection_cb (void *cls, const struct GNUNET_CRYPTO_EcdsaPrivateKey *key, @@ -1015,10 +969,9 @@ handle_cred_collection_cb (void *cls, struct GNUNET_CREDENTIAL_Credential *crd; struct CredentialRecordEntry *cr_entry; int cred_record_count; - int i; cred_record_count = 0; - for (i=0; i < rd_count; i++) + for (uint32_t i=0; i < rd_count; i++) { if (GNUNET_GNSRECORD_TYPE_CREDENTIAL != rd[i].record_type) continue; @@ -1042,9 +995,6 @@ handle_cred_collection_cb (void *cls, vrh); } -/** - * We encountered an error while collecting - */ static void handle_cred_collection_finished_cb (void *cls) { @@ -1055,13 +1005,6 @@ handle_cred_collection_finished_cb (void *cls) delegation_chain_resolution_start (vrh); } -/** - * Handle Credential collection requests from client - * - * @param cls the closure - * @param client the client - * @param message the message - */ static void handle_collect (void *cls, const struct CollectMessage *c_msg) @@ -1113,13 +1056,6 @@ handle_collect (void *cls, } -/** - * Checks a #GNUNET_MESSAGE_TYPE_CREDENTIAL_COLLECT message - * - * @param cls client sending the message - * @param v_msg message of type `struct CollectMessage` - * @return #GNUNET_OK if @a v_msg is well-formed - */ static int check_collect (void *cls, const struct CollectMessage *c_msg) @@ -1149,12 +1085,6 @@ check_collect (void *cls, return GNUNET_OK; } -/** - * One of our clients disconnected, clean up after it. - * - * @param cls NULL - * @param client the client that disconnected - */ static void client_disconnect_cb (void *cls, struct GNUNET_SERVICE_Client *client, @@ -1165,14 +1095,6 @@ client_disconnect_cb (void *cls, client); } -/** - * Add a client to our list of active clients. - * - * @param cls NULL - * @param client client to add - * @param mq message queue for @a client - * @return this client - */ static void * client_connect_cb (void *cls, struct GNUNET_SERVICE_Client *client, @@ -1188,8 +1110,8 @@ client_connect_cb (void *cls, * Process Credential requests. * * @param cls closure - * @param server the initialized server * @param c configuration to use + * @param handle service handle */ static void run (void *cls, diff --git a/src/credential/plugin_gnsrecord_credential.c b/src/credential/plugin_gnsrecord_credential.c index 72d6b53f5..342790b7a 100644 --- a/src/credential/plugin_gnsrecord_credential.c +++ b/src/credential/plugin_gnsrecord_credential.c @@ -21,7 +21,7 @@ /** * @file credential/plugin_gnsrecord_credential.c * @brief gnsrecord plugin to provide the API for CREDENTIAL records - * @author Adnan Husain + * @author Martin Schanzenbach */ #include "platform.h" diff --git a/src/credential/plugin_rest_credential.c b/src/credential/plugin_rest_credential.c index 48d48fba0..480658822 100644 --- a/src/credential/plugin_rest_credential.c +++ b/src/credential/plugin_rest_credential.c @@ -19,7 +19,7 @@ */ /** * @author Martin Schanzenbach - * @file gns/plugin_rest_credential.c + * @file credential/plugin_rest_credential.c * @brief GNUnet CREDENTIAL REST plugin * */ @@ -194,12 +194,6 @@ cleanup_handle (struct RequestHandle *handle) } -/** - * Task run on shutdown. Cleans up everything. - * - * @param cls unused - * @param tc scheduler context - */ static void do_error (void *cls) { @@ -213,7 +207,8 @@ do_error (void *cls) /** * Attribute delegation to JSON - * @param attr the attribute + * + * @param delegation_chain_entry the DSE * @return JSON, NULL if failed */ static json_t* @@ -257,6 +252,7 @@ attribute_delegation_to_json (struct GNUNET_CREDENTIAL_Delegation *delegation_ch /** * JSONAPI resource to Credential + * * @param res the JSONAPI resource * @return the resulting credential, NULL if failed */ @@ -327,6 +323,7 @@ json_to_credential (json_t *res) /** * Credential to JSON + * * @param cred the credential * @return the resulting json, NULL if failed */ @@ -373,13 +370,6 @@ credential_to_json (struct GNUNET_CREDENTIAL_Credential *cred) return cred_obj; } -/** - * Function called with the result of a Credential lookup. - * - * @param cls the 'const char *' name that was resolved - * @param cd_count number of records returned - * @param cd array of @a cd_count records with the results - */ static void handle_collect_response (void *cls, unsigned int d_count, @@ -470,13 +460,6 @@ subject_ego_lookup (void *cls, -/** - * Function called with the result of a Credential lookup. - * - * @param cls the 'const char *' name that was resolved - * @param cd_count number of records returned - * @param cd array of @a cd_count records with the results - */ static void handle_verify_response (void *cls, unsigned int d_count, @@ -1062,11 +1045,6 @@ issue_cred_cont (struct GNUNET_REST_RequestHandle *conndata_handle, handle); } -/** - * Handle rest request - * - * @param handle the lookup handle - */ static void options_cont (struct GNUNET_REST_RequestHandle *con_handle, const char* url, @@ -1087,17 +1065,6 @@ options_cont (struct GNUNET_REST_RequestHandle *con_handle, } -/** - * Function processing the REST call - * - * @param method HTTP method - * @param url URL of the HTTP request - * @param data body of the HTTP request (optional) - * @param data_size length of the body - * @param proc callback function for the result - * @param proc_cls closure for callback function - * @return GNUNET_OK if request accepted - */ static void rest_credential_process_request(struct GNUNET_REST_RequestHandle *conndata_handle, GNUNET_REST_ResultProcessor proc, -- cgit v1.2.3