4players / odin-tokens
A lightweight token generator for 4Players ODIN
Installs: 8
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
pkg:composer/4players/odin-tokens
Requires
- php: >=7.2
- paragonie/sodium_compat: 1.*
README
This is a lightweight package to generate API keys and tokens used for ODIN Voice by 4Players.
ODIN Voice by 4Players GmbH is a cross-platform software development kit (SDK) that enables developers to integrate voice and video chat technology into multiplayer games, apps and websites. Check out our full online documentation!
Flowchart
graph TB RandomBytes[Random Bytes] --> AccessKey; AccessKey --> PublicKey; AccessKey --> SecretKey; PublicKey --> KeyId;Loading
Example
use FourPlayers\Odin\TokenGenerator; $accessKey = "<YOUR ACCESS KEY HERE>"; $generator = new TokenGenerator($accessKey); $token = $generator->createToken("my room", "john doe"); echo "generated a new token: $token\n"
Terminology
| Term | Description | 
|---|---|
| AccessKey | Gives access to the ODIN network for a customer. It is a 44 character long Base64-String, which consists of a version, random bytes and a checksum. | 
| SecretKey | Generated from the AccessKey, it is based on the Ed25519-Curve and used to sign a Token generated by the customer. | 
| PublicKey | Generated from the AccessKey, it is based on the Ed25519-Curve and must be uploaded to 4Players so that a generated Token can be verified. | 
| KeyId | A shortened PublicKey, included in Token, making it possible to identify what PublicKey must be used to verify the Token. | 
| Token | A JWT given to the game clients that allows them to connect to a voice/video chat room in the ODIN network. |