summaryrefslogtreecommitdiffstats
path: root/src/DotNetOpenAuth.OAuth.Consumer/OAuth/ConsumerBase.cs
diff options
context:
space:
mode:
authorAndrew Arnott <andrewarnott@gmail.com>2013-02-25 21:26:04 -0800
committerAndrew Arnott <andrewarnott@gmail.com>2013-02-25 21:26:04 -0800
commit38a1162c5cbaea035e655dc9accd92f9de5019ed (patch)
tree489ba7dfa106d5b0a8878ac386f2d2130bdf6b21 /src/DotNetOpenAuth.OAuth.Consumer/OAuth/ConsumerBase.cs
parent10fc3ad3a7feda0cb5ab64aabe2e26bbce94595a (diff)
downloadDotNetOpenAuth-38a1162c5cbaea035e655dc9accd92f9de5019ed.zip
DotNetOpenAuth-38a1162c5cbaea035e655dc9accd92f9de5019ed.tar.gz
DotNetOpenAuth-38a1162c5cbaea035e655dc9accd92f9de5019ed.tar.bz2
OAuth 1.0 Consumers are now *much* simpler, entirely avoiding channels.
Build breaks in other projects, however.
Diffstat (limited to 'src/DotNetOpenAuth.OAuth.Consumer/OAuth/ConsumerBase.cs')
-rw-r--r--src/DotNetOpenAuth.OAuth.Consumer/OAuth/ConsumerBase.cs258
1 files changed, 0 insertions, 258 deletions
diff --git a/src/DotNetOpenAuth.OAuth.Consumer/OAuth/ConsumerBase.cs b/src/DotNetOpenAuth.OAuth.Consumer/OAuth/ConsumerBase.cs
deleted file mode 100644
index 1bea2c5..0000000
--- a/src/DotNetOpenAuth.OAuth.Consumer/OAuth/ConsumerBase.cs
+++ /dev/null
@@ -1,258 +0,0 @@
-//-----------------------------------------------------------------------
-// <copyright file="ConsumerBase.cs" company="Outercurve Foundation">
-// Copyright (c) Outercurve Foundation. All rights reserved.
-// </copyright>
-//-----------------------------------------------------------------------
-
-namespace DotNetOpenAuth.OAuth {
- using System;
- using System.Collections.Generic;
- using System.Diagnostics.CodeAnalysis;
- using System.Linq;
- using System.Net;
- using System.Net.Http;
- using System.Threading;
- using System.Threading.Tasks;
- using DotNetOpenAuth.Configuration;
- using DotNetOpenAuth.Messaging;
- using DotNetOpenAuth.Messaging.Bindings;
- using DotNetOpenAuth.OAuth.ChannelElements;
- using DotNetOpenAuth.OAuth.Messages;
- using Validation;
-
- /// <summary>
- /// Base class for <see cref="WebConsumer"/> and <see cref="DesktopConsumer"/> types.
- /// </summary>
- public class ConsumerBase : IDisposable {
- /// <summary>
- /// Initializes a new instance of the <see cref="ConsumerBase"/> class.
- /// </summary>
- /// <param name="serviceDescription">The endpoints and behavior of the Service Provider.</param>
- /// <param name="tokenManager">The host's method of storing and recalling tokens and secrets.</param>
- protected ConsumerBase(ServiceProviderDescription serviceDescription, IConsumerTokenManager tokenManager) {
- Requires.NotNull(serviceDescription, "serviceDescription");
- Requires.NotNull(tokenManager, "tokenManager");
-
- ITamperProtectionChannelBindingElement signingElement = serviceDescription.CreateTamperProtectionElement();
- INonceStore store = new NonceMemoryStore(StandardExpirationBindingElement.MaximumMessageAge);
- this.SecuritySettings = OAuthElement.Configuration.Consumer.SecuritySettings.CreateSecuritySettings();
- this.OAuthChannel = new OAuthConsumerChannel(signingElement, store, tokenManager, this.SecuritySettings);
- this.ServiceProvider = serviceDescription;
-
- OAuthReporting.RecordFeatureAndDependencyUse(this, serviceDescription, tokenManager, null);
- }
-
- /// <summary>
- /// Gets the Consumer Key used to communicate with the Service Provider.
- /// </summary>
- public string ConsumerKey {
- get { return this.TokenManager.ConsumerKey; }
- }
-
- /// <summary>
- /// Gets the Service Provider that will be accessed.
- /// </summary>
- public ServiceProviderDescription ServiceProvider { get; private set; }
-
- /// <summary>
- /// Gets the persistence store for tokens and secrets.
- /// </summary>
- public IConsumerTokenManager TokenManager {
- get { return (IConsumerTokenManager)this.OAuthChannel.TokenManager; }
- }
-
- /// <summary>
- /// Gets the channel to use for sending/receiving messages.
- /// </summary>
- public Channel Channel {
- get { return this.OAuthChannel; }
- }
-
- /// <summary>
- /// Gets the security settings for this consumer.
- /// </summary>
- internal ConsumerSecuritySettings SecuritySettings { get; private set; }
-
- /// <summary>
- /// Gets or sets the channel to use for sending/receiving messages.
- /// </summary>
- internal OAuthChannel OAuthChannel { get; set; }
-
- /// <summary>
- /// Creates a message handler that signs outbound requests with a previously obtained authorization.
- /// </summary>
- /// <param name="accessToken">The access token to authorize outbound HTTP requests with.</param>
- /// <param name="innerHandler">The inner handler that actually sends the HTTP message on the network.</param>
- /// <returns>
- /// A message handler.
- /// </returns>
- public OAuth1HttpMessageHandlerBase CreateMessageHandler(string accessToken = null, HttpMessageHandler innerHandler = null) {
- return new OAuth1HmacSha1HttpMessageHandler() {
- ConsumerKey = this.ConsumerKey,
- ConsumerSecret = this.TokenManager.ConsumerSecret,
- AccessToken = accessToken,
- AccessTokenSecret = accessToken != null ? this.TokenManager.GetTokenSecret(accessToken) : null,
- InnerHandler = innerHandler ?? this.Channel.HostFactories.CreateHttpMessageHandler(),
- };
- }
-
- /// <summary>
- /// Creates the HTTP client.
- /// </summary>
- /// <param name="accessToken">The access token to authorize outbound HTTP requests with.</param>
- /// <param name="innerHandler">The inner handler that actually sends the HTTP message on the network.</param>
- /// <returns>The HttpClient to use.</returns>
- public HttpClient CreateHttpClient(string accessToken, HttpMessageHandler innerHandler = null) {
- Requires.NotNullOrEmpty(accessToken, "accessToken");
-
- var handler = this.CreateMessageHandler(accessToken, innerHandler);
- var client = this.Channel.HostFactories.CreateHttpClient(handler);
- return client;
- }
-
- /// <summary>
- /// Creates the HTTP client.
- /// </summary>
- /// <param name="innerHandler">The inner handler that actually sends the HTTP message on the network.</param>
- /// <returns>The HttpClient to use.</returns>
- public HttpClient CreateHttpClient(OAuth1HttpMessageHandlerBase innerHandler) {
- Requires.NotNull(innerHandler, "innerHandler");
-
- var client = this.Channel.HostFactories.CreateHttpClient(innerHandler);
- return client;
- }
-
- /// <summary>
- /// Obtains an access token for a new account at the Service Provider via 2-legged OAuth.
- /// </summary>
- /// <param name="requestParameters">Any applicable parameters to include in the query string of the token request.</param>
- /// <param name="cancellationToken">The cancellation token.</param>
- /// <returns>The access token.</returns>
- /// <remarks>
- /// The token secret is stored in the <see cref="TokenManager"/>.
- /// </remarks>
- public async Task<string> RequestNewClientAccountAsync(IDictionary<string, string> requestParameters = null, CancellationToken cancellationToken = default(CancellationToken)) {
- // Obtain an unauthorized request token. Force use of OAuth 1.0 (not 1.0a) so that
- // we are not expected to provide an oauth_verifier which doesn't apply in 2-legged OAuth.
- var token = new UnauthorizedTokenRequest(this.ServiceProvider.RequestTokenEndpoint, Protocol.V10.Version) {
- ConsumerKey = this.ConsumerKey,
- };
- var tokenAccessor = this.Channel.MessageDescriptions.GetAccessor(token);
- tokenAccessor.AddExtraParameters(requestParameters);
- var requestTokenResponse = await this.Channel.RequestAsync<UnauthorizedTokenResponse>(token, cancellationToken);
- this.TokenManager.StoreNewRequestToken(token, requestTokenResponse);
-
- var requestAccess = new AuthorizedTokenRequest(this.ServiceProvider.AccessTokenEndpoint, Protocol.V10.Version) {
- RequestToken = requestTokenResponse.RequestToken,
- ConsumerKey = this.ConsumerKey,
- };
- var grantAccess = await this.Channel.RequestAsync<AuthorizedTokenResponse>(requestAccess, cancellationToken);
- this.TokenManager.ExpireRequestTokenAndStoreNewAccessToken(this.ConsumerKey, requestTokenResponse.RequestToken, grantAccess.AccessToken, grantAccess.TokenSecret);
- return grantAccess.AccessToken;
- }
-
- #region IDisposable Members
-
- /// <summary>
- /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
- /// </summary>
- public void Dispose() {
- this.Dispose(true);
- GC.SuppressFinalize(this);
- }
-
- #endregion
-
- /// <summary>
- /// Creates a web request prepared with OAuth authorization
- /// that may be further tailored by adding parameters by the caller.
- /// </summary>
- /// <param name="endpoint">The URL and method on the Service Provider to send the request to.</param>
- /// <param name="accessToken">The access token that permits access to the protected resource.</param>
- /// <returns>The initialized WebRequest object.</returns>
- protected internal AccessProtectedResourceRequest CreateAuthorizingMessage(MessageReceivingEndpoint endpoint, string accessToken) {
- Requires.NotNull(endpoint, "endpoint");
- Requires.NotNullOrEmpty(accessToken, "accessToken");
-
- AccessProtectedResourceRequest message = new AccessProtectedResourceRequest(endpoint, this.ServiceProvider.Version) {
- AccessToken = accessToken,
- ConsumerKey = this.ConsumerKey,
- };
-
- return message;
- }
-
- /// <summary>
- /// Prepares an OAuth message that begins an authorization request that will
- /// redirect the user to the Service Provider to provide that authorization.
- /// </summary>
- /// <param name="callback">An optional Consumer URL that the Service Provider should redirect the
- /// User Agent to upon successful authorization.</param>
- /// <param name="requestParameters">Extra parameters to add to the request token message. Optional.</param>
- /// <param name="redirectParameters">Extra parameters to add to the redirect to Service Provider message. Optional.</param>
- /// <param name="cancellationToken">The cancellation token.</param>
- /// <returns>
- /// The pending user agent redirect based message to be sent as an HttpResponse.
- /// </returns>
- [SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "3#", Justification = "Two results")]
- protected internal async Task<UserAuthorizationRequest> PrepareRequestUserAuthorizationAsync(Uri callback, IDictionary<string, string> requestParameters, IDictionary<string, string> redirectParameters, CancellationToken cancellationToken = default(CancellationToken)) {
- // Obtain an unauthorized request token. Assume the OAuth version given in the service description.
- var token = new UnauthorizedTokenRequest(this.ServiceProvider.RequestTokenEndpoint, this.ServiceProvider.Version) {
- ConsumerKey = this.ConsumerKey,
- Callback = callback,
- };
- var tokenAccessor = this.Channel.MessageDescriptions.GetAccessor(token);
- tokenAccessor.AddExtraParameters(requestParameters);
- var requestTokenResponse = await this.Channel.RequestAsync<UnauthorizedTokenResponse>(token, cancellationToken);
- this.TokenManager.StoreNewRequestToken(token, requestTokenResponse);
-
- // Fine-tune our understanding of the SP's supported OAuth version if it's wrong.
- if (this.ServiceProvider.Version != requestTokenResponse.Version) {
- Logger.OAuth.WarnFormat("Expected OAuth service provider at endpoint {0} to use OAuth {1} but {2} was detected. Adjusting service description to new version.", this.ServiceProvider.RequestTokenEndpoint.Location, this.ServiceProvider.Version, requestTokenResponse.Version);
- this.ServiceProvider.ProtocolVersion = Protocol.Lookup(requestTokenResponse.Version).ProtocolVersion;
- }
-
- // Request user authorization. The OAuth version will automatically include
- // or drop the callback that we're setting here.
- ITokenContainingMessage assignedRequestToken = requestTokenResponse;
- var requestAuthorization = new UserAuthorizationRequest(this.ServiceProvider.UserAuthorizationEndpoint, assignedRequestToken.Token, requestTokenResponse.Version) {
- Callback = callback,
- };
- var requestAuthorizationAccessor = this.Channel.MessageDescriptions.GetAccessor(requestAuthorization);
- requestAuthorizationAccessor.AddExtraParameters(redirectParameters);
- return requestAuthorization;
- }
-
- /// <summary>
- /// Exchanges a given request token for access token.
- /// </summary>
- /// <param name="requestToken">The request token that the user has authorized.</param>
- /// <param name="verifier">The verifier code.</param>
- /// <param name="cancellationToken">The cancellation token.</param>
- /// <returns>
- /// The access token assigned by the Service Provider.
- /// </returns>
- protected async Task<AuthorizedTokenResponse> ProcessUserAuthorizationAsync(string requestToken, string verifier, CancellationToken cancellationToken = default(CancellationToken)) {
- Requires.NotNullOrEmpty(requestToken, "requestToken");
-
- var requestAccess = new AuthorizedTokenRequest(this.ServiceProvider.AccessTokenEndpoint, this.ServiceProvider.Version) {
- RequestToken = requestToken,
- VerificationCode = verifier,
- ConsumerKey = this.ConsumerKey,
- };
- var grantAccess = await this.Channel.RequestAsync<AuthorizedTokenResponse>(requestAccess, cancellationToken);
- this.TokenManager.ExpireRequestTokenAndStoreNewAccessToken(this.ConsumerKey, requestToken, grantAccess.AccessToken, grantAccess.TokenSecret);
- return grantAccess;
- }
-
- /// <summary>
- /// Releases unmanaged and - optionally - managed resources
- /// </summary>
- /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
- protected virtual void Dispose(bool disposing) {
- if (disposing) {
- this.Channel.Dispose();
- }
- }
- }
-}