From: Martin Willi <martin@revosec.ch>
Date: Tue, 20 Dec 2011 10:25:25 +0000 (+0100)
Subject: Added description for the xauth-eap plugin
X-Git-Tag: 5.0.0~338^2~9^2~142
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=87791f7538cfe3e138acb6528157b41e3f1872b0;p=thirdparty%2Fstrongswan.git

Added description for the xauth-eap plugin
---

diff --git a/src/libcharon/plugins/xauth_eap/xauth_eap.h b/src/libcharon/plugins/xauth_eap/xauth_eap.h
index 655e057e7c..70927247ed 100644
--- a/src/libcharon/plugins/xauth_eap/xauth_eap.h
+++ b/src/libcharon/plugins/xauth_eap/xauth_eap.h
@@ -26,7 +26,13 @@ typedef struct xauth_eap_t xauth_eap_t;
 #include <sa/xauth/xauth_method.h>
 
 /**
- * XAuth methods that verifies XAuth credentials using EAP methods.
+ * XAuth method that verifies XAuth credentials using EAP methods.
+ *
+ * To reuse existing authentication infrastructure, this XAuth method uses
+ * EAP to verify XAuth Username/Passwords. It is primarily designed to work
+ * with the EAP-RADIUS backend and can use any password-based EAP method
+ * over it. The credentials are fed locally on the IKE responder to a EAP
+ * client which talks to the backend instance, usually a RADIUS server.
  */
 struct xauth_eap_t {
 
@@ -46,4 +52,4 @@ struct xauth_eap_t {
 xauth_eap_t *xauth_eap_create_server(identification_t *server,
 									 identification_t *peer);
 
-#endif /** xauth_eap_H_ @}*/
+#endif /** XAUTH_EAP_H_ @}*/