IssueVision与TaskVision 使用技术比较--XML Web services自定义身份验证数据

本菜鸟目前对Microsoft SmartClient技术非常感兴趣，最近仔细分析了Microsoft编写的IssueVision和TaskVision 这两个SmartClient Demo，个人感觉上才开始接触SmartClient的朋友最好先分析TaskVision，在有一定的基础上在分析IssueVision。这样学习效果可能比较好。为了让才开始接触SmartClinet的朋友少走些弯路，同时也为了与学习Microsoft SmartClient技术的朋友更好的进行技术交流，本菜鸟将把这几个星期IssuesVision和TaskVision的学习心得与各位同行进行分享。

     当客户端调用XML Web services时，为了安全因素，通常会要求客户端进行身份验证，只有通过身份验证才有权限调用XML Web services 提供的方法。IssueVision使用SoapHeader传递XML Web services 自定义身份验证数据。TaskVision使用FormsAuthenticationTicket的 Forms 身份验证 cookie（包含身份验票）来获取调用XML Web services方法的权限。下面将对这两种XML Web services自定义身份验证数据的方法进行详细的讲解。

 

   SoapHeader传递XML Web services 自定义身份验证数据

SOAP 标头提供了一种方法，用于将数据传递到 XML Web services 方法或从XML Web services 方法传递数据，条件是该数据不直接与XML Web services 方法的主功能相关。例如，一个XML Web servicess 可能包含若干个XML Web services 方法，而每个方法都需要自定义的身份验证方案。您不用将参数添加到每个需要自定义身份验证方案的XML Web services 方法，而可以将引用从SoapHeader派生的类的 SoapHeaderAttribute 应用于每个XML Web services 方法。从SoapHeader派生的类的实现处理该自定义身份验证方案。按照此方式， XML Web services 方法使用 SOAP 标头来仅实现特定于它的功能并添加其他功能。 IssueVision 就是利用SoapHeader的这种能力来实现XML Web services自定义身份验证数据传递。

IssueVision如何利用SoapHeader传递数据进行WebService自定义身份验证数据：

     1：创建从SoapHeader派生的类，表示传入 SOAP 标头的数据。

[IssueVision解决方案中IssueVisionWebCS项目的CredentialSoapHeader类实现]

 

                     using System.Web.Services.Protocols;

                     namespace IssueVision.Web
                     {
                           public class CredentialSoapHeader : SoapHeader
                           {
                                 private string m_username;
                                private string m_password;

                                public string Username
                                {
                                      get{ return m_username;}

                                       set{ m_username = value;}
                                 }

                                 public string Password
                                 {
                                       get{ return m_password;}
                                      set{ m_password = value;}
                                 }
                          }
                    }

         2： 将CredentialSoapHeader类一个成员添加到实现XML Web servicess 的类或 XML Web servicess 客户端代理类。

                  [IssueVision解决方案中IssueVisionWebCS项目的IssueVisionServices类实现]

 

                            Namespace IssueVision.Web
                     {
                           public class IssueVisionServices : Web Service
                           {
                                private CredentialSoapHeader m_credentials
                               public CredentialSoapHeader Credentials
                               {
                                    get{ return m_credentials;}
                                    set{ m_credentials = value;}
                               }

                   … …
                            }
                     }

 

         3：将 SoapHeaderAttribute 应用于 XML Web services 方法或代理类中的对应方法

            [IssueVision解决方案中IssueVisionWebCS项目的IssueVisionServices类实现]

 

                     Namespace IssueVision.Web
                     {
                           public class IssueVisionServices : Web Service
                           {
                        … …

                                   [WebMethod(Description="Returns the lookup tables for IssueVision.")]

                                   [SoapHeader(“Credentials”)]

                                   public IVDataSet GetLookupTables()

                                   {

                                          SecurityHelper.VerifyCredentials(this);

                                          return new IVData().GetLookupTables();

                                   }
                           }
                     }

 

         4：在客户端代码中调用XML Web services方法前，要求在代理类中设置SOAP标头。

         [IssueVision解决方案中IssueVision项目的WebServicesLayer类调用XML Web services方法并在代理类中设置SOAP标头]

 

                   Namespace IssueVision.Web
              {
                     private static IssueVisionServices GetWebServiceReference(string username, string password)

                     {

                            IssueVisionServices dataService = new IssueVisionServices();

                            //<ReplaceWithWse>

                            CredentialSoapHeader header = new CredentialSoapHeader();

                            header.Username = username;

                            header.Password = password;

                            dataService.CredentialSoapHeaderValue = header;

                            //</ReplaceWithWse>

                    

                            InitWebServiceProxy(dataService);

                    

                            return dataService;

           }

 

                     public static IVDataSet GetLookupTables()

                     {

                            IVDataSet data = null;

                            IssueVisionServices dataService = GetWebServiceReference();

                    

                            try

                            {

                                   data = dataService.GetLookupTables();

               }

               … …

                     }
              }

 

 

 

 

    FormsAuthenticationTicket的 Forms 身份验证传递XML Web services 自定义身份验证数据

    FormsAuthenticationTicket类提供一种创建 FormsAuthenticationModule 使用的 Forms 身份验证 cookie（包含身份验票）并读取其值的方法。TaskVision就是利用FormsAuthenticationTicket来实现XML Web services自定义身份验证数据传递。

TaskVision如何利用FormAuthenticationTicket传递数据进行WebService自定义身份验证数据：

1：在 XML Web services端将客户端传入参数进行验证，验证通过，则添加新的Cache对象，并把验证的返回值加密保存在Cache中。

[TaskVision解决方案中TaskVisionWsCsVs项目的AuthService类实现]

 

     [WebMethod()]

       public string GetAuthorizationTicket(string userName, string password)

       {

              // try to authenticate the user

              string userID;

              try

              {

                     userID = SqlHelper.ExecuteScalar(dbConn, "AuthenticateUser", userName, password).ToString();

              }

              finally

              {

                     dbConn.Close();

              }

              if (userID == null)

              {

                     // The user name and password combination is not valid.

                     return null;

              }

              // create the ticket

              FormsAuthenticationTicket ticket = new FormsAuthenticationTicket(userID, false, 1);

              string encryptedTicket = FormsAuthentication.Encrypt(ticket);

              // get the ticket timeout in minutes

              AppSettingsReader configurationAppSettings = new AppSettingsReader();

              int timeout = (int) configurationAppSettings.GetValue("AuthenticationTicket.Timeout", typeof(int));

              // cache the ticket

              Context.Cache.Insert(encryptedTicket, userID, null, DateTime.Now.AddMinutes(timeout), TimeSpan.Zero);

              return encryptedTicket;

       }

 

     2：将验证值应用于 XML Web services 方法或代理类中的对应方法

[TaskVision解决方案中TaskVisionWsCsVs项目的AuthService类实现]

 

              private bool IsTicketValid(string ticket, bool IsAdminCall)

              {

                     if (ticket == null || Context.Cache[ticket] == null)

                     {

                            return false;

                     }

                     else

                     {

                            int userID = int.Parse(FormsAuthentication.Decrypt(ticket).Name);

                 … …

                     }                                   

              }

 

          [WebMethod()]

              public UserInformation UpdateUser(string ticket, UserInformation userInfo)

              {

if (!IsTicketValid(ticket, true))
return null;

             … …

           }

 

        3：客户端代码中调用XML Web services方法前，要求在代理类中设置验证值。

 

              namespace TaskVision

              {

                   public class DataLayer

                     { 

                         private string m_Ticket = null;

                         … …   

                            public DataLayerResult GetProjects()

                            {

                                   DataSetProjects ds;

                                   try

                                   {

                                          ds = m_WsData.GetProjects(m_Ticket);

                                   … …

                                   }

                       }

                 }

           }

 

         以上的就是IssueVision与TaskVision完成XML Web services自定义身份验证的两种不同的方法。