Merging to release-5: [DX-1097] Update SessionState protobuf document…

…ation to include BasicAuthData and example hash algorithms (#4324) [DX-1097] Update SessionState protobuf documentation to include BasicAuthData and example hash algorithms (#4324) * update basic_auth with hashed password and add BasicAuthData example --------- Co-authored-by: Simon Pears <[email protected]> Co-authored-by: Yaara <[email protected]>
TykTechnologies · Apr 24, 2024 · b07f9e4 · b07f9e4
1 parent a435b94
commit b07f9e4
Showing 1 changed file with 24 additions and 3 deletions.
diff --git a/...ontent/plugins/supported-languages/rich-plugins/rich-plugins-data-structures.md b/...ontent/plugins/supported-languages/rich-plugins/rich-plugins-data-structures.md
@@ -207,7 +207,8 @@ The organisation this user belongs to. This can be used in conjunction with the
 This is set by Tyk if the token is generated by an OAuth client during an OAuth authorisation flow.
 
 `basic_auth_data`
-This section defines the basic auth password and hashing method.
+This section contains a hashed representation of the basic auth password and the hashing method used.
+For further details see [BasicAuthData](#basicauthdata-coprocess_session_stateproto).
 
 `jwt_data`
 Added to sessions where a Tyk key (embedding a shared secret) is used as the public key for signing the JWT. The JWT token's KID header value references the ID of a Tyk key. See [JWTData](#jwtdata-session_stateproto) for an example.
@@ -347,7 +348,26 @@ A list of headers, each header in this list is a structure that consists of two
 The key is a string that denotes the name of the header, the values are a list of strings that hold the content of the header, this is useful when the header has multiple associated values.
 This field is available for Go, Python and Ruby since tyk v5.0.4 and  5.1.1+.
 
-### JWTData (session_state.proto)
+## BasicAuthData (coprocess_session_state.proto)
+
+The `BasicAuthData` contains a hashed password and the name of the hashing algorithm used. This is represented by the `basic_auth_data` attribute in [SessionState](#session-state) message.
+
+```yaml
+"basicAuthData": {
+    "password": <a_hashed_password_presentation>,
+    "hash": <the_hashing_algorithm_used_to_hash_the_password>
+}
+```
+
+### Field Descriptions
+
+`password`
+A hashed password.
+
+`hash`
+Name of the [hashing algorithm]({{< ref "basic-config-and-security/security/key-hashing" >}}) used to hash the password.
+
+## JWTData (coprocess_session_state.proto)
 
 Added to [sessions](#sessionstate-session_stateproto) where a Tyk key (embedding a shared secret) is used as the public key for signing the JWT. This message contains the shared secret.
 
@@ -357,8 +377,9 @@ Added to [sessions](#sessionstate-session_stateproto) where a Tyk key (embedding
 }
 ```
 
-#### Field Descriptions
+### Field Descriptions
 
 `secret`
 The shared secret.
 
+