Skip to content
This repository was archived by the owner on May 23, 2022. It is now read-only.

Commit 469a94b

Browse files
committed
Add links, split "Scopes and WLCG Groups" into two, mention caching
1 parent 6a8c382 commit 469a94b

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/security/tokens/overview.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ SciTokens and WLCG Tokens are similar standards and have some common claims:
3636
The issuer identifies the organization that issued the token.
3737
An issuer looks like an HTTPS URL;
3838
this URL must be valid and publicly accessible as they are used by site services to validate the token.
39-
Token issuers will be described below.
39+
Token issuers will be [described below](#issuer).
4040

4141
**Subject ("sub")**
4242

4343
The subject identifies an entity (which could be a human or a robot) that owns the token.
4444
Unlike the subject of an X.509 certificate, a token subject does not need to be globally unique,
4545
only unique to the issuer.
46-
Subjects will be elaborated on below.
46+
Subjects will be [elaborated on below](#subject).
4747

4848
**Issued-at ("iat"), not-before ("nbf"), expiration ("exp")**
4949

@@ -62,8 +62,9 @@ used on any server.
6262

6363
The scope limits the actions that can be made using the token.
6464
The format of the scope claim differs between SciTokens and WLCG Tokens;
65-
scopes in use by OSG services will be listed below.
66-
65+
scopes in use by OSG services will be [listed below](#scopes).
66+
WLCG Tokens may have a `wlcg.group` instead of a scope, [as described below](#wlcg-groups).
67+
6768

6869
### Issuer ###
6970

@@ -78,6 +79,9 @@ This server must have the public key that can be used to validate the token in a
7879
as described by the [OpenID Connect Discovery standard](https://openid.net/specs/openid-connect-discovery-1_0.html).
7980
If the issuer is down, or the the public key cannot be downloaded, the token cannot be verified
8081
and will be rejected.
82+
Note that most clients will cache the public key.
83+
In order to ease the token transition, the current cache lifetime is 4 days,
84+
but at some point this will be lowered to a few hours.
8185

8286
A collaboration may have more than one token issuer,
8387
but a single token issuer should never serve more than one collaboration.
@@ -98,7 +102,7 @@ that can be used for mapping, banning, accounting, monitoring, auditing, or trac
98102
Tracing a token to a user or service may require contacting the issuer.
99103

100104

101-
### Scopes and WLCG Groups ###
105+
### Scopes ###
102106

103107
The `scope` claim is a space-separated list of authorizations that should be granted to the bearer.
104108
Scopes utilized by OSG services include the following:
@@ -114,8 +118,11 @@ Replacing `<PATH>` with a path to the storage location that the bearer should be
114118

115119
A SciToken must have a non-empty scope, or it cannot be used to do anything.
116120

121+
122+
### WLCG Groups ###
123+
117124
A WLCG Token may have a `wlcg.groups` claim instead of a scope.
118-
This is a comma and space separated list of collaboration groups.
125+
The `wlcg.groups` claim is a comma and space separated list of collaboration groups.
119126
The format of these groups are similar to VOMS FQANs: `/<collaboration>[/<group>][/Role=<role>]`,
120127
replacing `<collaboration>`, `<group>`, and `<role>` with the collaboration, group, and role, respectively, where the
121128
group and role are optional.

0 commit comments

Comments
 (0)