About Windows Phone 7 and SharePoint authentication

Connecting the phone to our SharePoint environment was my Christmas project, and it took me a while... In the end I managed to do it and I thought it could be a good idea to share the joy. Besides, I have read a lot of blogs about this matter all of them? and I want to add my contribution to it.

Let's go to the matter. I created a class called SPAuthBridge from the code in the SDK that can be used to set up the connections to the SharePoint server.

view plainprint?

1. using System;  
2. using System.IO;  
3. using System.Net;  
4. using System.Text;  
5.   
6. namespace PhoneUtils.Code  
7. {  
8.     public class SPAuthBridge  
9.     {  
10.         #region Properties  
11.         public CookieContainer cookieJar = new CookieContainer();  
12.   
13.         string SiteUrl, User;  
14.         string Password; //This should be securestring, but I don't think it's available in WP7  
15.         #endregion  
16.  
17.         #region Constructors  
18.         public SPAuthBridge(string SiteUrl, string User, string Password)  
19.         {  
20.             this.SiteUrl = SiteUrl;  
21.             this.User = User;  
22.             this.Password = Password;  
23.         }  
24.         #endregion  
25.  
26.         #region Public Methods  
27.         public void Authenticate()  
28.         {  
29.             try  
30.             {  
31.                 if (string.IsNullOrEmpty(SiteUrl)) throw new ArgumentOutOfRangeException("The SPAuthBridge was not properly initialized");  
32.   
33.                 System.Uri authServiceUri = new Uri(string.Format("{0}/_vti_bin/authentication.asmx", SiteUrl));  
34.   
35.                 HttpWebRequest spAuthReq = HttpWebRequest.Create(authServiceUri) as HttpWebRequest;  
36.                 spAuthReq.CookieContainer = cookieJar;  
37.                 spAuthReq.Headers["SOAPAction"] = "http://schemas.microsoft.com/sharepoint/soap/Login";  
38.                 spAuthReq.ContentType = "text/xml; charset=utf-8";  
39.                 spAuthReq.Method = "POST";  
40.   
41.                 //add the soap message to the request  
42.                 spAuthReq.BeginGetRequestStream(new AsyncCallback(spAuthReqCallBack), spAuthReq);  
43.             }  
44.             catch  
45.             {  
46.                 TriggerOnAuthenticated(false);  
47.             }  
48.         }  
49.         #endregion  
50.  
51.         #region Private Methods  
52.         private void spAuthReqCallBack(IAsyncResult asyncResult)  
53.         {  
54.             string envelope =  
55.                     @"<?xml version=""1.0"" encoding=""utf-8""?>  
56.                     <soap:Envelope xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xmlns:xsd=""http://www.w3.org/2001/XMLSchema"" xmlns:soap=""http://schemas.xmlsoap.org/soap/envelope/"">  
57.                       <soap:Body>  
58.                         <Login xmlns=""http://schemas.microsoft.com/sharepoint/soap/"">  
59.                           <username>{0}</username>  
60.                           <password>{1}</password>  
61.                         </Login>  
62.                       </soap:Body>  
63.                     </soap:Envelope>";  
64.   
65.             UTF8Encoding encoding = new UTF8Encoding();  
66.             HttpWebRequest request = (HttpWebRequest)asyncResult.AsyncState;  
67.             Stream _body = request.EndGetRequestStream(asyncResult);  
68.             envelope = string.Format(envelope, User, Password);  
69.             byte[] formBytes = encoding.GetBytes(envelope);  
70.   
71.             _body.Write(formBytes, 0, formBytes.Length);  
72.             _body.Close();  
73.   
74.             request.BeginGetResponse(new AsyncCallback(ResponseCallback), request);  
75.         }  
76.   
77.         private void ResponseCallback(IAsyncResult asyncResult)  
78.         {  
79.             try  
80.             {  
81.                 HttpWebRequest request = (HttpWebRequest)asyncResult.AsyncState;  
82.                 HttpWebResponse response = (HttpWebResponse)request.EndGetResponse(asyncResult);  
83.                 Stream content = response.GetResponseStream();  
84.   
85.                 if (request != null && response != null)  
86.                 {  
87.                     if (response.StatusCode == HttpStatusCode.OK)  
88.                     {  
89.                         using (StreamReader reader = new StreamReader(content))  
90.                         {  
91.                             //Put debugging code here  
92.                             string _responseString = reader.ReadToEnd();  
93.                             reader.Close();  
94.                         }  
95.                     }  
96.                 }  
97.   
98.                 //authentication complete  
99.                 TriggerOnAuthenticated(true);  
100.             }  
101.             catch  
102.             {  
103.                 TriggerOnAuthenticated(false);  
104.             }  
105.         }  
106.         #endregion  
107.  
108.         #region Events  
109.         public delegate void OnAuthenticatedHandler(bool Success);  
110.   
111.         public event OnAuthenticatedHandler OnAuthenticated;  
112.   
113.         protected virtual void TriggerOnAuthenticated(bool Success)  
114.         {  
115.             if (OnAuthenticated != null)  
116.                 OnAuthenticated(Success);  
117.         }  
118.         #endregion  
119.     }  
120. }  

using System;
using System.IO;
using System.Net;
using System.Text;

namespace PhoneUtils.Code
{
    public class SPAuthBridge
    {
        #region Properties
        public CookieContainer cookieJar = new CookieContainer();

        string SiteUrl, User;
        string Password; //This should be securestring, but I don't think it's available in WP7
        #endregion

        #region Constructors
        public SPAuthBridge(string SiteUrl, string User, string Password)
        {
            this.SiteUrl = SiteUrl;
            this.User = User;
            this.Password = Password;
        }
        #endregion

        #region Public Methods
        public void Authenticate()
        {
            try
            {
                if (string.IsNullOrEmpty(SiteUrl)) throw new ArgumentOutOfRangeException("The SPAuthBridge was not properly initialized");

                System.Uri authServiceUri = new Uri(string.Format("{0}/_vti_bin/authentication.asmx", SiteUrl));

                HttpWebRequest spAuthReq = HttpWebRequest.Create(authServiceUri) as HttpWebRequest;
                spAuthReq.CookieContainer = cookieJar;
                spAuthReq.Headers["SOAPAction"] = "http://schemas.microsoft.com/sharepoint/soap/Login";
                spAuthReq.ContentType = "text/xml; charset=utf-8";
                spAuthReq.Method = "POST";

                //add the soap message to the request
                spAuthReq.BeginGetRequestStream(new AsyncCallback(spAuthReqCallBack), spAuthReq);
            }
            catch
            {
                TriggerOnAuthenticated(false);
            }
        }
        #endregion

        #region Private Methods
        private void spAuthReqCallBack(IAsyncResult asyncResult)
        {
            string envelope =
                    @"<?xml version=""1.0"" encoding=""utf-8""?>
                    <soap:Envelope xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xmlns:xsd=""http://www.w3.org/2001/XMLSchema"" xmlns:soap=""http://schemas.xmlsoap.org/soap/envelope/"">
                      <soap:Body>
                        <Login xmlns=""http://schemas.microsoft.com/sharepoint/soap/"">
                          <username>{0}</username>
                          <password>{1}</password>
                        </Login>
                      </soap:Body>
                    </soap:Envelope>";

            UTF8Encoding encoding = new UTF8Encoding();
            HttpWebRequest request = (HttpWebRequest)asyncResult.AsyncState;
            Stream _body = request.EndGetRequestStream(asyncResult);
            envelope = string.Format(envelope, User, Password);
            byte[] formBytes = encoding.GetBytes(envelope);

            _body.Write(formBytes, 0, formBytes.Length);
            _body.Close();

            request.BeginGetResponse(new AsyncCallback(ResponseCallback), request);
        }

        private void ResponseCallback(IAsyncResult asyncResult)
        {
            try
            {
                HttpWebRequest request = (HttpWebRequest)asyncResult.AsyncState;
                HttpWebResponse response = (HttpWebResponse)request.EndGetResponse(asyncResult);
                Stream content = response.GetResponseStream();

                if (request != null && response != null)
                {
                    if (response.StatusCode == HttpStatusCode.OK)
                    {
                        using (StreamReader reader = new StreamReader(content))
                        {
                            //Put debugging code here
                            string _responseString = reader.ReadToEnd();
                            reader.Close();
                        }
                    }
                }

                //authentication complete
                TriggerOnAuthenticated(true);
            }
            catch
            {
                TriggerOnAuthenticated(false);
            }
        }
        #endregion

        #region Events
        public delegate void OnAuthenticatedHandler(bool Success);

        public event OnAuthenticatedHandler OnAuthenticated;

        protected virtual void TriggerOnAuthenticated(bool Success)
        {
            if (OnAuthenticated != null)
                OnAuthenticated(Success);
        }
        #endregion
    }
}

The way to use this class is fairly simple, you create the SPAuthBridge object, you call the Authenticate method and you are ready to go, something like this:

view plainprint?

1. StratexWP7SoapClient StratexWP7 = new StratexWP7SoapClient(); //This is my web service  
2. SPAuthBridge SharePointAuth;  
3.   
4. public MainPage()  
5. {  
6.     InitializeComponent();  
7.   
8.     (...)  
9.   
10.     SharePointAuth = new SPAuthBridge(SiteUrl, Username, Password);  
11.     SharePointAuth.OnAuthenticated += new SPAuthBridge.OnAuthenticatedHandler(SharePointAuth_OnAuthenticated);  
12.   
13.     if (!string.IsNullOrEmpty(Password))  
14.         SharePointAuth.Authenticate();  
15.     else  
16.         MessageBox.Show("The application should be configured before use.");  
17. }  
18.   
19. void SharePointAuth_OnAuthenticated(bool Success)  
20. {  
21.     if (!Success)  
22.     {  
23.         Deployment.Current.Dispatcher.BeginInvoke(() =>  
24.             { MessageBox.Show("There was an error on the authentication procedure. Please check the configuration."); });  
25.   
26.         return;  
27.     }  
28.   
29.     StratexWP7.CookieContainer = SharePointAuth.cookieJar; //This is all you have to do to connect your web service. \m/ O.O \m/  
30.   
31.     HookEvents();  
32.   
33.     RequestData();  
34. }  

        StratexWP7SoapClient StratexWP7 = new StratexWP7SoapClient(); //This is my web service
        SPAuthBridge SharePointAuth;

        public MainPage()
        {
            InitializeComponent();

            (...)

            SharePointAuth = new SPAuthBridge(SiteUrl, Username, Password);
            SharePointAuth.OnAuthenticated += new SPAuthBridge.OnAuthenticatedHandler(SharePointAuth_OnAuthenticated);

            if (!string.IsNullOrEmpty(Password))
                SharePointAuth.Authenticate();
            else
                MessageBox.Show("The application should be configured before use.");
        }

        void SharePointAuth_OnAuthenticated(bool Success)
        {
            if (!Success)
            {
                Deployment.Current.Dispatcher.BeginInvoke(() =>
                    { MessageBox.Show("There was an error on the authentication procedure. Please check the configuration."); });

                return;
            }

            StratexWP7.CookieContainer = SharePointAuth.cookieJar; //This is all you have to do to connect your web service. \m/ O.O \m/

            HookEvents();

            RequestData();
        }

It looks great when it works…

(By the way the charts are from AmCharts)