Skip to content
This repository has been archived by the owner on Apr 3, 2019. It is now read-only.

feat(token): return the uid from the /token endpoint #3000

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(token): return the uid from the /token endpoint #3000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions fxa-oauth-server/lib/grant.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ module.exports.generateTokens = async function generateTokens(grant) {
const access = await db.generateAccessToken(grant);
const result = {
access_token: access.token.toString('hex'),
user: access.userId.toString('hex'),
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we call this sub like we do for an id token. At least it'd be consistent. But I see verify returns user. mmm...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

another idea is to use the fxa-uid field

token_type: access.type,
scope: access.scope.toString()
};
Expand Down
1 change: 1 addition & 0 deletions fxa-oauth-server/lib/routes/authorization.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ module.exports = {
code: Joi.string(),
state: Joi.string(),
access_token: validators.token,
user: validators.uid,
token_type: Joi.string().valid('bearer'),
scope: Joi.string().allow(''),
auth_at: Joi.number(),
Expand Down
1 change: 1 addition & 0 deletions fxa-oauth-server/lib/routes/token.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ module.exports = {
access_token: validators.token.required(),
refresh_token: validators.token,
id_token: validators.assertion,
user: validators.uid.required(),
scope: validators.scope.required(),
token_type: Joi.string().valid('bearer').required(),
expires_in: Joi.number().max(MAX_TTL_S).required(),
Expand Down
4 changes: 4 additions & 0 deletions fxa-oauth-server/lib/validators.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ exports.token = Joi.string()
.length(config.get('unique.token') * 2)
.regex(exports.HEX_STRING);

exports.uid = Joi.string()
.length(32)
.regex(exports.HEX_STRING);

const scopeString = Joi.string().max(256);

exports.scope = Joi.extend({
Expand Down
2 changes: 2 additions & 0 deletions fxa-oauth-server/test/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -814,6 +814,7 @@ describe('/v1', function() {
assert.equal(res.statusCode, 200);
assertSecurityHeaders(res);
assert(res.result.access_token);
assert(res.result.user);
assert.equal(res.result.token_type, 'bearer');
assert(res.result.scope);
assert(res.result.expires_in <= defaultExpiresIn);
Expand Down Expand Up @@ -1096,6 +1097,7 @@ describe('/v1', function() {
assert.equal(res.statusCode, 200);
assertSecurityHeaders(res);
assert.ok(res.result.access_token);
assert.ok(res.result.user);
assert.equal(res.result.token_type, 'bearer');
assert.ok(res.result.auth_at);
assert.ok(res.result.expires_in);
Expand Down
1 change: 1 addition & 0 deletions lib/oauthdb/grant-tokens-from-authorization-code.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ module.exports = (config) => {
refresh_token: validators.refreshToken.optional(),
id_token: validators.assertion.optional(),
scope: validators.scope.required(),
user: validators.uid.required(),
token_type: Joi.string().valid('bearer').required(),
expires_in: Joi.number().required(),
auth_at: Joi.number().required(),
Expand Down
1 change: 1 addition & 0 deletions lib/oauthdb/grant-tokens-from-credentials.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ module.exports = (config) => {
access_token: validators.accessToken.required(),
refresh_token: validators.refreshToken.optional(),
id_token: validators.assertion.optional(),
user: validators.uid.required(),
scope: validators.scope.required(),
auth_at: Joi.number().required(),
token_type: Joi.string().valid('bearer').required(),
Expand Down
1 change: 1 addition & 0 deletions lib/oauthdb/grant-tokens-from-refresh-token.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ module.exports = (config) => {
}),
response: Joi.object({
access_token: validators.accessToken.required(),
user: validators.uid.required(),
scope: validators.scope.required(),
token_type: Joi.string().valid('bearer').required(),
expires_in: Joi.number().required()
Expand Down
1 change: 1 addition & 0 deletions lib/routes/validators.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ module.exports.clientId = module.exports.hexString.length(16);
module.exports.clientSecret = module.exports.hexString;
module.exports.accessToken = module.exports.hexString.length(64);
module.exports.refreshToken = module.exports.hexString.length(64);
module.exports.uid = module.exports.hexString.length(32);
module.exports.authorizationCode = module.exports.hexString.length(64);
// Note that the empty string is a valid scope value (meaning "no permissions").
module.exports.scope = isA.string().max(256).regex(/^[a-zA-Z0-9 _\/.:-]*$/).allow('');
Expand Down
3 changes: 3 additions & 0 deletions test/local/oauthdb/grant-tokens-from-authorization-code.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const oauthdbModule = require('../../../lib/oauthdb');
const error = require('../../../lib/error');
const { mockLog } = require('../../mocks');

const MOCK_USER_ID = '5A6773A8D23E49FDAFCC976882E0B57E';
const MOCK_CLIENT_ID = '0123456789ABCDEF';
const MOCK_AUTHORIZATION_CODE = '1111112222223333334444445555556611111122222233333344444455555566';
const MOCK_ACCESS_TOKEN = 'aaaaaa2222223333334444445555556611111122222233333344444455555566';
Expand Down Expand Up @@ -39,6 +40,7 @@ describe('oauthdb/grantTokensFromAuthorizationCode', () => {
mockOAuthServer.post('/v1/token', body => true)
.reply(200, {
access_token: MOCK_ACCESS_TOKEN,
user: MOCK_USER_ID,
scope: '',
token_type: 'bearer',
expires_in: 123,
Expand All @@ -52,6 +54,7 @@ describe('oauthdb/grantTokensFromAuthorizationCode', () => {
});
assert.deepEqual(res, {
access_token: MOCK_ACCESS_TOKEN,
user: MOCK_USER_ID,
scope: '',
token_type: 'bearer',
expires_in: 123,
Expand Down
5 changes: 5 additions & 0 deletions test/local/oauthdb/grant-tokens-from-refresh-token.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const oauthdbModule = require('../../../lib/oauthdb');
const error = require('../../../lib/error');
const { mockLog } = require('../../mocks');

const MOCK_USER_ID = '5A6773A8D23E49FDAFCC976882E0B57E';
const MOCK_CLIENT_ID = '0123456789ABCDEF';
const MOCK_ACCESS_TOKEN = 'aaaaaa2222223333334444445555556611111122222233333344444455555566';
const MOCK_REFRESH_TOKEN = 'bbbbbb2222223333334444445555556611111122222233333344444455555566';
Expand Down Expand Up @@ -39,6 +40,7 @@ describe('oauthdb/grantTokensFromRefreshToken', () => {
mockOAuthServer.post('/v1/token', body => true)
.reply(200, {
access_token: MOCK_ACCESS_TOKEN,
user: MOCK_USER_ID,
scope: '',
token_type: 'bearer',
expires_in: 123,
Expand All @@ -52,6 +54,7 @@ describe('oauthdb/grantTokensFromRefreshToken', () => {
});
assert.deepEqual(res, {
access_token: MOCK_ACCESS_TOKEN,
user: MOCK_USER_ID,
scope: '',
token_type: 'bearer',
expires_in: 123,
Expand All @@ -62,6 +65,7 @@ describe('oauthdb/grantTokensFromRefreshToken', () => {
mockOAuthServer.post('/v1/token', body => true)
.reply(200, {
access_token: MOCK_ACCESS_TOKEN,
user: MOCK_USER_ID,
scope: '',
token_type: 'bearer',
expires_in: 123,
Expand All @@ -76,6 +80,7 @@ describe('oauthdb/grantTokensFromRefreshToken', () => {
});
assert.deepEqual(res, {
access_token: MOCK_ACCESS_TOKEN,
user: MOCK_USER_ID,
scope: '',
token_type: 'bearer',
expires_in: 123,
Expand Down
5 changes: 5 additions & 0 deletions test/local/oauthdb/grant-tokens-from-session-token.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const nock = require('nock');
const oauthdbModule = require('../../../lib/oauthdb');
const { mockLog } = require('../../mocks');

const MOCK_USER_ID = '5A6773A8D23E49FDAFCC976882E0B57E';
const MOCK_CLIENT_ID = '0123456789ABCDEF';
const MOCK_ACCESS_TOKEN = 'aaaaaa2222223333334444445555556611111122222233333344444455555566';
const MOCK_REFRESH_TOKEN = 'bbbbbb2222223333334444445555556611111122222233333344444455555566';
Expand Down Expand Up @@ -46,6 +47,7 @@ describe('oauthdb/grantTokensFromSessionToken', () => {
mockOAuthServer.post('/v1/token', body => true)
.reply(200, {
access_token: MOCK_ACCESS_TOKEN,
user: MOCK_USER_ID,
scope: 'test1',
token_type: 'bearer',
expires_in: 123,
Expand All @@ -58,6 +60,7 @@ describe('oauthdb/grantTokensFromSessionToken', () => {
});
assert.deepEqual(res, {
access_token: MOCK_ACCESS_TOKEN,
user: MOCK_USER_ID,
scope: 'test1',
token_type: 'bearer',
expires_in: 123,
Expand All @@ -71,6 +74,7 @@ describe('oauthdb/grantTokensFromSessionToken', () => {
access_token: MOCK_ACCESS_TOKEN,
refresh_token: MOCK_REFRESH_TOKEN,
id_token: MOCK_ID_TOKEN,
user: MOCK_USER_ID,
scope: 'test1 openid',
token_type: 'bearer',
expires_in: 123,
Expand All @@ -88,6 +92,7 @@ describe('oauthdb/grantTokensFromSessionToken', () => {
access_token: MOCK_ACCESS_TOKEN,
refresh_token: MOCK_REFRESH_TOKEN,
id_token: MOCK_ID_TOKEN,
user: MOCK_USER_ID,
scope: 'test1 openid',
token_type: 'bearer',
expires_in: 123,
Expand Down
3 changes: 3 additions & 0 deletions test/remote/oauth_tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ describe('/oauth/ routes', function () {

assert.ok(res.access_token);
assert.ok(res.refresh_token);
assert.ok(res.user);
assert.equal(res.scope, SCOPE);
assert.ok(res.auth_at);
assert.ok(res.expires_in);
Expand Down Expand Up @@ -124,6 +125,7 @@ describe('/oauth/ routes', function () {
assert.ok(res.access_token);
assert.ok(res.refresh_token);
assert.ok(res.id_token);
assert.ok(res.user);
assert.equal(res.scope, SCOPE);
assert.ok(res.auth_at);
assert.ok(res.expires_in);
Expand All @@ -135,6 +137,7 @@ describe('/oauth/ routes', function () {
grant_type: 'refresh_token',
});
assert.ok(res.access_token);
assert.ok(res.user);
assert.equal(res.scope, SCOPE);
assert.ok(res.expires_in);
assert.ok(res.token_type);
Expand Down