-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(security): add security docs page (#650)
* docs(security): add security docs page * update wording on docs
- Loading branch information
1 parent
6661a53
commit a502841
Showing
4 changed files
with
64 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
previousText: 'CORS Errors' | ||
previousUrl: '/docs/faq/cors' | ||
nextText: 'Developer Tips' | ||
nextUrl: '/docs/faq/tips' | ||
disableHtmlPreviews: true | ||
contributors: | ||
- liamdebeasi | ||
--- | ||
|
||
# Security | ||
|
||
## Sanitizing User Input | ||
|
||
For components such as `ion-alert` developers can allow for custom or user-provided content. This content can be plain text or HTML and should be considered untrusted. As with any untrusted input, it is important to sanitize it before doing anything else with it. In particular, using things like `innerHTML` without sanitization provides an attack vector for bad actors to input malicious content and potentially launch a [Cross Site Scripting attack (XSS)](<https://en.wikipedia.org/wiki/Cross-site_scripting>). | ||
|
||
Ionic comes built in with basic sanitization methods for the components it provides, but for user-created components it is up to the developer to make sure all data is sanitized. Different frameworks have different solutions for sanitizing user input, so developers should familiarize themselves with what their specific framework offers. | ||
|
||
For developers who are not using a framework, or for developers whose framework does not provide the sanitization methods they need, we recommend using [sanitize-html](<https://www.npmjs.com/package/sanitize-html>). This package provides a simple HTML sanitizer that allows the developer to specify the exact tags and attributes that they want to allow in their application. | ||
|
||
### Angular | ||
|
||
Angular comes built in with the `DomSanitizer` class. This helps prevent XSS issues by ensuring that values are safe to be used in the DOM. By default, Angular will mark any values it deems unsafe. For example, the following link would be marked as unsafe by Angular because it would attempt to execute some JavaScript. | ||
|
||
```typescript | ||
public myUrl: string = 'javascript:alert("oh no!")'; | ||
|
||
... | ||
|
||
<a [href]="myUrl">Click Me!</a> | ||
``` | ||
|
||
To learn more about the built-in protections that Angular provides, see the [Angular Security Guide](https://angular.io/guide/security). | ||
|
||
### React | ||
|
||
React DOM escapes values embedded in JSX before rendering them by converting them to strings. For example, the following would be safe as `name` is converted to a string before being rendered: | ||
|
||
```jsx | ||
const name = values.name; | ||
const element = <h1>Hello, {name}!</h1>; | ||
``` | ||
|
||
However, this does not stop someone from injecting JavaScript into places such as the `href` attribute of an anchor element. The following is unsafe and can potentially allow an XSS attack to occur: | ||
|
||
```jsx | ||
const userInput = 'javascript:alert("Oh no!")'; | ||
const element = <a href={userInput}>Click Me!</a> | ||
``` | ||
|
||
If the developer needs to achieve more comprehensive sanitization, they can use the [sanitize-html](<https://www.npmjs.com/package/sanitize-html>) package. | ||
|
||
To learn more about the built-in protections that React and JSX provide, see the [React JSX Documentation](https://reactjs.org/docs/introducing-jsx.html#jsx-prevents-injection-attacks). | ||
|
||
### Vue | ||
|
||
Vue does not provide any type of sanitizing methods built in. It is recommended that developers use a package such as [sanitize-html](<https://www.npmjs.com/package/sanitize-html>). | ||
|
||
To learn more about the security recommendations for binding to directives such as `v-html`, see the [Vue Syntax Guide](https://vuejs.org/v2/guide/syntax.html#Raw-HTML). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters