Changeset 1089 for pjproject/trunk/pjnath/include/pjnath/stun_auth.h

Timestamp:

Mar 20, 2007 10:36:54 PM (17 years ago)

Author:

bennylp

Message:

Today's work

File:

• pjproject/trunk/pjnath/include/pjnath/stun_auth.h (modified) (4 diffs)

pjproject/trunk/pjnath/include/pjnath/stun_auth.h

@@ -156 +156 @@
 
             /**
+             * Get the credential to be put in outgoing message.
+             *
+             * @param msg       The outgoing message where the credential is
+             *                  to be applied.
+             * @param user_data The user data as specified in the credential.
+             * @param pool      Pool where the callback can allocate memory
+             *                  to fill in the credential.
+             * @param realm     On return, the callback may specify the realm
+             *                  if long term credential is desired, otherwise
+             *                  this string must be set to empty.
+             * @param username  On return, the callback must fill in with the
+             *                  username.
+             * @param nonce     On return, the callback may optionally fill in
+             *                  this argument with NONCE value if desired,
+             *                  otherwise this argument must be set to empty.
+             * @param data_type On return, the callback must set this argument
+             *                  with the type of password in the data argument.
+             * @param data      On return, the callback must set this with
+             *                  the password, encoded according to data_type
+             *                  argument.
+             *
+             * @return          The callback must return PJ_SUCCESS, otherwise
+             *                  the message transmission will be cancelled.
+             */
+            pj_status_t (*get_cred)(const pj_stun_msg *msg,
+                                    void *user_data,
+                                    pj_pool_t *pool,
+                                    pj_str_t *realm,
+                                    pj_str_t *username,
+                                    pj_str_t *nonce,
+                                    int *data_type,
+                                    pj_str_t *data);
+
+            /**
              * Get the password for the specified username. This function 
              * is also used to check whether the username is valid.
              *
+             * @param msg       The STUN message where the password will be
+             *                  applied to.
              * @param user_data The user data as specified in the credential.
              * @param realm     The realm as specified in the message.
@@ -176 +212 @@
              *                  username is not valid.
              */
-            pj_status_t (*get_password)(void *user_data, 
+            pj_status_t (*get_password)(const pj_stun_msg *msg,
+                                        void *user_data, 
                                         const pj_str_t *realm,
                                         const pj_str_t *username,
@@ -188 +225 @@
              * PJ_FALSE, 438 (Stale Nonce) response will be created.
              *
+             * @param msg       The STUN message where the nonce was received.
              * @param user_data The user data as specified in the credential.
              * @param realm     The realm as specified in the message.
@@ -196 +234 @@
              *                  NONCE can be accepted.
              */
-            pj_bool_t   (*verify_nonce)(void *user_data,
+            pj_bool_t   (*verify_nonce)(const pj_stun_msg *msg,
+                                        void *user_data,
                                         const pj_str_t *realm,
                                         const pj_str_t *username,