Escapando cadeias HTML com jQuery

Alguém sabe uma maneira fácil de escapar HTML de seqüências de caracteres no jQuery ? Eu preciso ser capaz de passar uma string arbitrária e fazer com que ela escape corretamente para exibição em uma página HTML (evitando ataques de injeção de JavaScript / HTML). Tenho certeza de que é possível estender o jQuery para fazer isso, mas não sei o suficiente sobre a estrutura no momento para fazer isso.

Como você está usando jQuery , você pode apenas definir a textpropriedade do elemento :

// 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;

Há também a solução do moustache.js

var entityMap = {
  '&': '&',
  '<': '&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"

Fonte: http://debuggable.com/posts/encode-html-entities-with-jquery:480f4dd6-13cc-4ce9-8071-4710cbdd56cb

Se você está fugindo para HTML, existem apenas três que eu posso pensar que seriam realmente necessários:

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

Dependendo do seu caso de uso, você também pode precisar de fazer coisas como "a ". Se a lista fosse grande o suficiente, eu apenas usaria uma matriz:

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() escapará apenas para URLs, não para HTML.

Fácil o suficiente para usar sublinhado:

_.escape(string) 

O Underscore é uma biblioteca de utilitários que fornece muitos recursos que o js nativo não fornece. Há também o lodash, que é a mesma API que o sublinhado, mas foi reescrito para ter melhor desempenho.

Eu escrevi uma pequena função que faz isso. Ele só escapa ", &, <e >(mas geralmente isso é tudo que você precisa de qualquer maneira). É um pouco mais elegante do que as soluções propostas anteriormente, pois usa apenas uma .replace() para fazer toda a conversão. ( EDIÇÃO 2: complexidade do código reduzida, tornando a função ainda menor e mais organizada, se você estiver curioso sobre o código original, veja o final desta resposta.)

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

Isso é Javascript simples, sem jQuery usado.

Escapando /e 'também

Edite em resposta ao comentário de mklement .

A função acima pode ser facilmente expandida para incluir qualquer caractere. Para especificar mais caracteres para escapar, basta inseri-los na classe de caracteres na expressão regular (ou seja, dentro da /[...]/g) e como uma entrada no chrobjeto. ( EDIT 2: Também reduziu esta função, da mesma maneira.)

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

Observe o uso acima de 'para apóstrofo (a entidade simbólica 'poderia ter sido usado em vez disso - ele é definido em XML, mas não foi originalmente incluído no HTML especificação e pode, portanto, não ser suportado por todos os navegadores Veja:. Artigo da Wikipedia sobre codificação de caracteres em HTML ) Também me lembro de ler em algum lugar que o uso de entidades decimais é mais amplamente suportado do que o hexadecimal, mas não consigo encontrar a fonte para isso agora. (E não pode haver muitos navegadores por aí que não suportem entidades hexadecimais.)

Nota: Adicionar /e 'à lista de caracteres de escape não é tão útil, pois eles não têm nenhum significado especial em HTML e não precisam ser escapados.

escapeHtmlFunção original

EDIT 2: A função original usava uma variável ( chr) para armazenar o objeto necessário para o .replace()retorno de chamada. Essa variável também precisava de uma função anônima extra para fazer o escopo, tornando a função (desnecessariamente) um pouco maior e mais complexa.

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

Eu não testei qual das duas versões é mais rápida. Se o fizer, sinta-se à vontade para adicionar informações e links sobre isso aqui.

Percebo como estou atrasado para esta festa, mas tenho uma solução muito fácil que não requer jQuery.

escaped = new Option(unescaped).innerHTML;

Edit: Isso não escapa aspas. O único caso em que as aspas precisariam ser escapadas é se o conteúdo será colado inline em um atributo dentro de uma string HTML. É difícil para mim imaginar um caso em que fazer isso seria um bom design.

Edit 3: Para a solução mais rápida, verifique a resposta acima em Saram. Este é o mais curto.

Aqui está uma função JavaScript limpa e clara. Ele escapará de textos como "alguns <muitos" para "alguns poucos".

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;');
}

Após os últimos testes, posso recomendar a solução javaScript (DOM) nativa mais rápida e completamente compatível com o navegador :

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

Se você repetir várias vezes, poderá fazê-lo com variáveis ​​preparadas uma vez:

//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
}

Olhe para o meu desempenho final comparação ( questão da pilha ).

Tente Underscore.string lib, ele funciona com jQuery.

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

resultado:

'<div>Blah blah blah</div>'

Aprimorei o exemplo mustache.js adicionando o escapeHTML()método ao objeto string.

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

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

Dessa forma, é bastante fácil de usar "Some <text>, more Text&Text".escapeHTML()

escape()e unescape()se destina a codificar / decodificar seqüências de caracteres para URLs, não HTML.

Na verdade, eu uso o seguinte snippet para executar o truque que não requer nenhuma estrutura:

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

Se você tiver underscore.js, use _.escape(mais eficiente que o método jQuery publicado acima):

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

Se você estiver seguindo a rota regex, há um erro no exemplo do tghw acima.

<!-- 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]]);
}

Este é um bom exemplo seguro ...

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;
    }
}

Você pode fazer isso facilmente com vanilla js.

Basta adicionar um nó de texto ao documento. Será escapado pelo navegador.

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

(function(undefined){
    var charsToReplace = {
        '&': '&',
        '<': '&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));
    };
})();

Sem variáveis ​​globais, alguma otimização de memória. Uso:

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

O resultado é:

"some<tag>and&symbol©"

2 métodos simples que não requerem consulta ...

Você pode codificar todos os caracteres em sua string assim:

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

Ou apenas como alvo os principais personagens que se preocupar &, quebras de linha, <, >, "e 'como:

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>

Exemplo simples de escape de JavaScript:

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

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

Funciona como um encanto

Esta resposta fornece os métodos jQuery e JS normais, mas é mais curta sem usar o DOM:

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

String com escape: It%27s%20%3E%2020%25%20less%20complicated%20this%20way.

Se os espaços escapados o incomodarem, tente:

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

String com escape: It%27s %3E 20%25 less complicated this way.

Infelizmente, a escape()função foi descontinuada no JavaScript versão 1.5 . encodeURI()ou encodeURIComponent()são alternativas, mas eles ignoram ', portanto a última linha de código se tornaria isso:

decodeURI(encodeURI("It's > 20% less complicated this way.").replace(/%20/g, " ").replace("'", '%27'))

Todos os principais navegadores ainda suportam o código curto e, dado o número de sites antigos, duvido que isso mude em breve.

ES6 one liner para a solução from mustache.js

const escapeHTML = str => (str+'').replace(/[&<>"'`=\/]/g, s => ({'&': '&amp;','<': '&lt;','>': '&gt;','"': '&quot;',"'": '&#39;','/': '&#x2F;','`': '&#x60;','=': '&#x3D;'})[s]);

Se você estiver salvando essas informações em um banco de dados , é errado escapar do HTML usando um script do lado do cliente , isso deve ser feito no servidor . Caso contrário, é fácil ignorar sua proteção XSS.

Para deixar claro meu argumento, aqui está um exemplo usando uma das respostas:

Digamos que você esteja usando a função escapeHtml para escapar do Html de um comentário no seu blog e depois publicá-lo no seu servidor.

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

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

O usuário pode:

• Edite os parâmetros de solicitação POST e substitua o comentário pelo código javascript.
• Substitua a função escapeHtml usando o console do navegador.

Se o usuário colar esse trecho no console, ele ignorará a validação do XSS:

function escapeHtml(string){
   return string
}

Todas as soluções são inúteis se você não evitar re-escape, por exemplo, a maioria das soluções seria manter escapar &para &.

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] + ";";
        }
    ) : "";
};