Skip to content

Add input validation for html param in setHTML() #2035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnMcLear merged 2 commits into from
Dec 16, 2013
Merged

Add input validation for html param in setHTML() #2035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7dd2945
Remove duplicate doc entry for setHTML()
lebrinkma Dec 14, 2013
dd8af99
Add input validation for html param in setHTML()
lebrinkma Dec 14, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions doc/api/http_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,16 +285,6 @@ sets the text of a pad
* `{code: 1, message:"padID does not exist", data: null}`
* `{code: 1, message:"text too long", data: null}`

#### setHTML(padID, html)
* API >= 1

sets the text of a pad based on HTML, HTML must be well formed. Malformed HTML will send a warning to the API log

*Example returns:*
* `{code: 0, message:"ok", data: null}`
* `{code: 1, message:"padID does not exist", data: null}`


#### getHTML(padID, [rev])
* API >= 1

Expand All @@ -304,15 +294,14 @@ returns the text of a pad formatted as HTML
* `{code: 0, message:"ok", data: {html:"Welcome Text<br>More Text"}}`
* `{code: 1, message:"padID does not exist", data: null}`

#### setHTML(padID, text)
#### setHTML(padID, html)
* API >= 1

sets the html of a pad
sets the text of a pad based on HTML, HTML must be well formed. Malformed HTML will send a warning to the API log.

*Example returns:*
* `{code: 0, message:"ok", data: null}`
* `{code: 1, message:"padID does not exist", data: null}`
* `{code: 1, message:"text too long", data: null}`

#### getAttributePool(padID)
* API >= 1.2.8
Expand Down
15 changes: 15 additions & 0 deletions src/node/db/API.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,8 +382,23 @@ exports.getHTML = function(padID, rev, callback)
});
}

/**
setHTML(padID, html) sets the text of a pad based on HTML

Example returns:

{code: 0, message:"ok", data: null}
{code: 1, message:"padID does not exist", data: null}
*/
exports.setHTML = function(padID, html, callback)
{
//html is required
if(typeof html != "string")
Copy link
Copy Markdown
Member

@JohnMcLear JohnMcLear Dec 15, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this really qualify as input validation? :)

Copy link
Copy Markdown
Contributor Author

@lebrinkma lebrinkma Dec 16, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JohnMcLear
It's a basic input validation. :)
It fixes the server crashes if setHTML is called with no html parameter.

I stumbled across this issue when calling setHTML with the parameter text instead of html as the doc in current develop states.
The doc is already fixed in this branch.

You are welcome to propose a better fix for this issue.

{
callback(new customError("html is no string","apierror"));
return;
}

//get the pad
getPadSafe(padID, true, function(err, pad)
{
Expand Down