Skip to content

Commit

Permalink
update readme for new version
Browse files Browse the repository at this point in the history
  • Loading branch information
fechan committed May 10, 2020
1 parent a5bcc19 commit e942308
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Players can write something to ask WolframAlpha in a Book and Quill. If the book

More functionality may be added in the future.

Security considerations
--
The plugin is basically building a Wolfram language string and giving it to the Mathematica kernel to evaluate. This is potentially unsafe, since players can potentially write whatever. If they write something that escapes a string in Mathematica, they can perform a Mathematica injection, which is like a SQL injection but with Mathematica. Even with the input sanitation, I would only use this plugin among people who you *trust absolutely*.

Setup
--
**You need to have Mathematica installed in order for this plugin to work!**

Put the plugin's jar file in the server's plugin directory. If it doesn't exist already, also create a `lib` folder in the plugin directory. Copy the file `JLink.jar` and `SystemFiles` from `${MATHEMATICA_INSTALL_DIRECTORY}/SystemFiles/Links/JLink/` into the `lib` folder. Then start the server.
Put the plugin's jar file in the server's plugin directory. If it doesn't exist already, also create a `lib` folder in the plugin directory. Copy the file `JLink.jar` and `SystemFiles` from `${MATHEMATICA_INSTALL_DIRECTORY}/SystemFiles/Links/JLink/` into the `lib` folder. Then start the server.

Security considerations
--
Version 1.0-SNAPSHOT had potentially unsafe behavior which has been fixed in 1.1-SNAPSHOT and above. I **highly reccommend** you not use 1.0-SNAPSHOT. The problem is described as such: The plugin is basically building a Wolfram language string and giving it to the Mathematica kernel to evaluate. This is potentially unsafe, since players can potentially write whatever. If they write something that escapes a string in Mathematica, they can perform a Mathematica injection, which is like a SQL injection but with Mathematica. Even with the input sanitation, I would only use this plugin among people who you *trust absolutely*.

0 comments on commit e942308

Please sign in to comment.