-
Notifications
You must be signed in to change notification settings - Fork 313
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #86 from MercuryWorkshop/main
Updated Docs Branch
- Loading branch information
Showing
27 changed files
with
763 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,7 @@ rootfs/* | |
node_modules | ||
anurax86.tar.gz | ||
symlinks | ||
images/ | ||
build/images/ | ||
build/ | ||
dist/ | ||
bios/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,26 @@ | ||
#TODO | ||
# Credits | ||
|
||
- Contributors | ||
|
||
- A full list of contributors can be found [here](https://github.com/MercuryWorkshop/anuraOS/graphs/contributors) | ||
|
||
- Libraries | ||
|
||
- Filesystem - [Filer.js](https://filer.js.org/) | ||
- Filesystem HTTP bridge - [MercuryWorkshop Nohost](https://github.com/MercuryWorkshop/nohost) (Fork of [Humphd Nohost](https://github.com/humphd/nohost)) | ||
- x86 Emulation - [v86](https://copy.sh/v86/) | ||
- A full list of dependencies can be found [here](https://github.com/MercuryWorkshop/anuraOS/network/dependencies) | ||
|
||
- Code snippets used | ||
|
||
Note: This list is non-exhaustive and may not contain all of the code snippets used in production of this software. | ||
|
||
- [original base](https://gist.github.com/chwkai/290488) | ||
- [Material Design Pure CSS Switch](https://codepen.io/sajran/pen/dMKvpb) by [sajran](https://codepen.io/sajran) | ||
- [Material Design Pure CSS Contained Button](https://codepen.io/finnhvman/pen/MQyJxV) by [finnhvman](https://codepen.io/finnhvman) | ||
|
||
- Design & Assets | ||
|
||
- UI design inspiration - [Google ChromeOS](https://www.google.com/chromebook/chrome-os/) | ||
- Various icons - [papirus icon theme](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme) | ||
- Various assets - [Google ChromeOS](https://www.google.com/chromebook/chrome-os/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,24 @@ | ||
# Security Blueprint | ||
This Document will explain what and how security features are implemented in AnuraOS. | ||
|
||
|
||
This Document will explain what and how security features are implemented in AnuraOS. | ||
|
||
## Secure Math | ||
|
||
In Anura, when coding in a cryptographic/security sensitive context, we replace `Math.random()` with our own function `cryptoRandom()`. `cryptoRandom()` is a direct replacement for `Math.random()` and the two are fully interchangeable. If you would like to implement `cryptoRandom()` you can use the following steps(for TypeScript): | ||
In Anura, when coding in a cryptographic/security sensitive context, we replace `Math.random()` with our own function `cryptoRandom()`. `cryptoRandom()` is a direct replacement for `Math.random()` and the two are fully interchangeable. If you would like to implement `cryptoRandom()` you can use the following steps(for TypeScript): | ||
|
||
1. If not already installed, run `npm install @types/node` | ||
2. Add `import * as crypto from "crypto";` to the head of whatever file in which you would like to replace `Math.random()` | ||
3. Add the following function to your code: | ||
|
||
1. If not already installed, run `npm install @types/node` | ||
2. Add `import * as crypto from "crypto";` to the head of whatever file in which you would like to replace `Math.random()` | ||
3. Add the following function to your code: | ||
|
||
```ts | ||
function cryptoRandom() { | ||
const typedArray = new Uint8Array(1); | ||
const randomValue = crypto.getRandomValues(typedArray)[0]; | ||
const randomFloat = randomValue / Math.pow(2, 8); | ||
return randomFloat; | ||
const typedArray = new Uint8Array(1); | ||
const randomValue = crypto.getRandomValues(typedArray)[0]; | ||
const randomFloat = randomValue / Math.pow(2, 8); | ||
return randomFloat; | ||
} | ||
``` | ||
|
||
4. You can now replace `Math.random()` anywhere in your code with `cryptoRandom()`. | ||
|
||
## TODO |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.