Skip to content

docs: add documentation of client id to zauth readme #2967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
comawill merged 3 commits into from
Jan 11, 2023
Merged

docs: add documentation of client id to zauth readme #2967

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98906de
docs: add documentation of client id to zauth readme
comawill Jan 9, 2023
a7a18b3
doc: fix client_id specification
comawill Jan 9, 2023
13ea5d5
doc: make tag specification consistent
comawill Jan 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions libs/zauth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ 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
Copy link
Contributor

@mdimjasevic mdimjasevic Jan 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not too familiar with this syntax; what does ";" represent?

Copy link
Contributor Author

@comawill comawill Jan 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some languages use ; to indicate the a start of a comment.
I assumed it was used this way in the line 9, so so I tried to make it more consistent, because the parenthesis in line 10 seemed wrong to me

type-specific-data ::= <access-data> | <user-data> | <bot-data> | <provider-data>
access-data ::= "u=" <UUID> "." "c=" <Word64>
user-data ::= "u=" <UUID> "." "r=" <Word32>
access-data ::= "u=" <UUID> "." "c=" <Word64> ("i=" <Word32> | "")
user-data ::= "u=" <UUID> "." "r=" <Word32> ("i=" <Word32> | "")
bot-data ::= "p=" <UUID> "." "b=" <UUID> "." "c=" <UUID>
provider-data ::= "p=" <UUID>
```
Expand All @@ -21,6 +21,10 @@ provider-data ::= "p=" <UUID>

`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`
Expand All @@ -29,6 +33,10 @@ provider-data ::= "p=" <UUID>

`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:
Expand Down