Skip to content

Commit

Permalink
Rename: Files related to VSCode extension.
Browse files Browse the repository at this point in the history
  • Loading branch information
bjones1 committed Apr 19, 2022
1 parent 3b07939 commit a6f8808
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ syntax: glob
_build/

# TypeScript transpiles.
extensions/VSCode_Extension/out
extensions/VSCode_Extension/.vscode
extensions/VSCode/out
extensions/VSCode/.vscode

# Python-generated files
__pycache__/
Expand Down
2 changes: 1 addition & 1 deletion CodeChat_Server/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ The server listens to three ports, as shown in `/docs/developer`:

These ports should **never** be exposed publicly; they provide an attacker significant access to the underlying computer's filesystem. To mitigate this risk, the CodeChat Server by default only accepts connections from the computer it runs on, by binding only the ``LOCALHOST`` address defined in `CodeChat_Server/constants.py`.

**However**, the server also supports an optional insecure mode, in which it bypasses this protection by allowing connections from *any* computer. For example, `/extensions/VSCode_Extension/contents` can run on a remote Docker container using the `VS Code Remote Development <https://code.visualstudio.com/docs/remote/remote-overview>`_ toolset. In this mode, **attackers allowed to connect to these ports will have access to the server's filesystem**.
**However**, the server also supports an optional insecure mode, in which it bypasses this protection by allowing connections from *any* computer. For example, `/extensions/VSCode/contents` can run on a remote Docker container using the `VS Code Remote Development <https://code.visualstudio.com/docs/remote/remote-overview>`_ toolset. In this mode, **attackers allowed to connect to these ports will have access to the server's filesystem**.

To improve security, **never expose these ports publicly**.
2 changes: 1 addition & 1 deletion CodeChat_Services/run_thrift.bat
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ REM This requires the `Apache Thrift compiler <https://thrift.apache.org/downloa

mkdir ..\CodeChat_Server\CodeChat_Server\gen_py
thrift-0.16.0.exe --gen py --strict -out ..\CodeChat_Server\CodeChat_Server\gen_py CodeChat_Services.thrift
thrift-0.16.0.exe --gen js:node,ts --strict -o ..\extensions\VSCode_Extension\src CodeChat_Services.thrift
thrift-0.16.0.exe --gen js:node,ts --strict -o ..\extensions\VSCode\src CodeChat_Services.thrift
6 changes: 3 additions & 3 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,9 @@
"_build",

# JavaScript/TypeScript generated files
"extensions/VSCode_Extension/node_modules",
"extensions/VSCode_Extension/out",
"extensions/VSCode_Extension/.vscode",
"extensions/VSCode/node_modules",
"extensions/VSCode/out",
"extensions/VSCode/.vscode",
"**/gen-*",
"**/gen_*",

Expand Down
2 changes: 1 addition & 1 deletion extensions/VSCode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ In addition to native support for Markdown and reStructuredText, the CodeChat Sy

... and many more.

See the [getting started guide](https://codechat-system.readthedocs.io/en/latest/extensions/VSCode_Extension/contents.html) to install and use the CodeChat System.
See the [getting started guide](https://codechat-system.readthedocs.io/en/latest/extensions/VSCode/contents.html) to install and use the CodeChat System.
2 changes: 1 addition & 1 deletion extensions/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This directory contains documentation for all supported text editor/IDE extensio
.. toctree::
:maxdepth: 2

VSCode_Extension/contents
VSCode/contents
universal


Expand Down

0 comments on commit a6f8808

Please sign in to comment.