From 57ff15f8f46d4a1f885be9e5263273f275b693b7 Mon Sep 17 00:00:00 2001 From: Nat Lasseter Date: Fri, 30 Sep 2022 09:00:51 +0100 Subject: Clarify readme --- Readme.textile | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) (limited to 'Readme.textile') diff --git a/Readme.textile b/Readme.textile index 8997f39..d824368 100644 --- a/Readme.textile +++ b/Readme.textile @@ -30,14 +30,18 @@ p. The twofa secrets file is normally found at @~./twofa@, and each record has t p. If a HOTP code is requested, the file will be canoncalised. +p. Each issuer should appear on it's own line with the following format: + +bc. Method Issuer Secret [TDC [Length [Hash]]] + h4. Required fields -- Method := The OTP type, currently @totp@ or @hotp@ -- Issuer := Human name for this issuer -- Secret := The BASE32 shared secret +- Method := The OTP type, currently @totp@ or @hotp@. +- Issuer := Human name to identify this issuer. +- Secret := The BASE32 shared secret. h4. Optional fields -- Time interval or Counter := Either the time interval (for TOTP) or counter (for HOTP). The former defaults to 30 if not given, the latter to 0. +- TDC := Either the time delta (for TOTP) or counter (for HOTP). The former defaults to 30 if not given, the latter to 0. - Length := The output code length. Defaults to 6 digits. -- Hashing algorithm := The algorithm used to generate the HMAS hash. Defaults to @sha1@. +- Hash := The algorithm used to generate the HMAC hash. Defaults to @sha1@. -- cgit v1.2.1