From 59ea3bd25b1f113168333eccdc9ffc4acd98cfe6 Mon Sep 17 00:00:00 2001 From: Yigit Sever Date: Mon, 19 Apr 2021 18:23:22 +0300 Subject: Initial commit --- README.md | 10 ++++ config.toml | 28 +++++++++++ content/JWT.md | 41 ++++++++++++++++ content/_index.md | 98 ++++++++++++++++++++++++++++++++++++++ content/block_docs.md | 43 +++++++++++++++++ content/misc_docs.md | 17 +++++++ content/register_docs.md | 54 +++++++++++++++++++++ content/transaction_docs.md | 52 ++++++++++++++++++++ static/android-chrome-192x192.png | Bin 0 -> 26249 bytes static/android-chrome-512x512.png | Bin 0 -> 80376 bytes static/apple-touch-icon.png | Bin 0 -> 24023 bytes static/favicon-16x16.png | Bin 0 -> 878 bytes static/favicon-32x32.png | Bin 0 -> 2463 bytes static/favicon.ico | Bin 0 -> 15406 bytes static/gradecoin.png | Bin 0 -> 197656 bytes static/gradecoin.pub | 9 ++++ static/site.css | 57 ++++++++++++++++++++++ templates/_variables.html | 15 ++++++ templates/index.html | 68 ++++++++++++++++++++++++++ templates/shortcodes/exp.html | 1 + templates/shortcodes/tidbit.html | 5 ++ 21 files changed, 498 insertions(+) create mode 100644 README.md create mode 100644 config.toml create mode 100644 content/JWT.md create mode 100644 content/_index.md create mode 100644 content/block_docs.md create mode 100644 content/misc_docs.md create mode 100644 content/register_docs.md create mode 100644 content/transaction_docs.md create mode 100644 static/android-chrome-192x192.png create mode 100644 static/android-chrome-512x512.png create mode 100644 static/apple-touch-icon.png create mode 100644 static/favicon-16x16.png create mode 100644 static/favicon-32x32.png create mode 100644 static/favicon.ico create mode 100644 static/gradecoin.png create mode 100644 static/gradecoin.pub create mode 100644 static/site.css create mode 100644 templates/_variables.html create mode 100644 templates/index.html create mode 100644 templates/shortcodes/exp.html create mode 100644 templates/shortcodes/tidbit.html diff --git a/README.md b/README.md new file mode 100644 index 0000000..a4415af --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# Gradecoin Site +URL: https://gradecoin.xyz/ + +Uses [Zola](http://getzola.org/). + +```bash +zola serve --open # for local building & testing +zola build +``` + diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..070b762 --- /dev/null +++ b/config.toml @@ -0,0 +1,28 @@ +# The URL the site will be built for +base_url = "https://gradecoin.xyz" + +theme = "juice" + +title = "Gradecoin" +description = "Mine Your Grades" + +# Whether to automatically compile all Sass files in the sass directory +compile_sass = true + +# Whether to build a search index to be used later on by a JavaScript library +build_search_index = true + +[markdown] +# Whether to do syntax highlighting +# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola +highlight_code = true +highlight_theme = "subway-moscow" + +[extra] +# Put all your custom variables here +juice_logo_name = "Gradecoin" +juice_logo_path = "gradecoin.png" +juice_extra_menu = [ + { title = "why?", link = "https://github.com/zhuowei/nft_ptr#why"} +] + diff --git a/content/JWT.md b/content/JWT.md new file mode 100644 index 0000000..46da1a2 --- /dev/null +++ b/content/JWT.md @@ -0,0 +1,41 @@ ++++ +title = "JWT" +description = "JSON Web Token Documentation" +weight = 4 ++++ + +> JSON Web Tokens are representations of claims, or authorization proofs that fit into the `Header` of HTTP requests. + +# How? + +JWTs are used as the [MAC](https://en.wikipedia.org/wiki/Message_authentication_code) of operations that require authorization: +- block proposal +- transaction proposal. + +They are send alongside the JSON request body in the `Header`; + +```html +Authorization: Bearer aaaaaa.bbbbbb.ccccc +``` + +Gradecoin uses 3 fields for the JWTs; + +```json +{ +"tha": "Hash of the payload, check invididual references", +"iat": "Issued At, Unix Time", +"exp": "Expiration Time, epoch" +} +``` + +- `tha` is explained in [blocks](@/block_docs.md) and [transactions](@/transaction_docs.md) documentations. +- `iat` when the JWT was created in [Unix Time](https://en.wikipedia.org/wiki/Unix_time) format +- `exp` when the JWT will expire & be rejected in [Unix Time](https://en.wikipedia.org/wiki/Unix_time) + +# Algorithm +We are using [RS256](https://www.rfc-editor.org/rfc/rfc7518.html#section-3.1), `RSASSA-PKCS1-v1_5 using SHA-256`. The JWTs you encode with your private RSA key will be decoded using the public key you have authenticated with. You can see how the process works [here](https://jwt.io/). + +# References +- [RFC, the ultimate reference](https://tools.ietf.org/html/rfc7519) +- [JWT Debugger](https://jwt.io/) + diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..d0be673 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,98 @@ ++++ +title = "Gradecoin" +sort_by = "weight" ++++ + +# Welcome to Gradecoin! + +Blockchains are incredibly simple yet can appear very complicated, we will see how they work and practice programming _production_ cryptography code. + +This server is the sandbox for the PA1, it's currently running the Gradecoin application. Gradecoin is the faux currency we will use to simulate a blockchain network. At the end of the simulation, the amount of Gradecoin you hold will be your PA1 grade. + +**A quick summary**: authenticate yourself to the system using public key encryption. +Craft [Transaction](@/transaction_docs.md) proposals and tag them using [JWTs](@/JWT.md). +When there are enough transactions then you can propose [Blocks](@/block_docs.md) in the same way. +Blocks need to be _mined_ beforehand using Proof-of-work, or brute force. + +Gradecoin offers 3 endpoints at [/register](/register), [/block](/block) and [/transaction](/transaction). You can only send GET requests to /block and /transaction without authorization. +The server is programmed in [RESTful](https://www.service-architecture.com/articles/web-services/representational_state_transfer_rest.html) architecture, there are no `DELETE`, `PUT` or `UPDATE` operations, though. + +Gradecoin uses a Proof-of-work block accepting mechanism. It uses single round [Blake2s](https://www.blake2.net/) hashing which produces 256-bit (64 hexadecimal characters) output. The [target](https://wiki.bitcoinsv.io/index.php/Target) hash is _24 bits_ or _6 hexadecimal characters_ of 0. During testing, I could mine a block on average around 4-6 minutes. + +> We're expecting you to use existing tools and implementations. Standards are hard. [Don't roll your own crypto](https://www.reddit.com/r/crypto/comments/2coqsy/dont_roll_your_own/). Feel free to ask questions. Collaborate. + +You might ask, + +> But if nobody has any Gradecoin then how do we have transactions? + +There is a bank! Their public key is `31415926535897932384626433832795028841971693993751058209749445923` and they have some amount of Gradecoin preloaded. It's also the only account that you can send transactions requests _to_ yourself. + +# Coinbase +The first transactions of a block is called the `coinbase`. They are the **author** of the block proposal and if the block is accepted then they get compensated for their efforts with some Gradecoin. + +# Public Key Signatures +Gradecoin uses 2048 bit RSA keypairs. + +# Services +## /register +- Create your own 2048 bit RSA `keypair` +- Download `Gradecoin`'s Public Key from [Moodle](https://odtuclass.metu.edu.tr/my/) +- Encrypt your [JSON](https://www.json.org/json-en.html) wrapped `Public Key`, `Student ID` and one time `passwd` using Gradecoin's Public Key +- Your public key is now in our database and can be used to sign your JWT's during requests +- For more information, check the [register](@/register_docs.md) page + +## /transaction +- You can offer a [Transaction](@/transaction_docs.md) with a POST request + - The request should have `Authorization` + - The request header should be signed by the Public Key of the `by` field in the transaction +- Fetch the list of `Transaction`s with a GET request +- For more information, check our [transaction](@/transaction_docs.md) page + +## /block +- Offer a [Block](@/block_docs.md) with a POST request + - The request should have `Authorization` + - The `transaction_list` of the block should be a subset of pending transactions, available on [/transaction](/transaction) +- Fetch the last accepted `Block` with a GET request +- For more information, check our [block](@/block_docs.md) page + + `Authorization`: The request header should have Bearer JWT.Token signed with Student Public Key + +## /user +- Meant to be used in the browser, you can see the current list of users and their balance here + +# Questions +## This all sound complicated! +- I've drawn inspiration from [actual Bitcoin transactions](https://explorer.bitcoin.com/btc) and [warp](https://github.com/seanmonstar/warp/blob/master/examples/todos.rs). The simplicity of the system is how little interfaces it has. +- Don't know where to start? Gradecoin uses RESTful API; simple `curl` commands or even your browser will work! [This website can help as well](https://curl.trillworks.com/). +- [JWT Debugger](https://jwt.io) and the corresponding [RFC](https://tools.ietf.org/html/rfc7519). +- Remember that you are absolutely encouraged to grab off-the-shelf implementations for every cryptography primitive you will use. You can start by finding a code snippet to generate a RSA keypair? +- Check out [misc](@/misc_docs.md) for everything else you might be curious about. + +## How do you actually earn Gradecoin? +- Register yourself to at [/register](@/register_docs.md) +- Create transactions at [/transaction](@/transaction_docs.md) +- Create blocks to commit transactions at [/block](@/block_docs.md) +- See how everyone is doing and find people to trade with at [/user](/user) + +## I found a bug! +Thank you! Please [let me know](mailto:yigit@ceng.metu.edu.tr) so we can solve it. + +## I hacked the server! +That wasn't supposed to happen :( I did not place any intentional vulnerabilities to the system so if you cracked something, it was not intended. Please don't abuse it and let me know so I can patch it. + +## Submission? +At the end of the _simulation_, your Gradecoin balance will be your grade. I will also expect a unique client programmed in either; +- c +- c++ +- perl +- rust +- python +- random assortment of bash scripts + +If your favourite programming language is missing please let me know 🤷? + +## Can my friends play? +Sadly, no. Student's who are enrolled to the class will receive one-time-passwords for authentication. + +## How and or Why? +- [Built](https://xkcd.com/2314/), [with](https://lofi.cafe/) [Rust](https://xkcd.com/2418/) diff --git a/content/block_docs.md b/content/block_docs.md new file mode 100644 index 0000000..92880b6 --- /dev/null +++ b/content/block_docs.md @@ -0,0 +1,43 @@ ++++ +title = "Blocks" +description = "Block Documentation" +weight = 10 ++++ + +A block that was proposed to commit Transactions in `transaction_list` to the +ledger with a nonce that made `hash` valid; 6 zeroes at the left hand side of the +hash (24 bytes). + +We are _mining_ using [blake2s](https://www.blake2.net/) algorithm, which produces 256 bit hashes. Hash/second is roughly {{ exp(num="20x10", exponent="3") }} on my machine, a new block can be mined in around 4-6 minutes. + +# Requests + +## GET +A HTTP `GET` request to [/block](/block) endpoint will return the latest mined block. + +## POST + +A HTTP `POST` request with Authorization using JWT will allow you to propose your own blocks. + +# Fields +``` +transaction_list: [array of Fingerprints] +nonce: unsigned 32-bit integer +timestamp: ISO 8601 T