보안 프레임: 예외 관리 | 해결 방법

WCF - 구성 파일에 serviceDebug 노드를 포함하지 않음

예시

다음 구성 파일에는 <serviceDebug> 태그가 포함됩니다.

<configuration> 
<system.serviceModel> 
<behaviors> 
<serviceBehaviors> 
<behavior name=""MyServiceBehavior""> 
<serviceDebug includeExceptionDetailInFaults=""True"" httpHelpPageEnabled=""True""/> 
... 

서비스에서 디버깅 정보를 사용하지 않도록 설정합니다. 이 작업은 애플리케이션 구성 파일에서 <serviceDebug> 태그를 제거하여 수행할 수 있습니다.

WCF - 구성 파일에 serviceMetadata 노드를 포함하지 않음

ASP.NET Web API에서 적절한 예외 처리가 수행되었는지 확인

예시

API에서 반환되는 상태 코드를 제어하려면 아래와 같이 HttpResponseException을 사용할 수 있습니다.

public Product GetProduct(int id)
{
    Product item = repository.Get(id);
    if (item == null)
    {
        throw new HttpResponseException(HttpStatusCode.NotFound);
    }
    return item;
}

예시

예외 응답을 추가적으로 제어하려면 아래와 같이 HttpResponseMessage 클래스를 사용할 수 있습니다.

public Product GetProduct(int id)
{
    Product item = repository.Get(id);
    if (item == null)
    {
        var resp = new HttpResponseMessage(HttpStatusCode.NotFound)
        {
            Content = new StringContent(string.Format("No product with ID = {0}", id)),
            ReasonPhrase = "Product ID Not Found"
        }
        throw new HttpResponseException(resp);
    }
    return item;
}

HttpResponseException 형식이 아닌 처리되지 않은 예외를 catch하려면 예외 필터를 사용할 수 있습니다. 예외 필터는 System.Web.Http.Filters.IExceptionFilter 인터페이스를 구현합니다. 예외 필터를 작성하는 가장 간단한 방법은 System.Web.Http.Filters.ExceptionFilterAttribute 클래스에서 파생하고 OnException 메서드를 재정의하는 것입니다.

예시

다음은 NotImplementedException을 HTTP 상태 코드 501, Not Implemented로 변환하는 필터입니다.

namespace ProductStore.Filters
{
    using System;
    using System.Net;
    using System.Net.Http;
    using System.Web.Http.Filters;

    public class NotImplExceptionFilterAttribute : ExceptionFilterAttribute 
    {
        public override void OnException(HttpActionExecutedContext context)
        {
            if (context.Exception is NotImplementedException)
            {
                context.Response = new HttpResponseMessage(HttpStatusCode.NotImplemented);
            }
        }
    }
}

다음과 같은 여러 가지 방법으로 Web API 예외 필터를 등록할 수 있습니다.

• 작업 기준
• 컨트롤러 기준
• 전역적으로

예시

특정 작업에 필터를 적용하려면 필터를 작업에 특성으로 추가합니다.

public class ProductsController : ApiController
{
    [NotImplExceptionFilter]
    public Contact GetContact(int id)
    {
        throw new NotImplementedException("This method is not implemented");
    }
}

예시

controller의 모든 작업에 필터를 적용하려면 필터를 controller 클래스에 특성으로 추가합니다.

[NotImplExceptionFilter]
public class ProductsController : ApiController
{
    // ...
}

예시

모든 Web API 컨트롤러에는 전역적으로 필터를 적용하려면 필터의 인스턴스를 GlobalConfiguration.Configuration.Filters 컬렉션에 추가합니다. 이 컬렉션의 예외 필터는 모든 Web API 컨트롤러 작업에 적용됩니다.

GlobalConfiguration.Configuration.Filters.Add(
    new ProductStore.NotImplExceptionFilterAttribute());

예시

모델 유효성 검사를 위해 모델 상태를 아래와 같이 CreateErrorResponse 메서드에 전달할 수 있습니다.

public HttpResponseMessage PostProduct(Product item)
{
    if (!ModelState.IsValid)
    {
        return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState);
    }
    // Implementation not shown...
}

ASP.NET Web API의 예외 처리 및 모델 유효성 검사에 대한 자세한 내용은 참조 섹션의 링크를 확인하세요.

오류 메시지에 보안 정보를 노출하지 않음

기본 오류 처리 페이지 구현

IIS에서 배포 방법을 일반 정품으로 설정

안전한 예외 실패

예시

        public static bool ValidateDomain(string pathToValidate, Uri currentUrl)
        {
            try
            {
                if (!string.IsNullOrWhiteSpace(pathToValidate))
                {
                    var domain = RetrieveDomain(currentUrl);
                    var replyPath = new Uri(pathToValidate);
                    var replyDomain = RetrieveDomain(replyPath);

                    if (string.Compare(domain, replyDomain, StringComparison.OrdinalIgnoreCase) != 0)
                    {
                        //// Adding additional check to enable CMS urls if they are not hosted on same domain.
                        if (!string.IsNullOrWhiteSpace(Utilities.CmsBase))
                        {
                            var cmsDomain = RetrieveDomain(new Uri(Utilities.Base.Trim()));
                            if (string.Compare(cmDomain, replyDomain, StringComparison.OrdinalIgnoreCase) != 0)
                            {
                                return false;
                            }
                            else
                            {
                                return true;
                            }
                        }

                        return false;
                    }
                }

                return true;
            }
            catch (UriFormatException ex)
            {
                LogHelper.LogException("Utilities:ValidateDomain", ex);
                return true;
            }
        }

예외가 발생하면 항상 위 메서드는 True를 반환합니다. 최종 사용자가 잘못된 형식의 URL을 제공할 경우 브라우저는 이를 유지하지만 Uri() 생성자는 그렇지 않을 경우 예외가 throw되며 사용자는 유효하지만 형식이 잘못된 URL을 사용하게 됩니다.