Skip to content

Commit 84a9968

Browse files
committed
Add structured header separators for HMAC configuration options
1 parent 3251102 commit 84a9968

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/auth_plugins.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,24 @@ When `header_format` is "structured", this specifies the key name for the timest
108108
**Default:** `t`
109109
**Example:** `timestamp`
110110

111+
##### `structured_header_separator` (optional)
112+
113+
When `header_format` is "structured", this specifies the separator used between the unique keys in the structured header.
114+
115+
For example, if the header is `t=1663781880,v1=abc123`, the `structured_header_separator` would be `,`. It defaults to `,` but can be changed if needed.
116+
117+
**Example:** `.`
118+
**Default:** `,`
119+
120+
##### `key_value_separator` (optional)
121+
122+
When `header_format` is "structured", this specifies the separator used between the key and value in the structured header.
123+
124+
For example, in the header `t=1663781880,v1=abc123`, the `key_value_separator` would be `=`. It defaults to `=` but can be changed if needed.
125+
126+
**Example:** `:`
127+
**Default:** `=`
128+
111129
#### HMAC Examples
112130

113131
**Basic GitHub-style HMAC:**

0 commit comments

Comments
 (0)