Changeset 1877 for pjproject/trunk/pjnath/include/pjnath/stun_session.h

Timestamp:

Mar 19, 2008 11:00:30 PM (16 years ago)

Author:

bennylp

Message:

Related to ticket #485: huge changeset to update STUN relating to managing authentication. See the ticket for the details

File:

• pjproject/trunk/pjnath/include/pjnath/stun_session.h (modified) (10 diffs)

pjproject/trunk/pjnath/include/pjnath/stun_session.h

@@ -46 +46 @@
 /** Forward declaration for pj_stun_tx_data */
 typedef struct pj_stun_tx_data pj_stun_tx_data;
+
+/** Forward declaration for pj_stun_rx_data */
+typedef struct pj_stun_rx_data pj_stun_rx_data;
 
 /** Forward declaration for pj_stun_session */
@@ -86 +89 @@
      * @param pkt           Pointer to the original STUN packet.
      * @param pkt_len       Length of the STUN packet.
-     * @param msg           The parsed STUN request.
+     * @param rdata         Data containing incoming request message.
      * @param src_addr      Source address of the packet.
      * @param src_addr_len  Length of the source address.
@@ -97 +100 @@
                                  const pj_uint8_t *pkt,
                                  unsigned pkt_len,
-                                 const pj_stun_msg *msg,
+                                 const pj_stun_rx_data *rdata,
                                  const pj_sockaddr_t *src_addr,
                                  unsigned src_addr_len);
@@ -145 +148 @@
 
 /**
+ * This structure describes incoming request message.
+ */
+struct pj_stun_rx_data
+{
+    /**
+     * The parsed request message.
+     */
+    pj_stun_msg             *msg;
+
+    /**
+     * Credential information that is found and used to authenticate 
+     * incoming request. Application may use this information when 
+     * generating  authentication for the outgoing response.
+     */
+    pj_stun_req_cred_info   info;
+};
+
+
+/**
  * This structure describe the outgoing STUN transmit data to carry the
  * message to be sent.
@@ -162 +184 @@
     pj_uint8_t           msg_key[12];   /**< Message/transaction key.       */
 
-    pj_str_t             auth_key;      /**< Auth key.                      */
+    pj_stun_req_cred_info auth_info;    /**< Credential info                */
 
     void                *pkt;           /**< The STUN packet.               */
@@ -260 +282 @@
  *
  * @param sess      The STUN session instance.
+ * @param auth_type Type of authentication.
  * @param cred      The credential to be used by this session. If NULL
  *                  is specified, authentication will be disabled.
@@ -265 +288 @@
  * @return          PJ_SUCCESS on success, or the appropriate error code.
  */
-PJ_DECL(void) pj_stun_session_set_credential(pj_stun_session *sess,
-                                             const pj_stun_auth_cred *cred);
+PJ_DECL(pj_status_t) pj_stun_session_set_credential(pj_stun_session *sess,
+                                                pj_stun_auth_type auth_type,
+                                                const pj_stun_auth_cred *cred);
 
 /**
@@ -329 +353 @@
  */
 PJ_DECL(pj_status_t) pj_stun_session_create_res(pj_stun_session *sess,
-                                                const pj_stun_msg *req,
+                                                const pj_stun_rx_data *rdata,
                                                 unsigned err_code,
                                                 const pj_str_t *err_msg,
@@ -363 +387 @@
  *
  * @param sess      The STUN session instance.
- * @param req       The STUN request message to be responded.
+ * @param rdata     The STUN request message to be responded.
  * @param err_code  Error code to be set in the response, if error response
  *                  is to be created, according to pj_stun_status enumeration.
@@ -383 +407 @@
  */
 PJ_DECL(pj_status_t) pj_stun_session_respond(pj_stun_session *sess, 
-                                             const pj_stun_msg *req,
+                                             const pj_stun_rx_data *rdata,
                                              unsigned code, 
                                              const char *err_msg,