FormsAuthenticationConfiguration

.NET Framework クラス ライブラリ リファレンス

FormsAuthenticationConfiguration クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

AuthenticationMode フォーム認証方式を使用するように ASP.NET アプリケーションを構成します。

名前空間: System.Web.Configuration
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 FormsAuthenticationConfiguration
    Inherits ConfigurationElement

Visual Basic (使用法)

Dim instance As FormsAuthenticationConfiguration

C#

public sealed class FormsAuthenticationConfiguration
 : ConfigurationElement

C++

public ref class FormsAuthenticationConfiguration
 sealed : public ConfigurationElement

J#

public final class FormsAuthenticationConfiguration
 extends ConfigurationElement

JScript

public final class FormsAuthenticationConfiguration
 extends ConfigurationElement

解説

FormsAuthenticationConfiguration クラスを使用すると、authentication 構成セクションの forms 要素にプログラムからアクセスして変更できます。

この型は、FormsAuthenticationCredentials 型、FormsAuthenticationUserCollection 型、FormsAuthenticationUser 型を含むグループの一部です。コレクション型以外の型は、基になる構成タグに直接影響を与えます。

メモ
FormsAuthenticationConfiguration は、値が MachineToApplication のセクション プロパティ AllowDefinition で定義される制限に従って構成ファイルの関連するセクションに情報を書き込むことができます。階層構造の許可されていないレベルで構成ファイルに書き込みを行おうとした場合、パーサーによってエラー メッセージが生成されます。ただし、このクラスを使用して、階層構造の任意のレベルに構成情報を読み込むことができます。安全性とスケーラビリティを高めるため、データベースなど、外部のリポジトリを使用して、ユーザーの資格情報を維持することをお勧めします。

使用例

既存の Web アプリケーションの構成ファイルから FormsAuthenticationConfiguration オブジェクトを取得する方法を次のコード例に示します。このオブジェクトを使用して、メンバにアクセスできます。構成ファイルには、次のようなセットアップが格納されます。

メモ   credentials セクションを使用する場合は、「ASP.NET の認証」に説明されているガイドラインに従う必要があります。スケーラビリティとセキュリティを高めるため、外部のデータベースを使用して、ユーザーの資格情報を保管することをお勧めします。安全な ASP.NET アプリケーションを構築する方法の詳細については、Microsoft MSDN Web サイト (msdn.microsoft.com) で、「Securing Your ASP.NET Application」や「Building Secure ASP.NET Applications: Authentication, Authorization, and Secure Communication」を参照してください。

<authentication mode="Forms">
  <forms name="MyAppCookie" loginUrl="login.aspx"
    defaultUrl="default.aspx"
    protection="Encryption" timeout="5" path="aspnetTest"
    slidingExpiration="false"
    cookieless="UseCookies" domain="domainName">
    <credentials passwordFormat="SHA1">
      <user name="aspnetuser1"
        password="5BAA61E4C9B93F3F0682250B6CF8331B7EE68FD8"/>
       <user name="aspnetuser2"
         password="E38AD214943DAAD1D64C102FAEC29DE4AFE9DA3D"/>
    </credentials>          
  </forms>
</authentication> 

Visual Basic

' Get the Web application configuration.
  Dim configuration As System.Configuration.Configuration
 = _
  WebConfigurationManager.OpenWebConfiguration( _
  "/aspnetTest")

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

' Get the external Forms section .
  Dim formsAuthentication _
  As FormsAuthenticationConfiguration = _
  authenticationSection.Forms

C#

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

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

// Get the external Forms section .
FormsAuthenticationConfiguration formsAuthentication =
    authenticationSection.Forms;

継承階層

System.Object
   System.Configuration.ConfigurationElement
    System.Web.Configuration.FormsAuthenticationConfiguration

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
FormsAuthenticationConfiguration メンバ
System.Web.Configuration 名前空間
その他の技術情報
authentication 要素 (ASP.NET 設定スキーマ)
authentication の forms 要素 (ASP.NET 設定スキーマ)
authentication の forms の credentials 要素 (ASP.NET 設定スキーマ)
ASP.NET の認証
フォーム認証プロバイダ
アプリケーション間のフォーム認証

FormsAuthenticationConfiguration コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

このコンストラクタは、.NET Framework インフラストラクチャをサポートします。独自に作成したコードから直接使用するためのものではありません。

FormsAuthenticationConfiguration クラスの新しいインスタンスを初期化します。

名前空間: System.Web.Configuration
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New FormsAuthenticationConfiguration

C#

public FormsAuthenticationConfiguration ()

C++

public:
FormsAuthenticationConfiguration ()

J#

public FormsAuthenticationConfiguration ()

JScript

public function FormsAuthenticationConfiguration
 ()

使用例

FormsAuthenticationConfiguration オブジェクトを作成する方法を次のコード例に示します。

Visual Basic

' Create a new FormsAuthentication object.
  Dim newformsAuthentication _
  As New FormsAuthenticationConfiguration()

C#

// Create a new FormsAuthentication object.
FormsAuthenticationConfiguration newformsAuthentication =
new FormsAuthenticationConfiguration();

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
FormsAuthenticationConfiguration クラス
FormsAuthenticationConfiguration メンバ
System.Web.Configuration 名前空間

FormsAuthenticationConfiguration プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Cookieless	フォーム ベース認証が Cookie を使用するかどうかを示す値を取得または設定します。
	Credentials	ユーザー名とパスワードの FormsAuthenticationCredentials コレクションを取得します。
	DefaultUrl	既定の URL を取得または設定します。
	Domain	フォーム認証 Cookie で送信されるドメイン名を取得または設定します。
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	EnableCrossAppRedirects	認証されたユーザーを他のアプリケーション内の URL にリダイレクトできるかどうかを示す値を取得または設定します。
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。 ( ConfigurationElement から継承されます。)
	LoginUrl	要求に対するリダイレクト URL を取得または設定します。
	Name	Cookie 名を取得または設定します。
	Path	Cookie のパスを取得または設定します。
	Protection	Cookie の暗号化に使用される暗号化タイプを取得または設定します。
	RequireSSL	認証情報の送信に SSL (Secure Sockets Layer) 接続が必要であるかどうかを示す値を取得または設定します。
	SlidingExpiration	認証のスライド式有効期限を取得または設定します。
	Timeout	認証タイムアウト期間を取得または設定します。

プロテクト プロパティ

	名前	説明
	ElementProperty	ConfigurationElement オブジェクト自体を表す ConfigurationElementProperty オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	EvaluationContext	ConfigurationElement オブジェクトの ContextInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	Item	オーバーロードされます。 この ConfigurationElement オブジェクトのプロパティ、属性、または子要素を取得または設定します。 ( ConfigurationElement から継承されます。)
	Properties	プロパティのコレクションを取得します。 ( ConfigurationElement から継承されます。)

参照

関連項目

FormsAuthenticationConfiguration クラス
System.Web.Configuration 名前空間

その他の技術情報

authentication 要素 (ASP.NET 設定スキーマ)
authentication の forms 要素 (ASP.NET 設定スキーマ)
authentication の forms の credentials 要素 (ASP.NET 設定スキーマ)
ASP.NET の認証
フォーム認証プロバイダ
アプリケーション間のフォーム認証

FormsAuthenticationConfiguration メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 ( ConfigurationElement から継承されます。)
	GetHashCode	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 ( ConfigurationElement から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	DeserializeElement	構成ファイルから XML を読み取ります。 ( ConfigurationElement から継承されます。)
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	Init	ConfigurationElement オブジェクトを初期状態に設定します。 ( ConfigurationElement から継承されます。)
	InitializeDefault	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 ( ConfigurationElement から継承されます。)
	IsModified	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 ( ConfigurationElement から継承されます。)
	ListErrors	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 ( ConfigurationElement から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnDeserializeUnrecognizedAttribute	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	OnDeserializeUnrecognizedElement	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	OnRequiredPropertyNotFound	必須プロパティが見つからなかったかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	PostDeserialize	逆シリアル化後に呼び出されます。 ( ConfigurationElement から継承されます。)
	PreSerialize	シリアル化前に呼び出されます。 ( ConfigurationElement から継承されます。)
	Reset	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 ( ConfigurationElement から継承されます。)
	ResetModified	派生クラスに実装された場合、IsModified メソッドの値を false にリセットします。 ( ConfigurationElement から継承されます。)
	SerializeElement	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 ( ConfigurationElement から継承されます。)
	SerializeToXmlElement	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 ( ConfigurationElement から継承されます。)
	SetPropertyValue	プロパティを指定した値に設定します。 ( ConfigurationElement から継承されます。)
	SetReadOnly	ConfigurationElement オブジェクトおよびすべてのサブ要素に IsReadOnly プロパティを設定します。 ( ConfigurationElement から継承されます。)
	Unmerge	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 ( ConfigurationElement から継承されます。)

参照

関連項目

FormsAuthenticationConfiguration クラス
System.Web.Configuration 名前空間

その他の技術情報

authentication 要素 (ASP.NET 設定スキーマ)
authentication の forms 要素 (ASP.NET 設定スキーマ)
authentication の forms の credentials 要素 (ASP.NET 設定スキーマ)
ASP.NET の認証
フォーム認証プロバイダ
アプリケーション間のフォーム認証

FormsAuthenticationConfiguration メンバ

AuthenticationMode フォーム認証方式を使用するように ASP.NET アプリケーションを構成します。

FormsAuthenticationConfiguration データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	FormsAuthenticationConfiguration	FormsAuthenticationConfiguration クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Cookieless	フォーム ベース認証が Cookie を使用するかどうかを示す値を取得または設定します。
	Credentials	ユーザー名とパスワードの FormsAuthenticationCredentials コレクションを取得します。
	DefaultUrl	既定の URL を取得または設定します。
	Domain	フォーム認証 Cookie で送信されるドメイン名を取得または設定します。
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 (ConfigurationElement から継承されます。)
	EnableCrossAppRedirects	認証されたユーザーを他のアプリケーション内の URL にリダイレクトできるかどうかを示す値を取得または設定します。
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 (ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。(ConfigurationElement から継承されます。)
	LoginUrl	要求に対するリダイレクト URL を取得または設定します。
	Name	Cookie 名を取得または設定します。
	Path	Cookie のパスを取得または設定します。
	Protection	Cookie の暗号化に使用される暗号化タイプを取得または設定します。
	RequireSSL	認証情報の送信に SSL (Secure Sockets Layer) 接続が必要であるかどうかを示す値を取得または設定します。
	SlidingExpiration	認証のスライド式有効期限を取得または設定します。
	Timeout	認証タイムアウト期間を取得または設定します。

プロテクト プロパティ

	名前	説明
	ElementProperty	ConfigurationElement オブジェクト自体を表す ConfigurationElementProperty オブジェクトを取得します。(ConfigurationElement から継承されます。)
	EvaluationContext	ConfigurationElement オブジェクトの ContextInformation オブジェクトを取得します。(ConfigurationElement から継承されます。)
	Item	オーバーロードされます。 この ConfigurationElement オブジェクトのプロパティ、属性、または子要素を取得または設定します。(ConfigurationElement から継承されます。)
	Properties	プロパティのコレクションを取得します。(ConfigurationElement から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 (ConfigurationElement から継承されます。)
	GetHashCode	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 (ConfigurationElement から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	DeserializeElement	構成ファイルから XML を読み取ります。 (ConfigurationElement から継承されます。)
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	Init	ConfigurationElement オブジェクトを初期状態に設定します。 (ConfigurationElement から継承されます。)
	InitializeDefault	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 (ConfigurationElement から継承されます。)
	IsModified	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 (ConfigurationElement から継承されます。)
	ListErrors	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 (ConfigurationElement から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnDeserializeUnrecognizedAttribute	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	OnDeserializeUnrecognizedElement	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	OnRequiredPropertyNotFound	必須プロパティが見つからなかったかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	PostDeserialize	逆シリアル化後に呼び出されます。 (ConfigurationElement から継承されます。)
	PreSerialize	シリアル化前に呼び出されます。 (ConfigurationElement から継承されます。)
	Reset	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 (ConfigurationElement から継承されます。)
	ResetModified	派生クラスに実装された場合、IsModified メソッドの値を false にリセットします。 (ConfigurationElement から継承されます。)
	SerializeElement	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 (ConfigurationElement から継承されます。)
	SerializeToXmlElement	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 (ConfigurationElement から継承されます。)
	SetPropertyValue	プロパティを指定した値に設定します。 (ConfigurationElement から継承されます。)
	SetReadOnly	ConfigurationElement オブジェクトおよびすべてのサブ要素に IsReadOnly プロパティを設定します。 (ConfigurationElement から継承されます。)
	Unmerge	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 (ConfigurationElement から継承されます。)

参照

関連項目

FormsAuthenticationConfiguration クラス
System.Web.Configuration 名前空間

その他の技術情報

authentication 要素 (ASP.NET 設定スキーマ)
authentication の forms 要素 (ASP.NET 設定スキーマ)
authentication の forms の credentials 要素 (ASP.NET 設定スキーマ)
ASP.NET の認証
フォーム認証プロバイダ
アプリケーション間のフォーム認証