You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "amoghrajesh (via GitHub)" <gi...@apache.org> on 2024/01/17 04:22:23 UTC
[PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
amoghrajesh opened a new pull request, #36829:
URL: https://github.com/apache/airflow/pull/36829
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
We had to revert the change https://github.com/apache/airflow/pull/36826 due to the potential risk of HTML injection. To fix that properly, I have added a fix which does the following:
1. If any tags are present in the log lines, it will sanitize it by escaping the HTML so that the UI wont render it
2. If not, it will proceed as usual, which is convert it to a hyperlink
Added the following in a task of a DAG to test it:
```
print("http://example.com")
print("http://apache.org/</a><b>bad-stuff!</b>")
print("back to normal")
print("<b>does this work?</b>")
print("<div onmouseover=\"alert('hi');\">hello</div>")
```
Results look like so:

<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #36829:
URL: https://github.com/apache/airflow/pull/36829#discussion_r1462697843
##########
airflow/www/static/js/dag/details/taskInstance/Logs/utils.ts:
##########
@@ -97,6 +101,17 @@ export const parseLogs = (
line.includes(fileSourceFilter)
)
) {
+ const tagRegex = /<[a-z][\s\S]*>/i;
Review Comment:
Yeah makes sense, working on it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "bbovenzi (via GitHub)" <gi...@apache.org>.
bbovenzi commented on code in PR #36829:
URL: https://github.com/apache/airflow/pull/36829#discussion_r1462169646
##########
airflow/www/static/js/dag/details/taskInstance/Logs/utils.ts:
##########
@@ -97,6 +101,17 @@ export const parseLogs = (
line.includes(fileSourceFilter)
)
) {
+ const tagRegex = /<[a-z][\s\S]*>/i;
Review Comment:
Perhaps we should use a real library to sanitize our string: https://www.npmjs.com/package/sanitize-html
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #36829:
URL: https://github.com/apache/airflow/pull/36829#discussion_r1464286997
##########
airflow/www/static/js/dag/details/taskInstance/Logs/utils.ts:
##########
@@ -97,7 +99,30 @@ export const parseLogs = (
line.includes(fileSourceFilter)
)
) {
- parsedLines.push(parsedLine);
+ // sanitize the lines to remove any tags that may cause HTML injection
+ const sanitizedLine = sanitizeHtml(parsedLine, {
+ allowedTags: ["a"],
+ allowedAttributes: {
+ a: ["href", "target", "style"],
+ },
+ transformTags: {
+ a: (tagName: any, attribs: { style: string }) => {
Review Comment:
You are correct, made the change and it did take the ypes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #36829:
URL: https://github.com/apache/airflow/pull/36829#issuecomment-1905262526
@bbovenzi attempted it and for the same log messages as the description, these are the results:

It sanitizes any harmful HTML tags and only allows anchor tags converts the lines with links to hyperlinks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #36829:
URL: https://github.com/apache/airflow/pull/36829#issuecomment-1894915438
@jedcunningham @bbovenzi tried fixing it properly this time, let me know what you think.
@jedcunningham: I used the cases that you had used to test, many thanks :D
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "bbovenzi (via GitHub)" <gi...@apache.org>.
bbovenzi commented on code in PR #36829:
URL: https://github.com/apache/airflow/pull/36829#discussion_r1463599836
##########
airflow/www/static/js/dag/details/taskInstance/Logs/utils.ts:
##########
@@ -21,6 +21,8 @@
import { defaultFormatWithTZ } from "src/datetime_utils";
+const sanitizeHtml = require("sanitize-html");
Review Comment:
```suggestion
import sanitizeHtml from "sanitize-html";
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #36829:
URL: https://github.com/apache/airflow/pull/36829#issuecomment-1905262527
@bbovenzi attempted it and for the same log messages as the description, these are the results:

It sanitizes any harmful HTML tags and only allows anchor tags converts the lines with links to hyperlinks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #36829:
URL: https://github.com/apache/airflow/pull/36829
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #36829:
URL: https://github.com/apache/airflow/pull/36829#discussion_r1464284504
##########
airflow/www/static/js/dag/details/taskInstance/Logs/utils.ts:
##########
@@ -21,6 +21,8 @@
import { defaultFormatWithTZ } from "src/datetime_utils";
+const sanitizeHtml = require("sanitize-html");
Review Comment:
Cool, made the changes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "bbovenzi (via GitHub)" <gi...@apache.org>.
bbovenzi commented on code in PR #36829:
URL: https://github.com/apache/airflow/pull/36829#discussion_r1463605227
##########
airflow/www/static/js/dag/details/taskInstance/Logs/utils.ts:
##########
@@ -97,7 +99,30 @@ export const parseLogs = (
line.includes(fileSourceFilter)
)
) {
- parsedLines.push(parsedLine);
+ // sanitize the lines to remove any tags that may cause HTML injection
+ const sanitizedLine = sanitizeHtml(parsedLine, {
+ allowedTags: ["a"],
+ allowedAttributes: {
+ a: ["href", "target", "style"],
+ },
+ transformTags: {
+ a: (tagName: any, attribs: { style: string }) => {
Review Comment:
Let's do the types correctly with `yarn add -D @types/sanitize-html`
Then I think it should automatically infer the types for tagName and attribs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #36829:
URL: https://github.com/apache/airflow/pull/36829#issuecomment-1905273903
@bbovenzi pushed the changes using the sanitize-html library, can you take a look?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Making links in task logs as hyperlinks by preventing HTML injection [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #36829:
URL: https://github.com/apache/airflow/pull/36829#discussion_r1464286997
##########
airflow/www/static/js/dag/details/taskInstance/Logs/utils.ts:
##########
@@ -97,7 +99,30 @@ export const parseLogs = (
line.includes(fileSourceFilter)
)
) {
- parsedLines.push(parsedLine);
+ // sanitize the lines to remove any tags that may cause HTML injection
+ const sanitizedLine = sanitizeHtml(parsedLine, {
+ allowedTags: ["a"],
+ allowedAttributes: {
+ a: ["href", "target", "style"],
+ },
+ transformTags: {
+ a: (tagName: any, attribs: { style: string }) => {
Review Comment:
You are correct, made the change and it did take the types type implicitly
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org