blob: b13f0d16af2dad278fc083e769bc074d7b95b33b (
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
|
//-----------------------------------------------------------------------
// <copyright file="IAuthenticationClient.cs" company="Microsoft">
// Copyright (c) Microsoft. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOpenAuth.AspNet {
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
/// <summary>
/// Represents a client which can authenticate users via an external website/provider.
/// </summary>
public interface IAuthenticationClient {
/// <summary>
/// Gets the name of the provider which provides authentication service.
/// </summary>
string ProviderName { get; }
/// <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="context">The context of the current request.</param>
/// <param name="returnUrl">The return url after users have completed authenticating against external website.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A task that completes with the async operation.</returns>
Task RequestAuthenticationAsync(HttpContextBase context, Uri returnUrl, CancellationToken cancellationToken = default(CancellationToken));
/// <summary>
/// Check if authentication succeeded after user is redirected back from the service provider.
/// </summary>
/// <param name="context">The context of the current request.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// An instance of <see cref="AuthenticationResult" /> containing authentication result.
/// </returns>
Task<AuthenticationResult> VerifyAuthenticationAsync(HttpContextBase context, CancellationToken cancellationToken = default(CancellationToken));
}
}
|
