summaryrefslogtreecommitdiffstats
path: root/src/DotNetOpenAuth.Web/Clients/OAuth/OAuthClient.cs
blob: d0d7751f41621edaad041cfa695ae0ec196d961e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
using System;
using System.Web;
using DotNetOpenAuth.Messaging;
using DotNetOpenAuth.OAuth;
using DotNetOpenAuth.OAuth.ChannelElements;
using DotNetOpenAuth.OAuth.Messages;

namespace DotNetOpenAuth.Web.Clients
{
    /// <summary>
    /// Represents base class for OAuth 1.0 clients
    /// </summary>
    public abstract class OAuthClient : IAuthenticationClient
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="OAuthClient"/> class.
        /// </summary>
        /// <param name="providerName">Name of the provider.</param>
        /// <param name="serviceDescription">The service description.</param>
        /// <param name="consumerKey">The consumer key.</param>
        /// <param name="consumerSecret">The consumer secret.</param>
        protected OAuthClient(string providerName, ServiceProviderDescription serviceDescription, string consumerKey, string consumerSecret) :
            this(providerName, serviceDescription, new InMemoryOAuthTokenManager(consumerKey, consumerSecret))
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="OAuthClient"/> class.
        /// </summary>
        /// <param name="providerName">Name of the provider.</param>
        protected OAuthClient(string providerName, ServiceProviderDescription serviceDescription, IConsumerTokenManager tokenManager) : 
            this(providerName, new DotNetOpenAuthWebConsumer(serviceDescription, tokenManager))
        {
        }

        protected OAuthClient(string providerName, IOAuthWebWorker webWorker)
        {
            if (providerName == null)
            {
                throw new ArgumentNullException("providerName");
            }

            if (webWorker == null)
            {
                throw new ArgumentNullException("webWorker");
            }

            ProviderName = providerName;
            WebWorker = webWorker;
        }

        /// <summary>
        /// Gets the name of the provider which provides authentication service.
        /// </summary>
        public string ProviderName
        {
            get;
            private set;
        }

        /// <summary>
        /// Gets the <see cref="OAuthWebConsumer"/> instance which handles constructing requests
        /// to the OAuth providers.
        /// </summary>
        protected IOAuthWebWorker WebWorker
        {
            get;
            private set;
        }

        /// <summary>
        /// Attempts to authenticate users by forwarding them to an external website, and
        /// upon succcess or failure, redirect users back to the specified url.
        /// </summary>
        /// <param name="returnUrl">The return url after users have completed authenticating against external website.</param>
        public virtual void RequestAuthentication(HttpContextBase context, Uri returnUrl)
        {
            if (returnUrl == null)
            {
                throw new ArgumentNullException("returnUrl");
            }

            if (context == null)
            {
                throw new ArgumentNullException("context");
            }

            Uri callback = returnUrl.StripQueryArgumentsWithPrefix("oauth_");
            WebWorker.RequestAuthentication(callback);
        }

        /// <summary>
        /// Check if authentication succeeded after user is redirected back from the service provider.
        /// </summary>
        /// <returns>
        /// An instance of <see cref="AuthenticationResult"/> containing authentication result.
        /// </returns>
        public virtual AuthenticationResult VerifyAuthentication(HttpContextBase context)
        {
            AuthorizedTokenResponse response = WebWorker.ProcessUserAuthorization();
            if (response == null)
            {
                return AuthenticationResult.Failed;
            }

            return VerifyAuthenticationCore(response);
        }

        /// <summary>
        /// Check if authentication succeeded after user is redirected back from the service provider.
        /// </summary>
        /// <param name="response">The response token returned from service provider</param>
        /// <returns>Authentication result</returns>
        protected abstract AuthenticationResult VerifyAuthenticationCore(AuthorizedTokenResponse response);
    }
}