From 053bbdc39cba5fcf671c1af31a3532fb484a0171 Mon Sep 17 00:00:00 2001
From: Rossen <2720787+rossengeorgiev@users.noreply.github.com>
Date: Wed, 6 Oct 2021 23:37:08 +0100
Subject: [PATCH] guard: document secret.json format

Closes #363
---
 steam/guard.py | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/steam/guard.py b/steam/guard.py
index b4169d4..c5b4e27 100644
--- a/steam/guard.py
+++ b/steam/guard.py
@@ -44,6 +44,23 @@ Once authenticator is enabled all you need is the secrets to generate codes.
 You can obtain the authenticator secrets from an Android device using
 :func:`extract_secrets_from_android_rooted`. See the function docstring for
 details on what is required for it to work.
+
+Format of ``secrets.json`` file:
+
+.. code:: json
+
+    {
+        "account_name": "<username>",               # account username
+        "identity_secret": "<base64 encoded>",      # uknown
+        "revocation_code": "R51234",                # revocation code
+        "secret_1": "<base54 encoded>",             # unknown
+        "serial_number": "1111222333344445555",     # serial number
+        "server_time": "1600000000",                # creation timestamp
+        "shared_secret": "<base65 encoded>",        # secret used for code generation
+        "status": 1,                                # status, 1 = token active
+        "token_gid": "a1a1a1a1a1a1a1a1",            # token gid
+        "uri": "otpauth://totp/Steam:<username>?secret=<base32 encoded shared seceret>&issuer=Steam"
+    }
 """
 import json
 import subprocess