Экранирование строк HTML с помощью jQuery

кто-нибудь знает простой способ избежать HTML из строк в jQuery? Мне нужно иметь возможность передавать произвольную строку и правильно экранировать ее для отображения на HTML-странице (предотвращая атаки инъекций JavaScript/HTML). Я уверен, что для этого можно расширить jQuery, но на данный момент я недостаточно знаю о структуре, чтобы выполнить это.

24 ответов


Так как вы используете jQuery, вы можете просто установить элемент text свойства:

// before:
// <div class="someClass">text</div>
var someHtmlString = "<script>alert('hi!');</script>";

// set a DIV's text:
$("div.someClass").text(someHtmlString);
// after: 
// <div class="someClass">&lt;script&gt;alert('hi!');&lt;/script&gt;</div>

// get the text in a string:
var escaped = $("<div>").text(someHtmlString).html();
// value: 
// &lt;script&gt;alert('hi!');&lt;/script&gt;

появилась раствор из усов.js

var entityMap = {
  '&': '&amp;',
  '<': '&lt;',
  '>': '&gt;',
  '"': '&quot;',
  "'": '&#39;',
  '/': '&#x2F;',
  '`': '&#x60;',
  '=': '&#x3D;'
};

function escapeHtml (string) {
  return String(string).replace(/[&<>"'`=\/]/g, function (s) {
    return entityMap[s];
  });
}

$('<div/>').text('This is fun & stuff').html(); // "This is fun &amp; stuff"

источник: http://debuggable.com/posts/encode-html-entities-with-jquery:480f4dd6-13cc-4ce9-8071-4710cbdd56cb


если вы убегаете для HTML, есть только три, которые я могу придумать, что было бы действительно необходимо:

html.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");

в зависимости от вашего варианта использования вам также может потребоваться сделать такие вещи, как " to &quot;. Если список стал достаточно большим, я бы просто использовал массив:

var escaped = html;
var findReplace = [[/&/g, "&amp;"], [/</g, "&lt;"], [/>/g, "&gt;"], [/"/g, "&quot;"]]
for(var item in findReplace)
    escaped = escaped.replace(findReplace[item][0], findReplace[item][1]);

encodeURIComponent() будет избегать его только для URL-адресов, а не для HTML.


Я написал маленькую функцию, которая делает это. Он только ускользает ", &, < и > (но обычно это все, что вам нужно в любом случае). Это немного более элегантно, чем ранее предложенные решения в том, что он использует только один .replace() чтобы сделать все преобразования. (EDIT 2: уменьшенная сложность кода делает функцию еще меньше и аккуратнее, если вам интересно узнать исходный код, см. Конец этого ответа.)

function escapeHtml(text) {
    'use strict';
    return text.replace(/[\"&<>]/g, function (a) {
        return { '"': '&quot;', '&': '&amp;', '<': '&lt;', '>': '&gt;' }[a];
    });
}

этот простой Javascript, не используется jQuery.

побег / и ' слишком

редактировать в ответ на mklementкомментарий.

вышеуказанную функцию можно легко расширить для включения любого характера. Чтобы указать больше символов для escape, просто вставьте их в класс символов в регулярном выражении (т. е. внутри /[...]/g) и как запись в


достаточно легко использовать подчеркивания:

_.escape(string) 

подчеркивание - это служебная библиотека, которая предоставляет множество функций, которые не предоставляет собственный js. Есть также лодашь который является тем же API, что и подчеркивание, но был переписан, чтобы быть более эффективным.


Я понимаю, как поздно я на эту вечеринку, но у меня есть очень простое решение, которое не требует jQuery.

escaped = new Option(unescaped).innerHTML;

Edit: это не экранирует кавычки. Единственный случай, когда кавычки должны быть экранированы, - это если содержимое будет вставлено в атрибут внутри строки HTML. Мне трудно представить случай, когда это было бы хорошим дизайном.

Edit 2: Если производительность имеет решающее значение, наиболее высокопроизводительное решение (примерно на 50%) по-прежнему серия regex заменяет. Современные браузеры обнаружат, что регулярные выражения не содержат операторов, а только строку, и свернут их все в одну операцию.


вот чистая, ясная функция JavaScript. Он будет избегать текста, такого как" несколько

function escapeHtmlEntities (str) {
  if (typeof jQuery !== 'undefined') {
    // Create an empty div to use as a container,
    // then put the raw text in and get the HTML
    // equivalent out.
    return jQuery('<div/>').text(str).html();
  }

  // No jQuery, so use string replace.
  return str
    .replace(/&/g, '&amp;')
    .replace(/>/g, '&gt;')
    .replace(/</g, '&lt;')
    .replace(/"/g, '&quot;')
    .replace(/'/g, '&apos;');
}

попробовать подчеркивания.строка lib, он работает с jQuery.

_.str.escapeHTML('<div>Blah blah blah</div>')

выход:

'&lt;div&gt;Blah blah blah&lt;/div&gt;'

после последних тестов я могу рекомендовать быстрый и окончательно кросс-браузер совместимость родной javaScript (DOM) решение:

function HTMLescape(html){
    return document.createElement('div')
        .appendChild(document.createTextNode(html))
        .parentNode
        .innerHTML
}

Если вы повторите его много раз, вы можете сделать это с помощью однажды подготовленных переменных:

//prepare variables
var DOMtext = document.createTextNode("test");
var DOMnative = document.createElement("span");
DOMnative.appendChild(DOMtext);

//main work for each case
function HTMLescape(html){
  DOMtext.nodeValue = html;
  return DOMnative.innerHTML
}

посмотри на мое последнее выступление сравнение (стека вопрос).


я увеличил усы.в JS пример добавления элемента escapeHTML() метод для объекта string.

var __entityMap = {
    "&": "&amp;",
    "<": "&lt;",
    ">": "&gt;",
    '"': '&quot;',
    "'": '&#39;',
    "/": '&#x2F;'
};

String.prototype.escapeHTML = function() {
    return String(this).replace(/[&<>"'\/]/g, function (s) {
        return __entityMap[s];
    });
}

таким образом, он довольно прост в использовании "Some <text>, more Text&Text".escapeHTML()


escape() и unescape() предназначены для кодирования / декодирования строк для URL-адресов, а не HTML.

на самом деле, я использую следующий фрагмент кода, чтобы сделать трюк, который не требует каких-либо рамок:

var escapedHtml = html.replace(/&/g, '&amp;')
                      .replace(/>/g, '&gt;')
                      .replace(/</g, '&lt;')
                      .replace(/"/g, '&quot;')
                      .replace(/'/g, '&apos;');

Если у вас есть подчеркивания.Яш, используйте _.escape (более эффективный, чем метод jQuery, опубликованный выше):

_.escape('Curly, Larry & Moe'); // returns: Curly, Larry &amp; Moe

Если ваш собираемся маршрута regex, там ошибка в примере выше tghw по.

<!-- WON'T WORK -  item[0] is an index, not an item -->

var escaped = html; 
var findReplace = [[/&/g, "&amp;"], [/</g, "&lt;"], [/>/g,"&gt;"], [/"/g,
"&quot;"]]

for(var item in findReplace) {
     escaped = escaped.replace(item[0], item[1]);   
}


<!-- WORKS - findReplace[item[]] correctly references contents -->

var escaped = html;
var findReplace = [[/&/g, "&amp;"], [/</g, "&lt;"], [/>/g, "&gt;"], [/"/g, "&quot;"]]

for(var item in findReplace) {
     escaped = escaped.replace(findReplace[item[0]], findReplace[item[1]]);
}

Это хороший пример...

function escapeHtml(str) {
    if (typeof(str) == "string"){
        try{
            var newStr = "";
            var nextCode = 0;
            for (var i = 0;i < str.length;i++){
                nextCode = str.charCodeAt(i);
                if (nextCode > 0 && nextCode < 128){
                    newStr += "&#"+nextCode+";";
                }
                else{
                    newStr += "?";
                }
             }
             return newStr;
        }
        catch(err){
        }
    }
    else{
        return str;
    }
}

вы можете легко сделать это с помощью vanilla js.

просто добавьте текстовый узел в документ. Он будет экранирован браузером.

var escaped = document.createTextNode("<HTML TO/ESCAPE/>")
document.getElementById("[PARENT_NODE]").appendChild(escaped)

(function(undefined){
    var charsToReplace = {
        '&': '&amp;',
        '<': '&lt;',
        '>': '&gt;'
    };

    var replaceReg = new RegExp("[" + Object.keys(charsToReplace).join("") + "]", "g");
    var replaceFn = function(tag){ return charsToReplace[tag] || tag; };

    var replaceRegF = function(replaceMap) {
        return (new RegExp("[" + Object.keys(charsToReplace).concat(Object.keys(replaceMap)).join("") + "]", "gi"));
    };
    var replaceFnF = function(replaceMap) {
        return function(tag){ return replaceMap[tag] || charsToReplace[tag] || tag; };
    };

    String.prototype.htmlEscape = function(replaceMap) {
        if (replaceMap === undefined) return this.replace(replaceReg, replaceFn);
        return this.replace(replaceRegF(replaceMap), replaceFnF(replaceMap));
    };
})();

нет глобальных переменных, оптимизация памяти. Использование:

"some<tag>and&symbol©".htmlEscape({'©': '&copy;'})

результат:

"some&lt;tag&gt;and&amp;symbol&copy;"

function htmlEscape(str) {
    var stringval="";
    $.each(str, function (i, element) {
        alert(element);
        stringval += element
            .replace(/&/g, '&amp;')
            .replace(/"/g, '&quot;')
            .replace(/'/g, '&#39;')
            .replace(/</g, '&lt;')
            .replace(/>/g, '&gt;')
            .replace(' ', '-')
            .replace('?', '-')
            .replace(':', '-')
            .replace('|', '-')
            .replace('.', '-');
    });
    alert(stringval);
    return String(stringval);
}

2 простых метода, которые не требуют JQUERY...

вы можете кодировать все символы в строке такой:

function encode(e){return e.replace(/[^]/g,function(e){return"&#"+e.charCodeAt(0)+";"})}

или просто цель главных героев волноваться о &, разрывы строк <, >, " и ' как:

function encode(r){
return r.replace(/[\x26\x0A\<>'"]/g,function(r){return"&#"+r.charCodeAt(0)+";"})
}

var myString='Encode HTML entities!\n"Safe" escape <script></'+'script> & other tags!';

test.value=encode(myString);

testing.innerHTML=encode(myString);

/*************
* \x26 is &ampersand (it has to be first),
* \x0A is newline,
*************/
<p><b>What JavaScript Generated:</b></p>

<textarea id=test rows="3" cols="55"></textarea>

<p><b>What It Renders Too In HTML:</b></p>

<div id="testing">www.WHAK.com</div>

простой JavaScript escaping пример:

function escapeHtml(text) {
    var div = document.createElement('div');
    div.innerText = text;
    return div.innerHTML;
}

escapeHtml("<script>alert('hi!');</script>")
// "&lt;script&gt;alert('hi!');&lt;/script&gt;"

function htmlDecode(t){
   if (t) return $('<div />').html(t).text();
}

работает


ответ предоставляет методы jQuery и normal JS, но это самое короткое без использования DOM:

unescape(escape("It's > 20% less complicated this way."))

сбежал строку: It%27s%20%3E%2020%25%20less%20complicated%20this%20way.

если беглые пространства беспокоят вас, попробуйте:

unescape(escape("It's > 20% less complicated this way.").replace(/%20/g, " "))

сбежал строку: It%27s %3E 20%25 less complicated this way.

к сожалению,


Если вы сохраняете эту информацию в база данных, неправильно избегать HTML с помощью на стороне клиента скрипт, это должно быть сделано в сервер. В противном случае его легко обойти защиту XSS.

чтобы сделать мою точку зрения понятно, приведу пример, используя один из ответов:

допустим, вы используете функцию escapeHtml, чтобы избежать Html из комментария в своем блоге, а затем опубликовать его в своем сервер.

var entityMap = {
    "&": "&amp;",
    "<": "&lt;",
    ">": "&gt;",
    '"': '&quot;',
    "'": '&#39;',
    "/": '&#x2F;'
  };

  function escapeHtml(string) {
    return String(string).replace(/[&<>"'\/]/g, function (s) {
      return entityMap[s];
    });
  }

пользователь:

  • измените параметры запроса POST и замените комментарий кодом javascript.
  • переписать функцию escapeHtml с помощью консоли браузера.

если пользователь вставит этот фрагмент в консоль, он обойдет проверку XSS:

function escapeHtml(string){
   return string
}

все решения бесполезны, если вы не предотвратите повторный побег, например, большинство решений будут продолжать бежать & to &amp;.

escapeHtml = function (s) {
    return s ? s.replace(
        /[&<>'"]/g,
        function (c, offset, str) {
            if (c === "&") {
                var substr = str.substring(offset, offset + 6);
                if (/&(amp|lt|gt|apos|quot);/.test(substr)) {
                    // already escaped, do not re-escape
                    return c;
                }
            }
            return "&" + {
                "&": "amp",
                "<": "lt",
                ">": "gt",
                "'": "apos",
                '"': "quot"
            }[c] + ";";
        }
    ) : "";
};