Skip to content
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

Jump to bottom

Fix model spec to use code.authorizationCode instead of code.code #660

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Fix model spec to use code.authorizationCode instead of code.code #660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45b508a
Updated changelog
mjsalinger Sep 5, 2018
cb8fd5f
Fix model spec to use `code.authorizationCode` instead of `code.code`
jcdogo Oct 9, 2020
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
* BREAKING: Remove support for node v4
* new: Added revoke-handler to revoke access token
* new: Added implicit grant flow
* new: Switch from jshint to eslint
* new: Switch from jshint to eslin
* fix: authorization_code grant should not be required in implicit flowt

### 3.1.0
* new: Added package-lock.json
Expand Down
180 changes: 99 additions & 81 deletions docs/model/spec.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,25 +336,29 @@ This model function is **required** if the ``authorization_code`` grant is used.

An ``Object`` representing the authorization code and associated data.

+--------------------+--------+--------------------------------------------------------------+
| Name | Type | Description |
+====================+========+==============================================================+
| code | Object | The return value. |
+--------------------+--------+--------------------------------------------------------------+
| code.code | String | The authorization code passed to ``getAuthorizationCode()``. |
+--------------------+--------+--------------------------------------------------------------+
| code.expiresAt | Date | The expiry time of the authorization code. |
+--------------------+--------+--------------------------------------------------------------+
| [code.redirectUri] | String | The redirect URI of the authorization code. |
+--------------------+--------+--------------------------------------------------------------+
| [code.scope] | String | The authorized scope of the authorization code. |
+--------------------+--------+--------------------------------------------------------------+
| code.client | Object | The client associated with the authorization code. |
+--------------------+--------+--------------------------------------------------------------+
| code.client.id | String | A unique string identifying the client. |
+--------------------+--------+--------------------------------------------------------------+
| code.user | Object | The user associated with the authorization code. |
+--------------------+--------+--------------------------------------------------------------+
+----------------------------+--------+---------------------------------------------------------------+
| Name | Type | Description |
+============================+========+===============================================================+
| code | Object | The return value. |
+----------------------------+--------+---------------------------------------------------------------+
| code.authorizationCode | String | The authorization code passed to ``getAuthorizationCode()``. |
+----------------------------+--------+---------------------------------------------------------------+
| code.expiresAt | Date | The expiry time of the authorization code. |
+----------------------------+--------+---------------------------------------------------------------+
| [code.redirectUri] | String | The redirect URI of the authorization code. |
+----------------------------+--------+---------------------------------------------------------------+
| [code.scope] | String | The authorized scope of the authorization code. |
+----------------------------+--------+---------------------------------------------------------------+
| code.client | Object | The client associated with the authorization code. |
+----------------------------+--------+---------------------------------------------------------------+
| code.client.id | String | A unique string identifying the client. |
+----------------------------+--------+---------------------------------------------------------------+
| code.user | Object | The user associated with the authorization code. |
+----------------------------+--------+---------------------------------------------------------------+
| [code.codeChallenge] | String | The code challenge string used with PKCE (RFC7636). |
+----------------------------+--------+---------------------------------------------------------------+
| [code.codeChallengeMethod] | String | The string for the code challenge method (`S256` or `plain`). |
+----------------------------+--------+---------------------------------------------------------------+

``code.client`` and ``code.user`` can carry additional properties that will be ignored by *oauth2-server*.

Expand All @@ -379,7 +383,9 @@ An ``Object`` representing the authorization code and associated data.
redirectUri: code.redirect_uri,
scope: code.scope,
client: client, // with 'id' property
user: user
user: user,
codeChallenge: code.code_challenge,
codeChallengeMethod: code.code_challenge_method
};
});
}
Expand Down Expand Up @@ -665,51 +671,59 @@ This model function is **required** if the ``authorization_code`` grant is used.

**Arguments:**

+------------------------+----------+---------------------------------------------------------------------+
| Name | Type | Description |
+========================+==========+=====================================================================+
| code | Object | The code to be saved. |
+------------------------+----------+---------------------------------------------------------------------+
| code.authorizationCode | String | The authorization code to be saved. |
+------------------------+----------+---------------------------------------------------------------------+
| code.expiresAt | Date | The expiry time of the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| code.redirectUri | String | The redirect URI associated with the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| [code.scope] | String | The authorized scope of the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| client | Object | The client associated with the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| user | Object | The user associated with the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| [callback] | Function | Node-style callback to be used instead of the returned ``Promise``. |
+------------------------+----------+---------------------------------------------------------------------+
+----------------------------+----------+---------------------------------------------------------------------+
| Name | Type | Description |
+============================+==========+=====================================================================+
| code | Object | The code to be saved. |
+----------------------------+----------+---------------------------------------------------------------------+
| code.authorizationCode | String | The authorization code to be saved. |
+----------------------------+----------+---------------------------------------------------------------------+
| code.expiresAt | Date | The expiry time of the authorization code. |
+----------------------------+----------+---------------------------------------------------------------------+
| code.redirectUri | String | The redirect URI associated with the authorization code. |
+----------------------------+----------+---------------------------------------------------------------------+
| [code.scope] | String | The authorized scope of the authorization code. |
+----------------------------+----------+---------------------------------------------------------------------+
| [code.codeChallenge] | String | The code challenge string used with PKCE (RFC7636). |
+----------------------------+----------+---------------------------------------------------------------------+
| [code.codeChallengeMethod] | String | The string for the code challenge method (`S256` or `plain`). |
+----------------------------+----------+---------------------------------------------------------------------+
| client | Object | The client associated with the authorization code. |
+----------------------------+----------+---------------------------------------------------------------------+
| user | Object | The user associated with the authorization code. |
+----------------------------+----------+---------------------------------------------------------------------+
| [callback] | Function | Node-style callback to be used instead of the returned ``Promise``. |
+----------------------------+----------+---------------------------------------------------------------------+

.. todo:: Is ``code.scope`` really optional?

**Return value:**

An ``Object`` representing the authorization code and associated data.

+------------------------+--------+---------------------------------------------------------------+
| Name | Type | Description |
+========================+========+===============================================================+
| code | Object | The return value. |
+------------------------+--------+---------------------------------------------------------------+
| code.authorizationCode | String | The authorization code passed to ``saveAuthorizationCode()``. |
+------------------------+--------+---------------------------------------------------------------+
| code.expiresAt | Date | The expiry time of the authorization code. |
+------------------------+--------+---------------------------------------------------------------+
| code.redirectUri | String | The redirect URI associated with the authorization code. |
+------------------------+--------+---------------------------------------------------------------+
| [code.scope] | String | The authorized scope of the authorization code. |
+------------------------+--------+---------------------------------------------------------------+
| code.client | Object | The client associated with the authorization code. |
+------------------------+--------+---------------------------------------------------------------+
| code.client.id | String | A unique string identifying the client. |
+------------------------+--------+---------------------------------------------------------------+
| code.user | Object | The user associated with the authorization code. |
+------------------------+--------+---------------------------------------------------------------+
+----------------------------+--------+----------------------------------------------------------------+
| Name | Type | Description |
+============================+========+================================================================+
| code | Object | The return value. |
+----------------------------+--------+----------------------------------------------------------------+
| code.authorizationCode | String | The authorization code passed to ``saveAuthorizationCode()``. |
+----------------------------+--------+----------------------------------------------------------------+
| code.expiresAt | Date | The expiry time of the authorization code. |
+----------------------------+--------+----------------------------------------------------------------+
| code.redirectUri | String | The redirect URI associated with the authorization code. |
+----------------------------+--------+----------------------------------------------------------------+
| [code.scope] | String | The authorized scope of the authorization code. |
+----------------------------+--------+----------------------------------------------------------------+
| code.client | Object | The client associated with the authorization code. |
+----------------------------+--------+----------------------------------------------------------------+
| code.client.id | String | A unique string identifying the client. |
+----------------------------+--------+----------------------------------------------------------------+
| code.user | Object | The user associated with the authorization code. |
+----------------------------+--------+----------------------------------------------------------------+
| [code.codeChallenge] | String | The code challenge string used with PKCE (RFC7636). |
+----------------------------+--------+----------------------------------------------------------------+
| [code.codeChallengeMethod] | String | The string for the code challenge method (`S256` or `plain` |
+----------------------------+--------+----------------------------------------------------------------+

``code.client`` and ``code.user`` can carry additional properties that will be ignored by *oauth2-server*.

Expand All @@ -725,7 +739,9 @@ An ``Object`` representing the authorization code and associated data.
redirect_uri: code.redirectUri,
scope: code.scope,
client_id: client.id,
user_id: user.id
user_id: user.id,
code_challenge: code.codeChallenge,
code_challenge_method: code.codeChallengeMethod
};
return db.saveAuthorizationCode(authCode)
.then(function(authorizationCode) {
Expand All @@ -735,7 +751,9 @@ An ``Object`` representing the authorization code and associated data.
redirectUri: authorizationCode.redirect_uri,
scope: authorizationCode.scope,
client: {id: authorizationCode.client_id},
user: {id: authorizationCode.user_id}
user: {id: authorizationCode.user_id},
codeChallenge: authorizationCode.code_challenge,
codeChallengeMethod: authorizationCode.code_challenge_method
};
});
}
Expand Down Expand Up @@ -812,27 +830,27 @@ This model function is **required** if the ``authorization_code`` grant is used.

**Arguments:**

+--------------------+----------+---------------------------------------------------------------------+
| Name | Type | Description |
+====================+==========+=====================================================================+
| code | Object | The return value. |
+--------------------+----------+---------------------------------------------------------------------+
| code.code | String | The authorization code. |
+--------------------+----------+---------------------------------------------------------------------+
| code.expiresAt | Date | The expiry time of the authorization code. |
+--------------------+----------+---------------------------------------------------------------------+
| [code.redirectUri] | String | The redirect URI of the authorization code. |
+--------------------+----------+---------------------------------------------------------------------+
| [code.scope] | String | The authorized scope of the authorization code. |
+--------------------+----------+---------------------------------------------------------------------+
| code.client | Object | The client associated with the authorization code. |
+--------------------+----------+---------------------------------------------------------------------+
| code.client.id | String | A unique string identifying the client. |
+--------------------+----------+---------------------------------------------------------------------+
| code.user | Object | The user associated with the authorization code. |
+--------------------+----------+---------------------------------------------------------------------+
| [callback] | Function | Node-style callback to be used instead of the returned ``Promise``. |
+--------------------+----------+---------------------------------------------------------------------+
+------------------------+----------+---------------------------------------------------------------------+
| Name | Type | Description |
+========================+==========+=====================================================================+
| code | Object | The return value. |
+------------------------+----------+---------------------------------------------------------------------+
| code.authorizationCode | String | The authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| code.expiresAt | Date | The expiry time of the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| [code.redirectUri] | String | The redirect URI of the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| [code.scope] | String | The authorized scope of the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| code.client | Object | The client associated with the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| code.client.id | String | A unique string identifying the client. |
+------------------------+----------+---------------------------------------------------------------------+
| code.user | Object | The user associated with the authorization code. |
+------------------------+----------+---------------------------------------------------------------------+
| [callback] | Function | Node-style callback to be used instead of the returned ``Promise``. |
+------------------------+----------+---------------------------------------------------------------------+

**Return value:**

Expand Down