]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
doxygen fixes
authorAlan T. DeKok <aland@freeradius.org>
Fri, 27 Sep 2019 15:46:38 +0000 (11:46 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Fri, 27 Sep 2019 15:46:38 +0000 (11:46 -0400)
16 files changed:
src/lib/eap/tls.c
src/lib/eap_aka_sim/attrs.h
src/lib/eap_aka_sim/base.c
src/lib/eap_aka_sim/base.h
src/lib/eap_aka_sim/crypto.c
src/lib/eap_aka_sim/decode.c
src/lib/eap_aka_sim/encode.c
src/lib/eap_aka_sim/fips186prf.c
src/lib/eap_aka_sim/id.c
src/lib/eap_aka_sim/id.h
src/lib/eap_aka_sim/state_machine.c
src/lib/eap_aka_sim/vector.c
src/lib/eap_aka_sim/xlat.c
src/lib/sim/base.h
src/lib/sim/milenage.c
src/lib/sim/milenage.h

index ea03548f83a75f5381ba81f83c1a95b5e40697aa..6ce62bb0cc482ff46959b0550e458bc0fff8f991 100644 (file)
@@ -389,7 +389,8 @@ int eap_tls_fail(REQUEST *request, eap_session_t *eap_session)
  * field **ONLY** in First packet of a fragment series. We do not use it anywhere
  * else.
  *
- * @param eap_session that's continuing.
+ * @param request      the request
+ * @param eap_session  that's continuing.
  * @return
  *     - 0 on success.
  *     - -1 on failure.
@@ -566,7 +567,7 @@ static eap_tls_status_t eap_tls_session_status(REQUEST *request, eap_session_t *
  * @note In the received packet, No data will be present incase of ACK or NAK
  *     in this case the packet->data pointer will be NULL.
  *
- * @parma[in] request          the current subrequest.
+ * @param[in] request          the current subrequest.
  * @param[in] eap_session      the current EAP session state.
  * @return
  *     - EAP_TLS_INVALID if the TLS record or progression is invalid.
@@ -817,7 +818,7 @@ ignore_length:
 
 /** Continue with the handshake
  *
- * @parma[in] request          the current subrequest.
+ * @param[in] request          the current subrequest.
  * @param[in] eap_session      to continue.
  * @return
  *     - EAP_TLS_FAIL if the message is invalid.
@@ -892,7 +893,8 @@ static eap_tls_status_t eap_tls_handshake(REQUEST *request, eap_session_t *eap_s
  * session object SHOULD be maintained even after the session is completed, for session
  * resumption.
  *
- * @param eap_session to continue.
+ * @param request      the request
+ * @param eap_session  to continue.
  * @return
  *     - EAP_TLS_ESTABLISHED
  *     - EAP_TLS_HANDLED
index 5e9c4d31b19ef191c5ab07e8c51927af7b9995d0..f7f4f00faf617421c53db206c88d5f02160d91ca 100644 (file)
  */
 
 /**
- * @file src/lib/aka-sim/attrs.h
+ * @file src/lib/eap_aka_sim/attrs.h
  * @brief Attributes to EAP-SIM/AKA/AKA' clients and servers.
  *
  * @copyright 2003-2016 The FreeRADIUS server project
  */
 #include <freeradius-devel/server/rad_assert.h>
 #include <freeradius-devel/util/dict.h>
-#include <freeradius-devel/protocol/eap/aka-sim/dictionary.h>
-#include <freeradius-devel/protocol/eap/aka-sim/rfc4187.h>
-#include <freeradius-devel/protocol/eap/aka-sim/dictionary.h>
-#include <freeradius-devel/protocol/eap/aka-sim/rfc4187.h>
-#include <freeradius-devel/protocol/eap/aka-sim/freeradius.h>
+#include <freeradius-devel/protocol/eap/eap_aka_sim/dictionary.h>
+#include <freeradius-devel/protocol/eap/eap_aka_sim/rfc4187.h>
+#include <freeradius-devel/protocol/eap/eap_aka_sim/dictionary.h>
+#include <freeradius-devel/protocol/eap/eap_aka_sim/rfc4187.h>
+#include <freeradius-devel/protocol/eap/eap_aka_sim/freeradius.h>
 
 extern fr_dict_t *dict_freeradius;
 extern fr_dict_t *dict_radius;
index 04b7997f18f29c37b638458b11eb81208425ef98..f0de7e7de1d22e00b7966af7a68fb96f55cbc9eb 100644 (file)
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file src/lib/aka-sim/base.c
+ * @file  src/lib/eap_aka_sim/base.c
  * @brief Code common to EAP-SIM/AKA/AKA' clients and servers.
  *
  * The development of the EAP-SIM support was funded by Internet Foundation
index 61dc6e735926a9c3fd952dcd7dd268be04140c2b..d89c5fefb391c75fde16d5c59578614ea47fbd4b 100644 (file)
@@ -17,7 +17,7 @@
 
 /**
  * $Id$
- * @file src/lib/aka-sim/base.h
+ * @file src/lib/eap_aka_sim/base.h
  * @brief Functions common to SIM protocols (EAP-SIM/EAP-AKA/EAP-AKA')
  *
  * The development of the EAP/SIM support was funded by Internet Foundation
index 951466ad1a49b4e48c314848233cf441d384aa0d..7738769fd23edd9237525732cdee06d68df9dfd5 100644 (file)
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file src/lib/aka-sim/crypto.c
+ * @file src/lib/eap_aka_sim/crypto.c
  * @brief Calculate keys from GSM vectors.
  *
  * The development of the original EAP/SIM support was funded by Internet Foundation
@@ -33,7 +33,7 @@ RCSID("$Id$")
 #include <stdio.h>
 #include <stdlib.h>
 
-#include <freeradius-devel/protocol/eap/aka-sim/dictionary.h>
+#include <freeradius-devel/protocol/eap/eap_aka_sim/dictionary.h>
 
 #include <freeradius-devel/eap/types.h>
 #include <freeradius-devel/sim/common.h>
@@ -920,7 +920,7 @@ void fr_aka_sim_crypto_keys_init_umts_kdf_1_reauth(fr_aka_sim_keys_t *keys,
  *
  * Derives new MSK, EMSK, k_aut, k_encr
  *
- * Use #fr_aka_sim_crypto_keys_init_reauth to populate the #fr_aka_sim_keys_t structure.
+ * Use #fr_aka_sim_crypto_keys_init_kdf_0_reauth to populate the #fr_aka_sim_keys_t structure.
  *
  * @note expects keys to contain a populated mk, none_s and counter values.
  *
index 823deef62e50b37b456cf6cf9d6ad7018204174e..60ab18a2bc4313f75d0fd336312c2f93f2a26b43 100644 (file)
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file src/lib/aka-sim/decode.c
+ * @file src/lib/eap_aka_sim/decode.c
  * @brief Code common to EAP-SIM/AKA/AKA' clients and servers.
  *
  * The development of the EAP-SIM support was funded by Internet Foundation
index 5f283ff2e76e8bd9bbc36844031bc6b82c30ec84..3438b4d473c2a2b0ed5a8137f2672e930fa8238f 100644 (file)
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file src/lib/aka-sim/encode.c
+ * @file src/lib/eap_aka_sim/encode.c
  * @brief Code common to EAP-SIM/AKA/AKA' clients and servers.
  *
  * @copyright 2017 FreeRADIUS server project
index 173bc461410eeb084080142ac6fa3f66d523a0a9..d6eccbf563a209d4910456f59cf725abe66a4644 100644 (file)
@@ -35,7 +35,7 @@
 
 /**
  * $Id$
- * @file src/lib/aka-sim/fips186prf.c
+ * @file src/lib/eap_aka_sim/fips186prf.c
  * @brief EAP sim protocol encoders and decoders.
  *
  * The development of the EAP/SIM support was funded by Internet Foundation
index 798534f696736956ccfc95c87d053eea34a5ad60..4e121fb24415eaf6c478a35f7e353d176658973e 100644 (file)
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file src/lib/aka-sim/id.c
+ * @file src/lib/eap_aka_sim/id.c
  * @brief EAP-SIM/EAP-AKA identity detection, creation, and decyption.
  *
  * @copyright 2017 The FreeRADIUS server project
index cfbe2559e2448131de0534e2f5da735dee21c33f..f1ae24106a0df7b4b27b9de242e898d3c14a0188 100644 (file)
@@ -16,7 +16,7 @@
  */
 
 /**
- * @file src/lib/aka-sim/id.h
+ * @file src/lib/eap_aka_sim/id.h
  * @brief EAP-SIM/EAP-AKA identity detection, creation, and decyption.
  *
  * @copyright 2017 The FreeRADIUS server project
index 03514cfa5ff7100ad77840d797f72c7fe0250040..a96560e8155fb7bbf458a339c093c5f2dc524bb2 100644 (file)
@@ -625,6 +625,7 @@ done:
  *
  * @param[in] inst             of rlm_eap_aka.
  * @param[in] request          the current request.
+ * @param[in] eap_session      the EAP session
  * @param[in] state_enter      state entry function for the
  *                             state to transition to *after* the current
  *                             state.
@@ -754,6 +755,7 @@ static rlm_rcode_t pseudonym_clear_resume(void *instance, UNUSED void *thread, R
  *
  * @param[in] inst             of rlm_eap_aka.
  * @param[in] request          the current request.
+ * @param[in] eap_session      the current EAP session
  * @param[in] state_enter      state entry function for the
  *                             state to transition to *after* the current
  *                             state.
@@ -1604,6 +1606,7 @@ static rlm_rcode_t sim_challenge_request_compose(eap_aka_sim_common_conf_t *inst
  * or can't perform fast resumption, we need to request the full identity from
  * the supplicant.
  *
+ * @param[in] inst             of rlm_eap_aka.
  * @param[in] request          The current subrequest.
  * @param[in] eap_session      to continue.
  * @return
@@ -1684,6 +1687,7 @@ static rlm_rcode_t aka_identity_request_send(eap_aka_sim_common_conf_t *inst,
  * or can't perform fast resumption, we need to request the full identity from
  * the supplicant.
  *
+ * @param[in] inst             of rlm_eap_aka.
  * @param[in] request          The current subrequest.
  * @param[in] eap_session      to continue.
  * @return
index a77201b31b13483586afcfdf6a33f5d8b3c18cee..b99867cf4525594bd47de036c0bc85589e7a8fae 100644 (file)
@@ -16,7 +16,7 @@
 
 /**
  * $Id$
- * @file src/lib/aka-sim/vector.c
+ * @file src/lib/eap_aka_sim/vector.c
  * @brief Retrieve or derive vectors for EAP-SIM.
  *
  * @author Arran Cudbard-Bell (a.cudbardb@freeradius.org)
index c376d6d0101a5ad718e2bd8333a550a1a583d58b..b1195e989656ac2ef5ddada100deffc6c7ef99fc 100644 (file)
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file src/lib/aka-sim/xlat.c
+ * @file src/lib/eap_aka_sim/xlat.c
  * @brief EAP-SIM/EAP-AKA identity detection, creation, and decyption.
  *
  * @copyright 2017 The FreeRADIUS server project
index 7e8e72424739ae3095ca765fb9ebaeb1e83ca813..5e61a8e1771a556963016100330a21a0a6c054eb 100644 (file)
@@ -18,7 +18,7 @@
 /**
  * $Id$
  *
- * @file src/lib/base.h
+ * @file src/lib/sim/base.h
  * @brief Master include file for all lib/sim functions.
  *
  * @copyright 2019 The FreeRADIUS server project
index d89941479f86cce69e0d97816f2069c4c69985f3..6b62edb932288898515ed2451decf2e9f2c115c1 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * @file src/lib/aka-sim/milenage.c
+ * @file src/lib/sim/milenage.c
  * @brief 3GPP AKA - Milenage algorithm (3GPP TS 35.205, .206, .207, .208)
  *
  * This file implements an example authentication algorithm defined for 3GPP
index 809aec1fc444b5288d6b629f2d5ffbab19fc1625..f36845560f5dc2347a942386d7cfddb2026de530 100644 (file)
@@ -1,6 +1,6 @@
 #pragma once
 /**
- * @file src/lib/aka-sim/milenage.h
+ * @file src/lib/sim/milenage.h
  * @brief 3GPP AKA - Milenage algorithm (3GPP TS 35.205, .206, .207, .208)
  *
  * This file implements an example authentication algorithm defined for 3GPP