A command-line utility to generate an API key for Tinode server
Parameters:
sequence: Sequential number of the API key. This value can be used to reject previously issued keys.isroot: Currently unused. Intended to designate key of a system administrator.validate: Key to validate: check previously issued key for validity.salt: HMAC salt, 32 random bytes base64 standard encoded; must be present for key validation; optional when generating the key: if missing, a cryptographically-strong salt will be automatically generated.
The API key is used to provide some protection from automatic scraping of server API and for identification of client applications.
API keyis used on the client side.HMAC saltis used on the server side to verify the API key.
Run the generator:
./keygenSample output:
API key v1 seq1 [ordinary]: AQAAAAABAACGOIyP2vh5avSff5oVvMpk
HMAC salt: TC0Jzr8f28kAspXrb4UYccJUJ63b7CSA16n1qMxxGpw=
Copy HMAC salt to api_key_salt parameter in your server config file.
Copy API key to the client applications:
- TinodeWeb:
API_KEYin config.js - Tindroid:
API_KEYin Cache.java - Tinodious:
kApiKeyin SharedUtils.swift
Rebuild the clients after changing the API key.