Skip to content
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.

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

DRAFT: Add README note for running TabPy without authentication #615

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .scrutinizer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ build:
coverage:
project_setup:
override:
- pip install --upgrade pip
- pip install -r requirements.txt
- pip install -r requirements_dev.txt
tests:
Expand All @@ -17,11 +18,13 @@ build:
analysis:
project_setup:
override:
- pip install --upgrade pip
- pip install -r requirements.txt
tests:
override: [py-scrutinizer-run]
tests:
before:
- pip install --upgrade pip
- pip install -r requirements.txt
override: [pytest]
checks:
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,18 @@ Consider reading TabPy documentation in the following order:
* [Authoring Python calculations in Tableau](docs/TableauConfiguration.md).
* [TabPy Tools](docs/tabpy-tools.md)

Important security note:

* By default, TabPy is configured without username/password authentication.
We strongly advise using TabPy only with authentication enabled. For more
information, see
[TabPy Server Configuration Instructions](docs/server-config.md#authentication).
Without authentication in place, if the TABPY_EVALUATE_ENABLE feature is
enabled (as it is by default), there is the possibility that unauthenticated
individuals could remotely execute code on the machine running TabPy.
Leaving these two settings in their default states together is highly
discouraged.

Troubleshooting:

* [TabPy Wiki](https://github.com/tableau/TabPy/wiki)
Expand Down
6 changes: 3 additions & 3 deletions docs/server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,14 +314,14 @@ For extended logging (e.g. for auditing purposes) additional logging can be turn
on with setting `TABPY_LOG_DETAILS` configuration file parameter to `true`.

With the feature on additional information is logged for HTTP requests: caller ip,
URL, client infomation (Tableau Desktop\Server), Tableau user name (for Tableau Server)
and TabPy user name as shown in the example below:
URL, client infomation (Tableau Desktop\Server) and TabPy user name as shown in
the example below:

<!-- markdownlint-disable MD013 -->
<!-- markdownlint-disable MD040 -->

```
2019-05-02,13:50:08 [INFO] (base_handler.py:base_handler:90): Call ID: 934073bd-0d29-46d3-b693-b1e4b1efa9e4, Caller: ::1, Method: POST, Resource: http://localhost:9004/evaluate, Client: Postman for manual testing, Tableau user: ogolovatyi
2019-05-02,13:50:08 [INFO] (base_handler.py:base_handler:90): Call ID: 934073bd-0d29-46d3-b693-b1e4b1efa9e4, Caller: ::1, Method: POST, Resource: http://localhost:9004/evaluate, Client: Postman for manual testing
2019-05-02,13:50:08 [DEBUG] (base_handler.py:base_handler:120): Checking if need to handle authentication, <<
call ID: 934073bd-0d29-46d3-b693-b1e4b1efa9e4>>
2019-05-02,13:50:08 [DEBUG] (base_handler.py:base_handler:120): Handling authentication, <<call ID: 934073bd-
Expand Down
Loading