FormsAuthenticationCredentials 类

定义

为使用基于表单的身份验证的 ASP.NET 应用程序配置用户凭据。

public ref class FormsAuthenticationCredentials sealed : System::Configuration::ConfigurationElement
public sealed class FormsAuthenticationCredentials : System.Configuration.ConfigurationElement
type FormsAuthenticationCredentials = class
    inherit ConfigurationElement
Public NotInheritable Class FormsAuthenticationCredentials
Inherits ConfigurationElement
继承
FormsAuthenticationCredentials

示例

此示例演示如何以声明方式为 节的 credentials 多个属性指定值,这些属性也可以作为 类的成员 FormsAuthenticationCredentials 进行访问。

以下配置文件示例演示如何以声明方式为 credentials 节指定值。

<credentials passwordFormat="SHA1">
  <user name="aspnetuser1"
    password="5BAA61E4C9B93F3F0682250B6CF8331B7EE68FD8"/>
  <user name="aspnetuser2"
    password="E38AD214943DAAD1D64C102FAEC29DE4AFE9DA3D"/>
</credentials>

此示例使用 SHA1。 由于与 SHA1 冲突,Microsoft 建议使用 SHA256。

注意

如果使用 部分 credentials ,请务必遵循 ASP.NET 身份验证中所述的准则。 为了提高可伸缩性和安全性,建议使用外部数据库来存储用户的凭据。 有关生成安全 ASP.NET 应用程序的详细信息,请参阅保护 ASP.NET 应用程序和构建安全的 ASP.NET 应用程序:身份验证、授权和安全通信

下面的代码示例演示如何使用 FormsAuthenticationCredentials 类。


// Get the Web application configuration.
System.Configuration.Configuration configuration = 
    WebConfigurationManager.OpenWebConfiguration("/aspnetTest");

// Get the authentication section.
AuthenticationSection authenticationSection = 
    (AuthenticationSection)configuration.GetSection(
    "system.web/authentication");

// Get the forms credentials collection .
FormsAuthenticationCredentials formsAuthenticationCredentials =
    authenticationSection.Forms.Credentials;
' Get the Web application configuration.
  Dim configuration As System.Configuration.Configuration = _
  WebConfigurationManager.OpenWebConfiguration( _
  "/aspnetTest")

' Get the authentication section.
  Dim authenticationSection _
  As AuthenticationSection = _
  CType(configuration.GetSection( _
  "system.web/authentication"), AuthenticationSection)

' Get the forms credentials collection .
  Dim formsAuthenticationCredentials _
  As FormsAuthenticationCredentials = _
  authenticationSection.Forms.Credentials

注解

FormsAuthenticationCredentials提供了一种以编程方式访问和修改credentials配置文件 的 节的 authentication 元素forms的方法。 此类型是包含 FormsAuthenticationConfigurationFormsAuthenticationUserCollection和 类型的组的 FormsAuthenticationUser 一部分。 除集合类型之外,所有其他都直接影响基础配置标记。

注意

FormsAuthenticationCredentials可以根据 定义的MachineToApplication限制,将信息写入配置文件的相关节。 在层次结构中不允许的级别在配置文件中写入的任何尝试都将导致分析程序生成错误消息。 但是,可以使用此类在层次结构中的任何级别读取配置信息。 为了安全和可伸缩性,建议使用外部存储库(如数据库)来保留用户的凭据。

构造函数

FormsAuthenticationCredentials()

初始化 FormsAuthenticationCredentials 类的新实例。

属性

CurrentConfiguration

获取对顶级 Configuration 实例的引用,该实例表示当前 ConfigurationElement 实例所属的配置层次结构。

(继承自 ConfigurationElement)
ElementInformation

获取包含 ConfigurationElement 对象的不可自定义的信息和功能的 ElementInformation 对象。

(继承自 ConfigurationElement)
ElementProperty

获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。

(继承自 ConfigurationElement)
EvaluationContext

获取 ConfigurationElement 对象的 ContextInformation 对象。

(继承自 ConfigurationElement)
HasContext

获取一个值,该值指示 CurrentConfiguration 属性是否为 null

(继承自 ConfigurationElement)
Item[ConfigurationProperty]

获取或设置此配置元素的属性或特性。

(继承自 ConfigurationElement)
Item[String]

获取或设置此配置元素的属性、特性或子元素。

(继承自 ConfigurationElement)
LockAllAttributesExcept

获取被锁定的特性的集合。

(继承自 ConfigurationElement)
LockAllElementsExcept

获取被锁定的元素的集合。

(继承自 ConfigurationElement)
LockAttributes

获取被锁定的特性的集合。

(继承自 ConfigurationElement)
LockElements

获取被锁定的元素的集合。

(继承自 ConfigurationElement)
LockItem

获取或设置一个值,该值指示是否已锁定该元素。

(继承自 ConfigurationElement)
PasswordFormat

获取或设置密码格式。

Properties

获取属性的集合。

(继承自 ConfigurationElement)
Users

获取用户的名称和密码凭据。

方法

DeserializeElement(XmlReader, Boolean)

从配置文件读取 XML。

(继承自 ConfigurationElement)
Equals(Object)

将当前的 ConfigurationElement 实例与指定的对象进行比较。

(继承自 ConfigurationElement)
GetHashCode()

获取表示当前 ConfigurationElement 实例的唯一值。

(继承自 ConfigurationElement)
GetTransformedAssemblyString(String)

返回指定程序集名称的转换版本。

(继承自 ConfigurationElement)
GetTransformedTypeString(String)

返回指定类型名称的转换版本。

(继承自 ConfigurationElement)
GetType()

获取当前实例的 Type

(继承自 Object)
Init()

ConfigurationElement 对象设置为其初始状态。

(继承自 ConfigurationElement)
InitializeDefault()

用于初始化 ConfigurationElement 对象的默认值集。

(继承自 ConfigurationElement)
IsModified()

指示自上次保存或加载该配置元素后并在派生类中实现该元素时,该元素是否已被修改。

(继承自 ConfigurationElement)
IsReadOnly()

获取一个值,该值指示 ConfigurationElement 对象是否为只读。

(继承自 ConfigurationElement)
ListErrors(IList)

将此 ConfigurationElement 对象以及所有子元素中无效属性的错误添加到传递的列表中。

(继承自 ConfigurationElement)
MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
OnDeserializeUnrecognizedAttribute(String, String)

获取一个值,该值指示反序列化过程中是否遇到未知特性。

(继承自 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

获取一个值,该值指示反序列化过程中是否遇到未知元素。

(继承自 ConfigurationElement)
OnRequiredPropertyNotFound(String)

找不到所需属性时引发异常。

(继承自 ConfigurationElement)
PostDeserialize()

反序列化后调用。

(继承自 ConfigurationElement)
PreSerialize(XmlWriter)

在序列化之前调用。

(继承自 ConfigurationElement)
Reset(ConfigurationElement)

重置 ConfigurationElement 对象的内部状态,包括锁和属性集合。

(继承自 ConfigurationElement)
ResetModified()

在派生类中实现时,将 IsModified() 方法的值重置为 false

(继承自 ConfigurationElement)
SerializeElement(XmlWriter, Boolean)

当在派生类中实现后,将此配置元素的内容写入配置文件。

(继承自 ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)

当在派生类中实现后,将此配置元素的外部标记写入配置文件。

(继承自 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

将属性设置为指定值。

(继承自 ConfigurationElement)
SetReadOnly()

设置 ConfigurationElement 对象及所有子元素的 IsReadOnly() 属性。

(继承自 ConfigurationElement)
ToString()

返回表示当前对象的字符串。

(继承自 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

修改 ConfigurationElement 对象以移除所有不应该保存的值。

(继承自 ConfigurationElement)

适用于

另请参阅