테이터 보호: 키가 취소된 페이로드의 보호 해제하기

ASP.NET Core 데이터 보호 API는 무기한 기밀 페이로드의 유지를 목적으로 설계되지 않았습니다. 무기한 저장 시나리오에는 Windows CNG DPAPI나 Azure 권한 관리 같은 다른 기술이 더 적합하며, 이런 기술들은 그에 상응하는 강력한 키 관리 기능을 갖추고 있습니다. 그러나 개발자가 ASP.NET Core 데이터 보호 API를 이용해서 기밀 데이터를 장기간 보호하는 행위 자체를 금지하는 것은 아닙니다. 키는 키 링에서 절대로 제거되지 않으므로, 키가 사용 가능하고 유효하기만 하다면 언제나 IDataProtector.Unprotect 메서드로 원본 페이로드를 복구할 수 있습니다.

그러나 개발자가 취소된 키를 이용해서 보호된 데이터를 보호 해제하려고 시도할 경우 문제가 발생하는데, IDataProtector.Unprotect 메서드가 예외를 던지기 때문입니다. 단기 및 임시 페이로드는 (인증 토큰 같은) 시스템에서 손쉽게 재생성 할 수 있으므로 이런 유형의 페이로드는 크게 문제가 되지 않으며, 최악의 경우가 발생하더라도 사용자가 다시 로그인하면 그만입니다. 그러나 영속화된 페이로드의 경우에는 Unprotect 메서드가 예외를 던지는 상황이 발생하면 간과할 수 없는 데이터 유실이 발생하게 됩니다.

IPersistedDataProtector

키가 해제된 경우에도 페이로드를 보호 해제할 수 있도록 허용하는 시나리오를 지원하기 위해서 데이터 보호 시스템에는 IPersistedDataProtector 형식이 포함되어 있습니다. IPersistedDataProtector 인터페이스의 인스턴스를 얻기 위해서는 그냥 일반적인 IDataProtector의 인스턴스를 얻은 다음, 해당 인스턴스를 IPersistedDataProtector 형식으로 형변환하기만 하면 됩니다.

IPersistedDataProtector 인터페이스는 다음과 같은 API 표면을 노출합니다:

DangerousUnprotect(byte[] protectedData, bool ignoreRevocationErrors, 
                   out bool requiresMigration, out bool wasRevoked) : byte[]

이 API는 보호된 페이로드를 전달 받아서 (byte 배열로) 보호 해제된 페이로드를 반환합니다. 이 API에는 문자열 기반의 오버로드가 존재하지 않습니다. 마지막 두 가지 out 매개변수는 다음과 같습니다.

• requiresMigration: 페이로드를 보호하는데 사용된 키가 더 이상 활성화 된 기본 키가 아닌 경우 true로 설정됩니다 (페이로드를 보호하는데 사용된 키가 오래되어 키 롤링 작업이 발생한 경우 등). 업무 규칙에 따라서는 호출자가 페이로드를 다시 보호해야 하는 경우도 있습니다.

• wasRevoked: 페이로드를 보호하는데 사용된 키가 취소된 경우 true로 설정됩니다.

using System;
using System.IO;
using System.Text;
using Microsoft.AspNetCore.DataProtection;
using Microsoft.AspNetCore.DataProtection.KeyManagement;
using Microsoft.Extensions.DependencyInjection;

public class Program
{
    public static void Main(string[] args)
    {
        var serviceCollection = new ServiceCollection();
        serviceCollection.AddDataProtection()
            // point at a specific folder and use DPAPI to encrypt keys
            .PersistKeysToFileSystem(new DirectoryInfo(@"c:\temp-keys"))
            .ProtectKeysWithDpapi();
        var services = serviceCollection.BuildServiceProvider();

        // get a protector and perform a protect operation
        var protector = services.GetDataProtector("Sample.DangerousUnprotect");
        Console.Write("Input: ");
        byte[] input = Encoding.UTF8.GetBytes(Console.ReadLine());
        var protectedData = protector.Protect(input);
        Console.WriteLine($"Protected payload: {Convert.ToBase64String(protectedData)}");

        // demonstrate that the payload round-trips properly
        var roundTripped = protector.Unprotect(protectedData);
        Console.WriteLine($"Round-tripped payload: {Encoding.UTF8.GetString(roundTripped)}");

        // get a reference to the key manager and revoke all keys in the key ring
        var keyManager = services.GetService<IKeyManager>();
        Console.WriteLine("Revoking all keys in the key ring...");
        keyManager.RevokeAllKeys(DateTimeOffset.Now, "Sample revocation.");

        // try calling Protect - this should throw
        Console.WriteLine("Calling Unprotect...");
        try
        {
            var unprotectedPayload = protector.Unprotect(protectedData);
            Console.WriteLine($"Unprotected payload: {Encoding.UTF8.GetString(unprotectedPayload)}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"{ex.GetType().Name}: {ex.Message}");
        }

        // try calling DangerousUnprotect
        Console.WriteLine("Calling DangerousUnprotect...");
        try
        {
            IPersistedDataProtector persistedProtector = protector as IPersistedDataProtector;
            if (persistedProtector == null)
            {
                throw new Exception("Can't call DangerousUnprotect.");
            }

            bool requiresMigration, wasRevoked;
            var unprotectedPayload = persistedProtector.DangerousUnprotect(
                protectedData: protectedData,
                ignoreRevocationErrors: true,
                requiresMigration: out requiresMigration,
                wasRevoked: out wasRevoked);
            Console.WriteLine($"Unprotected payload: {Encoding.UTF8.GetString(unprotectedPayload)}");
            Console.WriteLine($"Requires migration = {requiresMigration}, was revoked = {wasRevoked}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"{ex.GetType().Name}: {ex.Message}");
        }
    }
}

/*
 * SAMPLE OUTPUT
 *
 * Input: Hello!
 * Protected payload: CfDJ8LHIzUCX1ZVBn2BZ...
 * Round-tripped payload: Hello!
 * Revoking all keys in the key ring...
 * Calling Unprotect...
 * CryptographicException: The key {...} has been revoked.
 * Calling DangerousUnprotect...
 * Unprotected payload: Hello!
 * Requires migration = True, was revoked = True
 */