feat: add generateRandomState

panva · Apr 7, 2022 · a39cc6b · a39cc6b
1 parent ad60b2c
commit a39cc6b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -12,6 +12,7 @@
 - [discoveryRequest](functions/discoveryRequest.md)
 - [generateRandomCodeVerifier](functions/generateRandomCodeVerifier.md)
 - [generateRandomNonce](functions/generateRandomNonce.md)
+- [generateRandomState](functions/generateRandomState.md)
 - [getValidatedIdTokenClaims](functions/getValidatedIdTokenClaims.md)
 - [introspectionRequest](functions/introspectionRequest.md)
 - [isOAuth2Error](functions/isOAuth2Error.md)

diff --git a/docs/functions/generateRandomState.md b/docs/functions/generateRandomState.md
@@ -0,0 +1,11 @@
+# Function: generateRandomState
+
+▸ **generateRandomState**(): `string`
+
+Generate random `state` value.
+
+**`see`** [RFC 6749 - The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.1)
+
+#### Returns
+
+`string`
diff --git a/src/index.ts b/src/index.ts
@@ -999,6 +999,15 @@ export function generateRandomCodeVerifier() {
   return randomBytes()
 }
 
+/**
+ * Generate random `state` value.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.1 RFC 6749 - The OAuth 2.0 Authorization Framework}
+ */
+export function generateRandomState() {
+  return randomBytes()
+}
+
 /**
  * Generate random `nonce` value.
  *