X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;ds=sidebyside;f=proto.txt;h=e8d235c27f8903c7b6581630fcd55a65d17f944d;hb=143d4f50570aaa85a401dc232df0942dd061b3ab;hp=278abc0eb359f4da93684494c74a8d82ab99f750;hpb=06198f841ce4e49e7894f4ad82148dda08d58ddc;p=tpg%2Fopendispense2.git diff --git a/proto.txt b/proto.txt index 278abc0..e8d235c 100644 --- a/proto.txt +++ b/proto.txt @@ -17,13 +17,22 @@ All server responses are on one line and are prefixed by a three digit response 406 Bad Item ID 500 Unknown Dispense Failure +== Item IDs == + represents the item ID +Item IDs are allowed to contain any non-whitespace character, but in +general they will be limited to the standard alpha-numeric set === User Auth === c USER \n -s 100 SALT \n -c PASS \n (Hash of ) +s 100 SALT \n or 100 User Set\n (If no salt used) +c PASS \n (Hex-Encoded SHA-512 Hash of ) s 200 Auth OK\n or 401 Auth Failure\n User is now authenticated +--- Alternate Method (Implicit Trust Authentication) --- +If the client is connecting from a trusted machine on a root port then +automatic authentication is allowed +c AUTOAUTH \n +s 200 Auth OK\n or 401 Auth Failure\n or 401 Untrusted\n === Commands === --- Get Item list --- @@ -31,7 +40,7 @@ c ENUM_ITEMS\n s 201 Items ...\n --- Get Item Information --- c ITEM_INFO \n -s 202 Item ""\n +s 202 Item \n --- Dispense an item --- c DISPENSE \n s 200 Dispense OK\n or 402 Poor You\n or 500 Dispense Error\n or 406 Bad Item\n @@ -39,10 +48,10 @@ s 200 Dispense OK\n or 402 Poor You\n or 500 Dispense Error\n or 406 Bad Item\n c GIVE \n s 200 Give OK\n or 402 Poor You\n or 404 Bad User\n --- Update balance --- -c ADD ""\n +c ADD \n s 200 Add OK\n or 403 Not Coke\n or 404 Bad User\n --- Set Balance --- -c SET ""\n +c SET \n s 200 Set OK\n or 403 Not allowed\n or 404 Bad User\n --- Get Users Balances --- c ENUM_USERS[ ]\n