[asterisk-scf-commits] asterisk-scf/integration/slice.git branch "client-auth" updated.

[Commits to the Asterisk SCF project code repositories]

branch "client-auth" has been updated
       via  1312c9c9d0f4c97f96f09a1291f6fe86710efda9 (commit)
      from  1b7505e4fffb20d625ee87a9fc4609ac342d97c1 (commit)

Summary of changes:
 slice/AsteriskSCF/SIP/SIPExtensionPointIf.ice |   20 +++++++++++++++++++-
 1 files changed, 19 insertions(+), 1 deletions(-)


- Log -----------------------------------------------------------------
commit 1312c9c9d0f4c97f96f09a1291f6fe86710efda9
Author: Mark Michelson <mmichelson at digium.com>
Date:   Tue Sep 6 18:42:24 2011 -0500

    Add documentation and a member name change for consistency.

diff --git a/slice/AsteriskSCF/SIP/SIPExtensionPointIf.ice b/slice/AsteriskSCF/SIP/SIPExtensionPointIf.ice
index 06ef9be..9b96c5e 100644
--- a/slice/AsteriskSCF/SIP/SIPExtensionPointIf.ice
+++ b/slice/AsteriskSCF/SIP/SIPExtensionPointIf.ice
@@ -169,10 +169,16 @@ module V1
 
     sequence<DigestChallenge> DigestChallengeSeq;
 
+    /**
+     * Client authentication structure.
+     * 
+     * This contains the data Asterisk SCF needs in order
+     * to create an authentication response
+     */
     struct ClientAuth
     {
         string realm;
-        string user;
+        string username;
         string password;
     };
 
@@ -180,10 +186,22 @@ module V1
 
     interface AuthHook
     {
+        /**
+         * Called when Asterisk SCF is a UAS. This is used to formulate the
+         * authentication challenge (i.e. WWW-Authenticate header) that Asterisk
+         * SCF will send to the UAC
+         */
 	    AsteriskSCF::System::Hook::V1::HookResult challengeRequest(RequestInfo info, out DigestChallengeSeq challenges);
+        /**
+         * Called when Asterisk SCF is a UAC. This is used to formulate the
+         * authentication response (i.e. Authorization header) that Asterisk
+         * SCF will send to the UAS that has sent an authentication challenge
+         */
         AsteriskSCF::System::Hook::V1::HookResult getCredentials(string endpointName, Ice::StringSeq realms, out ClientAuthSeq auths);
     };
 
+    sequence<AuthHook*> AuthHookSeq;
+
     enum RequestType
     {
 	// Examples of 'Dialog Establishing' requests include (but are not limited to):

-----------------------------------------------------------------------


-- 
asterisk-scf/integration/slice.git