ASP.NET 4.7.2 VB WebForms の SameSite Cookie サンプル

[アーティクル]
04/29/2024

.NET Framework 4.7 には SameSite 属性のサポートが組み込まれていますが、元の標準に準拠しています。パッチ適用後の動作変更により、値をまったく出力しない代わりに、None の値を持つ SameSite.None 属性が出力されるようになりました。値を出力しない場合は、Cookie の SameSite プロパティを -1 に設定できます。

SameSite 属性の書き込み

Cookie に SameSite 属性を書き込む方法の例を次に示します。

' Create the cookie
Dim sameSiteCookie As New HttpCookie("sameSiteSample")

' Set a value for the cookie
sameSiteCookie.Value = "sample"

' Set the secure flag, which Chrome's changes will require for SameSite none.
' Note this will also require you to be running on HTTPS
sameSiteCookie.Secure = True

' Set the cookie to HTTP only which is good practice unless you really do need
' to access it client side in scripts.
sameSiteCookie.HttpOnly = True

' Expire the cookie in 1 minute
sameSiteCookie.Expires = Date.Now.AddMinutes(1)

' Add the SameSite attribute, this will emit the attribute with a value of none.
' To Not emit the attribute at all set the SameSite property to -1.
sameSiteCookie.SameSite = SameSiteMode.None

' Add the cookie to the response cookie collection
Response.Cookies.Add(sameSiteCookie)

英語以外の言語でこの記事をお読みになっていて、コードのコメントをネイティブ言語でご覧になりたい場合は、この GitHub ディスカッションの問題でお知らせください。

セッション状態の既定の sameSite 属性は、web.config のセッション設定の 'cookieSameSite' パラメーターに設定されます。

<system.web>
  <sessionState cookieSameSite="None">     
  </sessionState>
</system.web>

MVC 認証

OWIN MVC Cookie ベースの認証では、Cookie マネージャーを使用して Cookie 属性の変更を有効にします。 SameSiteCookieManager.vb は、独自のプロジェクトにコピーできるこのようなクラスの実装です。

Microsoft.Owin コンポーネントがすべて、バージョン 4.1.0 以降にアップグレードされるようにする必要があります。 packages.config ファイルを調べ、たとえば、すべてのバージョン番号が一致していることを確認します。

<?xml version="1.0" encoding="utf-8"?>
<packages>
  <!-- other packages -->
  <package id="Microsoft.Owin.Host.SystemWeb" version="4.1.0" targetFramework="net472" />
  <package id="Microsoft.Owin.Security" version="4.1.0" targetFramework="net472" />
  <package id="Microsoft.Owin.Security.Cookies" version="4.1.0" targetFramework="net472" />
  <package id="Microsoft.Web.Infrastructure" version="1.0.0.0" targetFramework="net472" />
  <package id="Owin" version="1.0" targetFramework="net472" />
</packages>

認証コンポーネントは、スタートアップクラスで CookieManager を使用するように構成する必要があります。

Public Sub Configuration(app As IAppBuilder)
    app.UseCookieAuthentication(New CookieAuthenticationOptions() With {
        .CookieSameSite = SameSiteMode.None,
        .CookieHttpOnly = True,
        .CookieSecure = CookieSecureOption.Always,
        .CookieManager = New SameSiteCookieManager(New SystemWebCookieManager())
    })
End Sub

Cookie マネージャーは、それをサポートする "各" コンポーネントに設定する必要があります。これには CookieAuthentication と OpenIdConnectAuthentication が含まれます。

SystemWebCookieManager は、応答 Cookie 統合に関する既知の問題を回避するために使用されます。

サンプルの実行

サンプルプロジェクトを実行する場合は、最初のページでブラウザーデバッガーを読み込み、それを使ってサイトの Cookie コレクションを表示してください。 Edge と Chrome でこれを行うには、F12 キーを押してから Application タブを選び、Storage セクションの Cookies オプションの下にあるサイト URL をクリックします。

Browser Debugger Cookie List

上の画像から、"Create SameSite Cookies" ボタンをクリックしたときにサンプルによって作成された Cookie の SameSite 属性値が Lax であり、サンプルコードで設定されている値と一致していることがわかります。

制御しない Cookie をインターセプトする

.NET 4.5.2 では、ヘッダーの書き込みをインターセプトするための新しいイベント Response.AddOnSendingHeaders が導入されました。これは、クライアントコンピューターに返される前に Cookie をインターセプトするために使用できます。このサンプルでは、ブラウザーが新しい sameSite の変更をサポートしているかどうかをチェックする静的メソッドにイベントを接続し、サポートされていない場合は、新しい None 値が設定されている場合に属性を出力しないように Cookie を変更します。

イベントの接続例については global.asax を、イベントの処理例と、自分のコードにコピーできる Cookie の sameSite 属性の調整例については、SameSiteCookieRewriter.vb を参照してください。

Sub FilterSameSiteNoneForIncompatibleUserAgents(ByVal sender As Object)
    Dim application As HttpApplication = TryCast(sender, HttpApplication)

    If application IsNot Nothing Then
        Dim userAgent = application.Context.Request.UserAgent

        If SameSite.DisallowsSameSiteNone(userAgent) Then
            application.Response.AddOnSendingHeaders(
                Function(context)
                    Dim cookies = context.Response.Cookies

                    For i = 0 To cookies.Count - 1
                        Dim cookie = cookies(i)

                        If cookie.SameSite = SameSiteMode.None Then
                            cookie.SameSite = CType((-1), SameSiteMode)
                        End If
                    Next
                End Function)
        End If
    End If
End Sub

特定の名前付き Cookie の動作は、ほとんど同じ方法で変更できます。下のサンプルでは、None 値をサポートするブラウザーでは既定の認証 Cookie を Lax から None に調整するか、None をサポートしないブラウザーでは sameSite 属性を削除します。

Public Shared Sub AdjustSpecificCookieSettings()
    HttpContext.Current.Response.AddOnSendingHeaders(Function(context)
            Dim cookies = context.Response.Cookies

            For i = 0 To cookies.Count - 1
            Dim cookie = cookies(i)

            If String.Equals(".ASPXAUTH", cookie.Name, StringComparison.Ordinal) Then

                If SameSite.BrowserDetection.DisallowsSameSiteNone(userAgent) Then
                    cookie.SameSite = -1
                Else
                    cookie.SameSite = SameSiteMode.None
                End If

                cookie.Secure = True
            End If
            Next
        End Function)
End Sub

その他の情報

次の方法で共有

SameSite 属性の書き込み

MVC 認証

サンプルの実行

制御しない Cookie をインターセプトする

その他の情報

フィードバック

その他のリソース