From 98906de2d605f2d9f187ce7bcdc5d9bc4c429c97 Mon Sep 17 00:00:00 2001 From: Sebastian Willenborg Date: Mon, 9 Jan 2023 15:55:18 +0100 Subject: [PATCH 1/3] docs: add documentation of client id to zauth readme --- libs/zauth/README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/libs/zauth/README.md b/libs/zauth/README.md index ef15882c19..22958cfc4f 100644 --- a/libs/zauth/README.md +++ b/libs/zauth/README.md @@ -8,9 +8,10 @@ key-index ::= "k=" Integer (> 0) timestamp ::= "d=" Integer (POSIX timestamp, expiration time) type ::= "t=" ("a" | "u" | "b" | "p") ; access, user, bot, provider tag ::= "l=" ("s" | "" (session or nothing)) -type-specific-data ::= | | | +type-specific-data ::= | | | | access-data ::= "u=" "." "c=" user-data ::= "u=" "." "r=" +client-data ::= "i=" bot-data ::= "p=" "." "b=" "." "c=" provider-data ::= "p=" ``` @@ -21,6 +22,10 @@ provider-data ::= "p=" `7B2fdkjqBm0BZEpvF_1itY-W22LM2RWLDIQgu2k7d-BJojlMfyNpVfXYPEQiWpcCztmwZO_yphgKhhtKetiuCw==.v=1.k=1.d=1409335821.t=u.l=.u=c5eda68f-93f3-4413-93fe-d45e81f8a9f9.r=bb3d1d9f` +#### User-Token (with client id) + +`vpJs7PEgwtsuzGlMY0-Vqs22s8o9ZDlp7wJrPmhCgIfg0NoTAxvxq5OtknabLMfNTEW9amn5tyeUM7tbFZABBA==.v=1.k=1.d=1466770905.t=u.l=.u=6562d941-4f40-4db4-b96e-56a06d71c2c3.r=4feacc.i=deadbeef` + ### User-Token (Session) `7CPhoJv6TOYr7epokS6S2pj0nLoV-mJ_o5iRUII3JM5jBItZzluXNNGb-u476EYQM0fpr1qUGK2eRuKCZuELBA==.v=1.k=1.d=1429832092.t=u.l=s.u=161e7fe7-9a71-4ffd-9a79-de9ee2fa178c.r=3f6a49c4` @@ -29,6 +34,10 @@ provider-data ::= "p=" `5Bdn6CnDO2yIng7_MblYFhMNEo27ESsHsZmD40fNpcTdEybk15dw7zUVOcJDeFyf6QbEsZF4ruNKRu1ICmbzCg==.v=1.k=1.d=1419834921.t=a.l=.u=c5eda68f-93f3-4413-93fe-d45e81f8a9f9.c=8875802285613998639` +#### Access-Token (with client id) + +`aEPOxMwUriGEv2qc7Pb672ygy-6VeJ-8VrX3jmwalZr7xygU4izyCWxiT7IXfybnNGIsk1FQPb0RRVPx1s2UCw==.v=1.k=1.d=1466770783.t=a.l=.u=6562d941-4f40-4db4-b96e-56a06d71c2c3.c=11019722839397809329.i=deadbeef` + # Token creation Given: From a7a18b32a1e6fefded9dfe86be68900ae0591c50 Mon Sep 17 00:00:00 2001 From: Sebastian Willenborg Date: Mon, 9 Jan 2023 16:09:02 +0100 Subject: [PATCH 2/3] doc: fix client_id specification --- libs/zauth/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/libs/zauth/README.md b/libs/zauth/README.md index 22958cfc4f..5fec815cb8 100644 --- a/libs/zauth/README.md +++ b/libs/zauth/README.md @@ -8,10 +8,9 @@ key-index ::= "k=" Integer (> 0) timestamp ::= "d=" Integer (POSIX timestamp, expiration time) type ::= "t=" ("a" | "u" | "b" | "p") ; access, user, bot, provider tag ::= "l=" ("s" | "" (session or nothing)) -type-specific-data ::= | | | | -access-data ::= "u=" "." "c=" -user-data ::= "u=" "." "r=" -client-data ::= "i=" +type-specific-data ::= | | | +access-data ::= "u=" "." "c=" ("i=" | "") +user-data ::= "u=" "." "r=" ("i=" | "") bot-data ::= "p=" "." "b=" "." "c=" provider-data ::= "p=" ``` From 13ea5d5a8d169c5da547c1d5a4cf41587b61e39b Mon Sep 17 00:00:00 2001 From: Sebastian Willenborg Date: Mon, 9 Jan 2023 16:09:52 +0100 Subject: [PATCH 3/3] doc: make tag specification consistent --- libs/zauth/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libs/zauth/README.md b/libs/zauth/README.md index 5fec815cb8..bd3cc12b48 100644 --- a/libs/zauth/README.md +++ b/libs/zauth/README.md @@ -7,7 +7,7 @@ version ::= "v=" Integer key-index ::= "k=" Integer (> 0) timestamp ::= "d=" Integer (POSIX timestamp, expiration time) type ::= "t=" ("a" | "u" | "b" | "p") ; access, user, bot, provider -tag ::= "l=" ("s" | "" (session or nothing)) +tag ::= "l=" ("s" | "") ; session or nothing type-specific-data ::= | | | access-data ::= "u=" "." "c=" ("i=" | "") user-data ::= "u=" "." "r=" ("i=" | "")