Fix a doc comment.

[libradsec.git] / lib / include / radsec / request.h

diff --git a/lib/include/radsec/request.h b/lib/include/radsec/request.h
index ef422b5..f0151f8 100644 (file)
--- a/lib/include/radsec/request.h
+++ b/lib/include/radsec/request.h
@@ -1,7 +1,10 @@
 /** \file request.h
     \brief Public interface for libradsec request's.  */
 
-/* See the file COPYING for licensing information.  */
+/* See LICENSE for licensing information.  */
+
+#ifndef _RADSEC_REQUEST_H_
+#define _RADSEC_REQUEST_H_ 1
 
 struct rs_request;
 
@@ -11,29 +14,39 @@ extern "C" {
 
 /** Create a request associated with connection \a conn.  */
 int rs_request_create(struct rs_connection *conn, struct rs_request **req_out);
-/** Add RADIUS request message \a req_msg to request \a req.  */
+
+/** Add RADIUS request message \a req_msg to request \a req.
+    FIXME: Rename to rs_request_add_reqmsg?  */
 void rs_request_add_reqpkt(struct rs_request *req, struct rs_packet *req_msg);
 
 /** Create a request associated with connection \a conn containing a
-    RADIUS authentication message with \a user_name and \a user_pw
-    attributes.  \a user_name and _user_pw are optional and can be
-    NULL.  */
+    newly created RADIUS authentication message, possibly with
+    \a user_name and \a user_pw attributes.  \a user_name and \a user_pw
+    are optional and can be NULL. If \a user_name and \a user_pw are provided,
+    \a secret must also be provided. \a secret is used for "hiding" the
+    password. */
 int rs_request_create_authn(struct rs_connection *conn,
                            struct rs_request **req_out,
                            const char *user_name,
-                           const char *user_pw);
+                           const char *user_pw,
+                            const char *secret);
+
 /** Send request \a req and wait for a matching response.  The
     response is put in \a resp_msg (if not NULL).  NOTE: At present,
     no more than one outstanding request to a given realm is
     supported.  This will change in a future version.  */
 int rs_request_send(struct rs_request *req, struct rs_packet **resp_msg);
 
-/** Free all memory allocated by request \a req including the request
-    packet and any response package associated with the request.  Note
-    that a request must be freed before its associated connection can
-    be freed.  */
+/** Free all memory allocated by request \a req including any request
+    packet associated with the request.  Note that a request must be
+    freed before its associated connection can be freed.  */
 void rs_request_destroy(struct rs_request *req);
 
+/** Return request message in request \a req.  */
+struct rs_packet *rs_request_get_reqmsg(const struct rs_request *req);
+
 #if defined (__cplusplus)
 }
 #endif
+
+#endif /* _RADSEC_REQUEST_H_ */