113 lines
4.4 KiB
C#
113 lines
4.4 KiB
C#
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
|
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Net.Http;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.AspNet.Http;
|
|
using Microsoft.AspNet.Http.Security;
|
|
|
|
namespace Microsoft.AspNet.Security.OAuth
|
|
{
|
|
/// <summary>
|
|
/// Configuration options for <see cref="OAuthAuthenticationMiddleware"/>.
|
|
/// </summary>
|
|
public class OAuthAuthenticationOptions : AuthenticationOptions
|
|
{
|
|
/// <summary>
|
|
/// Initializes a new <see cref="OAuthAuthenticationOptions"/>.
|
|
/// </summary>
|
|
public OAuthAuthenticationOptions()
|
|
{
|
|
AuthenticationMode = AuthenticationMode.Passive;
|
|
Scope = new List<string>();
|
|
BackchannelTimeout = TimeSpan.FromSeconds(60);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the provider-assigned client id.
|
|
/// </summary>
|
|
public string ClientId { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the provider-assigned client secret.
|
|
/// </summary>
|
|
public string ClientSecret { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the URI where the client will be redirected to authenticate.
|
|
/// </summary>
|
|
public string AuthorizationEndpoint { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the URI the middleware will access to exchange the OAuth token.
|
|
/// </summary>
|
|
public string TokenEndpoint { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the URI the middleware will access to obtain the user information.
|
|
/// This value is not used in the default implementation, it is for use in custom implementations of
|
|
/// IOAuthAuthenticationNotifications.GetUserInformationAsync or OAuthAuthenticationHandler.GetUserInformationAsync.
|
|
/// </summary>
|
|
public string UserInformationEndpoint { get; set; }
|
|
|
|
#if ASPNET50
|
|
/// <summary>
|
|
/// Gets or sets the a pinned certificate validator to use to validate the endpoints used
|
|
/// in back channel communications belong to the auth provider.
|
|
/// </summary>
|
|
/// <value>
|
|
/// The pinned certificate validator.
|
|
/// </value>
|
|
/// <remarks>If this property is null then the default certificate checks are performed,
|
|
/// validating the subject name and if the signing chain is a trusted party.</remarks>
|
|
public ICertificateValidator BackchannelCertificateValidator { get; set; }
|
|
#endif
|
|
/// <summary>
|
|
/// Get or sets the text that the user can display on a sign in user interface.
|
|
/// </summary>
|
|
public string Caption
|
|
{
|
|
get { return Description.Caption; }
|
|
set { Description.Caption = value; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets timeout value in milliseconds for back channel communications with the auth provider.
|
|
/// </summary>
|
|
/// <value>
|
|
/// The back channel timeout.
|
|
/// </value>
|
|
public TimeSpan BackchannelTimeout { get; set; }
|
|
|
|
/// <summary>
|
|
/// The HttpMessageHandler used to communicate with the auth provider.
|
|
/// This cannot be set at the same time as BackchannelCertificateValidator unless the value
|
|
/// can be downcast to a WebRequestHandler.
|
|
/// </summary>
|
|
public HttpMessageHandler BackchannelHttpHandler { get; set; }
|
|
|
|
/// <summary>
|
|
/// A list of permissions to request.
|
|
/// </summary>
|
|
public IList<string> Scope { get; private set; }
|
|
|
|
/// <summary>
|
|
/// The request path within the application's base path where the user-agent will be returned.
|
|
/// The middleware will process this request when it arrives.
|
|
/// </summary>
|
|
public PathString CallbackPath { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the name of another authentication middleware which will be responsible for actually issuing a user <see cref="System.Security.Claims.ClaimsIdentity"/>.
|
|
/// </summary>
|
|
public string SignInAsAuthenticationType { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the type used to secure data handled by the middleware.
|
|
/// </summary>
|
|
public ISecureDataFormat<AuthenticationProperties> StateDataFormat { get; set; }
|
|
}
|
|
}
|