41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# CCryptoLib
|
|
An integrated collection of cryptographic primitives written in Lua using the ComputerCraft system API.
|
|
|
|
## Installation
|
|
A simple install script is provided, just run the following command: `wget run https://git.chrischro.me/ChrisChrome/ccryptolib/raw/branch/main/install.lua`
|
|
|
|
## Initialization
|
|
An `init.lua` is provided to allow easier access to all modules, use `crypto = require("ccryptolib")` in your script to use the module!
|
|
|
|
## Initializing the Random Number Generator
|
|
All functions that take secret input may query the library's random generator,
|
|
`ccryptolib.random`. CC doesn't have high-quality entropy sources, so instead of
|
|
hoping for the best like other libraries do, CCryptoLib shifts that burden into
|
|
*you!*
|
|
|
|
### Initializing using a Trusted Web Source
|
|
If you trust the tmpim Krist node, you can fetch a socket token and use it for
|
|
initialization:
|
|
```lua
|
|
local crypto = require("ccryptolib")
|
|
|
|
-- Fetch a WebSocket token.
|
|
local postHandle = assert(http.post("https://krist.dev/ws/start", ""))
|
|
local data = textutils.unserializeJSON(postHandle.readAll())
|
|
postHandle.close()
|
|
|
|
-- Initialize the generator using the given URL.
|
|
crypto.random.init(data.url)
|
|
|
|
-- Be polite and actually open the socket too.
|
|
http.websocket(data.url).close()
|
|
```
|
|
|
|
### Initializing using VM Instruction Counting
|
|
As of v1.2.0, you can also initialize the generator using VM instruction timing noise.
|
|
See the `random.initWithTiming` method for security risks of taking this approach.
|
|
```lua
|
|
local crypto = require("ccryptolib")
|
|
crypto.random.initWithTiming()
|
|
```
|