HTML 새니타이제이션

XSS 공격을 방지하기 위해 신뢰할 수 없는 HTML을 새니타이즈합니다. bluemonday 기반.

새니타이제이션은 HTML을 파싱하고 화이트리스트 정책을 통해 필터링하는 방식으로 작동합니다. 명시적으로 허용되지 않은 요소와 속성은 제거됩니다. 출력은 항상 올바른 형식의 HTML입니다.

로딩

local html = require("html")

프리셋 정책

일반적인 사용 사례를 위한 세 가지 내장 정책:

빈 정책

아무것도 허용하지 않는 정책을 생성합니다. 처음부터 커스텀 화이트리스트를 구축할 때 사용합니다.

local policy, err = html.sanitize.new_policy()

policy:allow_elements("p", "strong", "em")
policy:allow_attrs("class"):globally()

local clean = policy:sanitize(user_input)

반환: Policy, error

사용자 콘텐츠 정책

사용자 생성 콘텐츠용으로 미리 구성됨. 일반 서식 요소를 허용합니다.

local policy = html.sanitize.ugc_policy()

local safe = policy:sanitize('<p>Hello <strong>world</strong></p>')
-- '<p>Hello <strong>world</strong></p>'

local xss = policy:sanitize('<p>Hello <script>alert("xss")</script></p>')
-- '<p>Hello </p>'

반환: Policy, error

엄격 정책

모든 HTML을 제거하고 순수 텍스트만 반환합니다.

local policy = html.sanitize.strict_policy()

local text = policy:sanitize('<p>Hello <b>world</b>!</p>')
-- 'Hello world!'

반환: Policy, error

요소 제어

요소 허용

특정 HTML 요소를 화이트리스트에 추가합니다.

local policy = html.sanitize.new_policy()
policy:allow_elements("p", "strong", "em", "br")
policy:allow_elements("h1", "h2", "h3")
policy:allow_elements("a", "img")

local result = policy:sanitize('<p>Hello <strong>world</strong></p>')
-- '<p>Hello <strong>world</strong></p>'

반환: Policy

속성 제어

속성 허용

속성 권한을 시작합니다. on_elements() 또는 globally()와 체인합니다.

policy:allow_attrs("href"):on_elements("a")
policy:allow_attrs("src", "alt"):on_elements("img")
policy:allow_attrs("class", "id"):globally()

반환: AttrBuilder

특정 요소에서

특정 요소에서만 속성을 허용합니다.

policy:allow_elements("a", "img")
policy:allow_attrs("href", "target"):on_elements("a")
policy:allow_attrs("src", "alt", "width", "height"):on_elements("img")

반환: Policy

모든 요소에서

허용된 모든 요소에서 전역적으로 속성을 허용합니다.

policy:allow_attrs("class"):globally()
policy:allow_attrs("id"):globally()

반환: Policy

패턴 매칭으로

정규식 패턴에 대해 속성 값을 검증합니다.

-- style에서 hex 색상만 허용
local builder, err = policy:allow_attrs("style"):matching("^color:#[0-9a-fA-F]{6}$")
if err then
    return nil, err
end
builder:on_elements("span")

policy:sanitize('<span style="color:#ff0000">Red</span>')
-- '<span style="color:#ff0000">Red</span>'

policy:sanitize('<span style="background:red">Bad</span>')
-- '<span>Bad</span>'

반환: AttrBuilder, error

URL 보안

표준 URL

보안 기본값으로 URL 처리를 활성화합니다.

policy:allow_elements("a")
policy:allow_attrs("href"):on_elements("a")
policy:allow_standard_urls()

반환: Policy

URL 스킴

허용되는 URL 스킴을 제한합니다.

policy:allow_url_schemes("https", "mailto")

policy:sanitize('<a href="https://example.com">OK</a>')
-- '<a href="https://example.com">OK</a>'

policy:sanitize('<a href="javascript:alert(1)">XSS</a>')
-- '<a>XSS</a>'

반환: Policy

상대 URL

상대 URL을 허용하거나 거부합니다.

policy:allow_relative_urls(true)

policy:sanitize('<a href="/page">Link</a>')
-- '<a href="/page">Link</a>'

반환: Policy

Nofollow 링크

모든 링크에 rel="nofollow"를 추가합니다. SEO 스팸을 방지합니다.

policy:allow_attrs("href", "rel"):on_elements("a")
policy:require_nofollow_on_links(true)

policy:sanitize('<a href="https://example.com">Link</a>')
-- '<a href="https://example.com" rel="nofollow">Link</a>'

반환: Policy

Noreferrer 링크

모든 링크에 rel="noreferrer"를 추가합니다. referrer 누출을 방지합니다.

policy:require_noreferrer_on_links(true)

반환: Policy

외부 링크 새 탭에서

정규화된 URL에 target="_blank"를 추가합니다.

policy:allow_attrs("href", "target"):on_elements("a")
policy:add_target_blank_to_fully_qualified_links(true)

policy:sanitize('<a href="https://example.com">Link</a>')
-- '<a href="https://example.com" target="_blank">Link</a>'

반환: Policy

편의 메서드

이미지 허용

표준 속성과 함께 <img>를 허용합니다.

policy:allow_images()

policy:sanitize('<img src="photo.jpg" alt="Photo">')
-- '<img src="photo.jpg" alt="Photo">'

반환: Policy

데이터 URI 이미지 허용

base64 임베딩된 이미지를 허용합니다.

policy:allow_elements("img")
policy:allow_attrs("src"):on_elements("img")
policy:allow_data_uri_images()

policy:sanitize('<img src="data:image/png;base64,iVBORw...">')
-- '<img src="data:image/png;base64,iVBORw...">'

반환: Policy

목록 허용

목록 요소를 허용합니다: ul, ol, li, dl, dt, dd.

policy:allow_lists()

policy:sanitize('<ul><li>Item 1</li><li>Item 2</li></ul>')
-- '<ul><li>Item 1</li><li>Item 2</li></ul>'

반환: Policy

테이블 허용

테이블 요소를 허용합니다: table, thead, tbody, tfoot, tr, td, th, caption.

policy:allow_tables()

policy:sanitize('<table><tr><td>Cell</td></tr></table>')
-- '<table><tr><td>Cell</td></tr></table>'

반환: Policy

표준 속성 허용

일반 속성을 허용합니다: id, class, title, dir, lang.

policy:allow_elements("p")
policy:allow_standard_attributes()

policy:sanitize('<p id="intro" class="text" title="Introduction">Hello</p>')
-- '<p id="intro" class="text" title="Introduction">Hello</p>'

반환: Policy

새니타이즈

HTML 문자열에 정책을 적용합니다.

local policy = html.sanitize.ugc_policy()
policy:require_nofollow_on_links(true)

local dirty = '<p>Hello</p><script>alert("xss")</script>'
local clean = policy:sanitize(dirty)
-- '<p>Hello</p>'

반환: string

에러

에러 처리는 에러 처리를 참조하세요.