aboutsummaryrefslogtreecommitdiffstats
path: root/src/libcharon
diff options
context:
space:
mode:
authorMartin Willi <martin@revosec.ch>2011-12-20 11:25:25 +0100
committerMartin Willi <martin@revosec.ch>2012-03-20 17:31:28 +0100
commit87791f7538cfe3e138acb6528157b41e3f1872b0 (patch)
treed312f713ae7c43485a8207b7219ef8071fb5218a /src/libcharon
parent28e3c6595dd888166efe4bcab92fe6ae0d7603bd (diff)
downloadstrongswan-87791f7538cfe3e138acb6528157b41e3f1872b0.tar.bz2
strongswan-87791f7538cfe3e138acb6528157b41e3f1872b0.tar.xz
Added description for the xauth-eap plugin
Diffstat (limited to 'src/libcharon')
-rw-r--r--src/libcharon/plugins/xauth_eap/xauth_eap.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/src/libcharon/plugins/xauth_eap/xauth_eap.h b/src/libcharon/plugins/xauth_eap/xauth_eap.h
index 655e057e7..70927247e 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_ @}*/