Documentation

Support

Vivox Unity SDK

Vivox Unity SDK

Key rotation

Rotate your Vivox access token signing keys securely.
Read time 1 minuteLast updated 2 days ago
According to security best practices, it is recommended that you rotate the token signing key on a periodic basis (typically monthly). The Vivox system allows each issuer to have two keys active simultaneously, which you can use to rotate keys with no interruption in service. To perform key rotation, complete the following steps:
  1. Obtain the time to live that is used when generating access tokens. (For demonstration purposes, this example uses "TTL" as this value.)
  2. Add your new key by using the included vivox_admin.py code as follows: 
    python vivox_admin.py add_key -shttps://assigned_subdomain.www.vivox.com/api2/ -u your_admin_username -pyour_admin_password -i your_issuer -k your_new_key
  3. Change your game server to begin issuing tokens by using the new key.
  4. Wait for a period of 2*TTL seconds.
  5. Remove your old key by using the included vivox_admin.py code as follows: 
    python vivox_admin.py revoke_key -shttps://assigned_subdomain.www.vivox.com/api2/ -u your_admin_username -pyour_admin_password -i your_issuer -k your_old_key