Code Monkey home page Code Monkey logo

vue-sanitize's Introduction

vue-sanitize

Whitelist-based HTML sanitizer (sanitize-html) for Vue.js apps.

Software License Packagist Latest Version Issues

Note

We should always sanitize user input values on the server. Do sanitize with Vue only for necessary cases (e.g markdown preview).

Install

npm install --save vue-sanitize

or

yarn add vue-sanitize

Usage

Register the plugin

import VueSanitize from "vue-sanitize";
Vue.use(VueSanitize);

You can pass default options too:

defaultOptions = {
    allowedTags: ['a', 'b'],
    allowedAttributes: {
      'a': [ 'href' ]
    }
};
Vue.use(VueSanitize, defaultOptions);

Use it in your components:

<template>
  <div contenteditable="true" @paste="sanitize"></div>
</template>

<script>
export default {
  methods: {
    sanitize(event) {
      event.preventDefault();
      const html = this.$sanitize(event.clipboardData.getData('text/html'));
      //or
      //const html = this.$sanitize(
      //  event.clipboardData.getData('text/html'),
      //  {
      //    allowedTags: ['b', 'br']
      //  }
      //);
      document.execCommand('insertHTML', false, (html));
    }
  },
}
</script>

API

Vue.use(VueSanitize[, defaultOptions])

options

  • Type: Object

This plugin is dependent on sanitize-html. For details, see here https://github.com/punkave/sanitize-html#readme.

this.$sanitize(diarty[, options])

diarty

  • Type: String
  • Required: true

options

  • Type: Object

If you don't pass an options, the default options will be used.

VueSanitize.defaults

Return sanitizeHtml.defaults.

Change log

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

The MIT License (MIT). Please see License File for more information.

vue-sanitize's People

Contributors

daichirata avatar daverogers avatar dependabot[bot] avatar theworkerant avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

vue-sanitize's Issues

error on use with CDN

If try use vue-sanitize in html page:
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/vue-sanitize.min.js"></script>
script throw error - require not defined.

Your example isn't safe

Given the purpose of this package is to sanitize HTML before rendering in Vue (presumably to prevent XSS attacks), the example you have given isn't actually safe.

This is your example setup:

defaultOptions = {
    allowedTags: ['a', 'b'],
    allowedAttributes: {
      'a': [ 'href' ]
    }
};
Vue.use(VueSanitize, defaultOptions);

This would still allow an attacker to do the following: <a href="javascript:someDangerousScript()">Click here</a>.

You should probably add a note to your example - unless this package sanitizes the href tag to remove javascript?

Dependency "sanitize-html" was updated and brokes the compilation of source code

Due to the definition of the sanitize-html dependency as "^2.7.0", provoke that an update of this library to the version 2.8.0 two days ago (2022/12/12) broke the compilation of the source code of our application.
It seems that it was an error related with a third party library dependency, htmlparser2 with the version 8.0.0, the reason that provokes the error.
The error we're getting is the following:

⠼  Building for production as library (commonjs,umd,umd-min)...

 ERROR  Failed to compile with 1 error                                                                                                                   15:31:05

 error  in ./node_modules/htmlparser2/lib/esm/index.js

Module parse failed: Unexpected token (59:9)
You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file. See https://webpack.js.org/concepts#loaders
|     return getFeed(parseDOM(feed, options));
| }
> export * as DomUtils from "domutils";
| // Old name for DomHandler
| export { DomHandler as DefaultHandler };

 @ ./node_modules/sanitize-html/index.js 1:19-41
 @ ./node_modules/vue-sanitize/dist/vue-sanitize.js
 @ ./src/index.js
 @ ./node_modules/@vue/cli-service/lib/commands/build/entry-lib.js

This error doesn't happen with the previous version 2.7.3 of sanitize-html because the version of htmlparser2 library was 6.0.0, and with this version all seems to work fine.

A possible solution is to fix the version of sanitize-html, instead of using ^2.7.0 better use ~2.7.0.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.