soul-cli 0.7.2 → 0.7.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,128 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ thevahidal@gmail.com.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
+ https://www.contributor-covenant.org/translations.
package/CONTRIBUTING.md CHANGED
@@ -15,78 +15,3 @@ Please note we have a code of conduct, please follow it in all your interactions
15
15
  Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16
16
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17
17
  do not have permission to do that, you may request the second reviewer to merge it for you.
18
-
19
- ## Code of Conduct
20
-
21
- ### Our Pledge
22
-
23
- In the interest of fostering an open and welcoming environment, we as
24
- contributors and maintainers pledge to making participation in our project and
25
- our community a harassment-free experience for everyone, regardless of age, body
26
- size, disability, ethnicity, gender identity and expression, level of experience,
27
- nationality, personal appearance, race, religion, or sexual identity and
28
- orientation.
29
-
30
- ### Our Standards
31
-
32
- Examples of behavior that contributes to creating a positive environment
33
- include:
34
-
35
- * Using welcoming and inclusive language
36
- * Being respectful of differing viewpoints and experiences
37
- * Gracefully accepting constructive criticism
38
- * Focusing on what is best for the community
39
- * Showing empathy towards other community members
40
-
41
- Examples of unacceptable behavior by participants include:
42
-
43
- * The use of sexualized language or imagery and unwelcome sexual attention or
44
- advances
45
- * Trolling, insulting/derogatory comments, and personal or political attacks
46
- * Public or private harassment
47
- * Publishing others' private information, such as a physical or electronic
48
- address, without explicit permission
49
- * Other conduct which could reasonably be considered inappropriate in a
50
- professional setting
51
-
52
- ### Our Responsibilities
53
-
54
- Project maintainers are responsible for clarifying the standards of acceptable
55
- behavior and are expected to take appropriate and fair corrective action in
56
- response to any instances of unacceptable behavior.
57
-
58
- Project maintainers have the right and responsibility to remove, edit, or
59
- reject comments, commits, code, wiki edits, issues, and other contributions
60
- that are not aligned to this Code of Conduct, or to ban temporarily or
61
- permanently any contributor for other behaviors that they deem inappropriate,
62
- threatening, offensive, or harmful.
63
-
64
- ### Scope
65
-
66
- This Code of Conduct applies both within project spaces and in public spaces
67
- when an individual is representing the project or its community. Examples of
68
- representing a project or community include using an official project e-mail
69
- address, posting via an official social media account, or acting as an appointed
70
- representative at an online or offline event. Representation of a project may be
71
- further defined and clarified by project maintainers.
72
-
73
- ### Enforcement
74
-
75
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
76
- reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
77
- complaints will be reviewed and investigated and will result in a response that
78
- is deemed necessary and appropriate to the circumstances. The project team is
79
- obligated to maintain confidentiality with regard to the reporter of an incident.
80
- Further details of specific enforcement policies may be posted separately.
81
-
82
- Project maintainers who do not follow or enforce the Code of Conduct in good
83
- faith may face temporary or permanent repercussions as determined by other
84
- members of the project's leadership.
85
-
86
- ### Attribution
87
-
88
- This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
89
- available at [http://contributor-covenant.org/version/1/4][version]
90
-
91
- [homepage]: http://contributor-covenant.org
92
- [version]: http://contributor-covenant.org/version/1/4/
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "soul-cli",
3
- "version": "0.7.2",
3
+ "version": "0.7.4",
4
4
  "description": "A SQLite REST and Realtime server",
5
5
  "main": "src/server.js",
6
6
  "bin": {
@@ -2,4 +2,5 @@ module.exports = {
2
2
  SALT_ROUNDS: 10,
3
3
  ACCESS_TOKEN_SUBJECT: 'accessToken',
4
4
  REFRESH_TOKEN_SUBJECT: 'refreshToken',
5
+ REVOKED_REFRESH_TOKENS_REMOVAL_TIME_RANGE: 3 * 24 * 60 * 60 * 1000, // 3 days * 24 hours * 60 minutes * 60 seconds * 1000 milliseconds =
5
6
  };
@@ -5,6 +5,7 @@ module.exports = {
5
5
  PASSWORD_UPDATE_SUCCESS: 'Password updated successfully',
6
6
  USER_UPDATE_SUCCESS: 'User updated successfully',
7
7
  INITIAL_USER_CREATED_SUCCESS: 'Initial user created successfully',
8
+ LOGOUT_MESSAGE: 'Logout successful',
8
9
  },
9
10
 
10
11
  errorMessage: {
@@ -2,12 +2,15 @@ const USERS_TABLE = '_users';
2
2
  const ROLES_TABLE = '_roles';
3
3
  const USERS_ROLES_TABLE = '_users_roles';
4
4
  const ROLES_PERMISSIONS_TABLE = '_roles_permissions';
5
+ const REVOKED_REFRESH_TOKENS_TABLE = '_revoked_refresh_tokens';
5
6
 
6
7
  module.exports = {
8
+ // db table names
7
9
  USERS_TABLE,
8
10
  ROLES_TABLE,
9
11
  USERS_ROLES_TABLE,
10
12
  ROLES_PERMISSIONS_TABLE,
13
+ REVOKED_REFRESH_TOKENS_TABLE,
11
14
 
12
15
  reservedTableNames: [
13
16
  USERS_TABLE,
@@ -43,5 +46,9 @@ module.exports = {
43
46
 
44
47
  // _users_roles fields
45
48
  USER_ID: 'user_id',
49
+
50
+ //_revoked_refresh_tokens
51
+ REFRESH_TOKEN: 'refresh_token',
52
+ EXPIRES_AT: 'expires_at',
46
53
  },
47
54
  };
@@ -7,6 +7,7 @@ const {
7
7
  ROLES_TABLE,
8
8
  USERS_ROLES_TABLE,
9
9
  ROLES_PERMISSIONS_TABLE,
10
+ REVOKED_REFRESH_TOKENS_TABLE,
10
11
  constraints,
11
12
  tableFields,
12
13
  } = dbConstants;
@@ -21,6 +22,9 @@ const createDefaultTables = async () => {
21
22
  ROLES_PERMISSIONS_TABLE,
22
23
  );
23
24
  const usersRolesTable = tableService.checkTableExists(USERS_ROLES_TABLE);
25
+ const revokedRefreshTokensTable = tableService.checkTableExists(
26
+ REVOKED_REFRESH_TOKENS_TABLE,
27
+ );
24
28
 
25
29
  // create _users table
26
30
  if (!usersTable) {
@@ -89,6 +93,14 @@ const createDefaultTables = async () => {
89
93
  fields: permissions,
90
94
  });
91
95
  }
96
+
97
+ // create _revoked_refresh_tokens table
98
+ if (!revokedRefreshTokensTable) {
99
+ tableService.createTable(
100
+ REVOKED_REFRESH_TOKENS_TABLE,
101
+ schema.revokedRefreshTokensSchema,
102
+ );
103
+ }
92
104
  };
93
105
 
94
106
  module.exports = {
@@ -123,11 +123,19 @@ const refreshAccessToken = async (req, res) => {
123
123
  #swagger.summary = 'Refresh Access Token'
124
124
  #swagger.description = 'Endpoint to refresh access and refresh tokens'
125
125
  */
126
+ const refreshTokenFromCookies = req.cookies.refreshToken;
126
127
 
127
128
  try {
129
+ // check if the refresh token is revoked
130
+ if (isRefreshTokenRevoked({ refreshToken: refreshTokenFromCookies })) {
131
+ return res
132
+ .status(403)
133
+ .send({ message: errorMessage.INVALID_REFRESH_TOKEN_ERROR });
134
+ }
135
+
128
136
  // extract the payload from the token and verify it
129
137
  const payload = await decodeToken(
130
- req.cookies.refreshToken,
138
+ refreshTokenFromCookies,
131
139
  config.tokenSecret,
132
140
  );
133
141
 
@@ -217,6 +225,52 @@ const refreshAccessToken = async (req, res) => {
217
225
  }
218
226
  };
219
227
 
228
+ const removeTokens = async (req, res) => {
229
+ /*
230
+ #swagger.tags = ['Auth']
231
+ #swagger.summary = 'Remove Tokens'
232
+ #swagger.description = 'Endpoint to remove access and refresh tokens'
233
+ */
234
+
235
+ const refreshToken = req.cookies.refreshToken;
236
+
237
+ try {
238
+ // decode the token
239
+ const payload = await decodeToken(refreshToken, config.tokenSecret);
240
+
241
+ // store the refresh token in the _revoked_refresh_tokens table
242
+ authService.saveRevokedRefreshToken({
243
+ refreshToken,
244
+ expiresAt: payload.exp,
245
+ });
246
+
247
+ // remove the token from the cookie
248
+ res.clearCookie(authConstants.ACCESS_TOKEN_SUBJECT);
249
+ res.clearCookie(authConstants.REFRESH_TOKEN_SUBJECT);
250
+
251
+ res
252
+ .status(200)
253
+ .send({ message: responseMessages.successMessage.LOGOUT_MESSAGE });
254
+
255
+ /*
256
+ #swagger.responses[200] = {
257
+ description: 'Tokens Removed',
258
+ schema: {
259
+ $ref: '#/definitions/RemoveTokensResponse'
260
+ }
261
+ }
262
+ */
263
+ } catch (error) {
264
+ res.status(500).send({ message: errorMessage.SERVER_ERROR });
265
+ }
266
+ };
267
+
268
+ const removeRevokedRefreshTokens = () => {
269
+ authService.deleteRevokedRefreshTokens({
270
+ lookupField: `WHERE expires_at < CURRENT_TIMESTAMP`,
271
+ });
272
+ };
273
+
220
274
  const getUsersRoleAndPermission = ({ userId, res }) => {
221
275
  const userRoles = authService.getUserRoleByUserId({ userId });
222
276
 
@@ -233,7 +287,14 @@ const getUsersRoleAndPermission = ({ userId, res }) => {
233
287
  return { userRoles, roleIds, permissions };
234
288
  };
235
289
 
290
+ const isRefreshTokenRevoked = ({ refreshToken }) => {
291
+ const tokens = authService.getRevokedRefreshToken({ refreshToken });
292
+ return tokens.length > 0;
293
+ };
294
+
236
295
  module.exports = {
237
296
  obtainAccessToken,
238
297
  refreshAccessToken,
298
+ removeTokens,
299
+ removeRevokedRefreshTokens,
239
300
  };
package/src/db/schema.js CHANGED
@@ -115,4 +115,22 @@ module.exports = {
115
115
  foreignKey: { table: ROLES_TABLE, column: tableFields.ID },
116
116
  },
117
117
  ],
118
+
119
+ revokedRefreshTokensSchema: [
120
+ {
121
+ name: tableFields.REFRESH_TOKEN,
122
+ type: 'TEXT',
123
+ primaryKey: false,
124
+ notNull: true,
125
+ unique: false,
126
+ },
127
+
128
+ {
129
+ name: tableFields.EXPIRES_AT,
130
+ type: 'NUMERIC',
131
+ primaryKey: false,
132
+ notNull: true,
133
+ unique: false,
134
+ },
135
+ ],
118
136
  };
package/src/index.js CHANGED
@@ -22,9 +22,11 @@ const { setupExtensions } = require('./extensions');
22
22
  const {
23
23
  createDefaultTables,
24
24
  createInitialUser,
25
+ removeRevokedRefreshTokens,
25
26
  } = require('./controllers/auth');
26
27
 
27
28
  const { runCLICommands } = require('./commands');
29
+ const { authConstants } = require('./constants');
28
30
 
29
31
  const app = express();
30
32
  app.get('/health', (req, res) => {
@@ -93,6 +95,12 @@ if (config.auth) {
93
95
  );
94
96
  }
95
97
 
98
+ // remove revoked refresh tokens every X days
99
+ setInterval(
100
+ removeRevokedRefreshTokens,
101
+ authConstants.REVOKED_REFRESH_TOKENS_REMOVAL_TIME_RANGE,
102
+ );
103
+
96
104
  // If the user has passed custom CLI commands run the command and exit to avoid running the server
97
105
  runCLICommands();
98
106
 
@@ -26,4 +26,10 @@ router.put(
26
26
  controllers.changePassword,
27
27
  );
28
28
 
29
+ router.get(
30
+ '/logout',
31
+ validator(schema.removeAccessTokens),
32
+ controllers.removeTokens,
33
+ );
34
+
29
35
  module.exports = router;
@@ -14,7 +14,7 @@ const obtainAccessToken = Joi.object({
14
14
  cookies: Joi.object({
15
15
  refreshToken: Joi.string().optional(),
16
16
  accessToken: Joi.string().optional(),
17
- }),
17
+ }).unknown(true),
18
18
  });
19
19
 
20
20
  const refreshAccessToken = Joi.object({
@@ -24,7 +24,9 @@ const refreshAccessToken = Joi.object({
24
24
  cookies: Joi.object({
25
25
  refreshToken: Joi.string().required(),
26
26
  accessToken: Joi.string().optional(),
27
- }).required(),
27
+ })
28
+ .unknown(true)
29
+ .required(),
28
30
  });
29
31
 
30
32
  const changePassword = Joi.object({
@@ -40,7 +42,9 @@ const changePassword = Joi.object({
40
42
  cookies: Joi.object({
41
43
  accessToken: Joi.string().required(),
42
44
  refreshToken: Joi.string().optional(),
43
- }).required(),
45
+ })
46
+ .unknown(true)
47
+ .required(),
44
48
  });
45
49
 
46
50
  const registerUser = Joi.object({
@@ -56,7 +60,9 @@ const registerUser = Joi.object({
56
60
  cookies: Joi.object({
57
61
  accessToken: Joi.string().required(),
58
62
  refreshToken: Joi.string().optional(),
59
- }).required(),
63
+ })
64
+ .unknown(true)
65
+ .required(),
60
66
  });
61
67
 
62
68
  const updateRolePermissions = Joi.object({
@@ -76,7 +82,21 @@ const updateRolePermissions = Joi.object({
76
82
  cookies: Joi.object({
77
83
  accessToken: Joi.string().required(),
78
84
  refreshToken: Joi.string().optional(),
79
- }).required(),
85
+ })
86
+ .unknown(true)
87
+ .required(),
88
+ });
89
+
90
+ const removeAccessTokens = Joi.object({
91
+ query: Joi.object().required(),
92
+ params: Joi.object({}).required(),
93
+ body: Joi.object({}).required(),
94
+ cookies: Joi.object({
95
+ refreshToken: Joi.string().required(),
96
+ accessToken: Joi.string().required(),
97
+ })
98
+ .unknown(true)
99
+ .required(),
80
100
  });
81
101
 
82
102
  module.exports = {
@@ -85,4 +105,5 @@ module.exports = {
85
105
  changePassword,
86
106
  registerUser,
87
107
  updateRolePermissions,
108
+ removeAccessTokens,
88
109
  };
@@ -8,10 +8,11 @@ const {
8
8
  ROLES_TABLE,
9
9
  USERS_ROLES_TABLE,
10
10
  ROLES_PERMISSIONS_TABLE,
11
+ REVOKED_REFRESH_TOKENS_TABLE,
11
12
  tableFields,
12
13
  } = dbConstants;
13
14
 
14
- module.exports = () => {
15
+ module.exports = (db) => {
15
16
  return {
16
17
  getUsersByUsername({ username }) {
17
18
  const users = rowService.get({
@@ -43,6 +44,7 @@ module.exports = () => {
43
44
  return users;
44
45
  },
45
46
 
47
+ // TODO: bypass pagination by providing query param for number of rows
46
48
  getPermissionByRoleIds({ roleIds }) {
47
49
  const permissions = rowService.get({
48
50
  tableName: ROLES_PERMISSIONS_TABLE,
@@ -50,6 +52,7 @@ module.exports = () => {
50
52
  () => '?',
51
53
  )})`,
52
54
  whereStringValues: [...roleIds],
55
+ limit: 10000,
53
56
  });
54
57
 
55
58
  return permissions;
@@ -74,5 +77,34 @@ module.exports = () => {
74
77
 
75
78
  return defaultRole;
76
79
  },
80
+
81
+ saveRevokedRefreshToken({ refreshToken, expiresAt }) {
82
+ const { lastInsertRowid } = rowService.save({
83
+ tableName: REVOKED_REFRESH_TOKENS_TABLE,
84
+ fields: {
85
+ refresh_token: refreshToken,
86
+ expires_at: expiresAt,
87
+ },
88
+ });
89
+
90
+ return { id: lastInsertRowid };
91
+ },
92
+
93
+ getRevokedRefreshToken({ refreshToken }) {
94
+ const token = rowService.get({
95
+ tableName: REVOKED_REFRESH_TOKENS_TABLE,
96
+ whereString: `WHERE ${tableFields.REFRESH_TOKEN}=?`,
97
+ whereStringValues: [refreshToken],
98
+ });
99
+
100
+ return token;
101
+ },
102
+
103
+ deleteRevokedRefreshTokens({ lookupField }) {
104
+ const query = `DELETE FROM ${REVOKED_REFRESH_TOKENS_TABLE} ${lookupField}`;
105
+ const statement = db.prepare(query);
106
+ const result = statement.run();
107
+ return result;
108
+ },
77
109
  };
78
110
  };
@@ -189,6 +189,10 @@ const doc = {
189
189
  },
190
190
 
191
191
  InvalidPasswordErrorResponse: { message: 'Invalid password' },
192
+
193
+ RemoveTokensResponse: {
194
+ message: 'Logout successful',
195
+ },
192
196
  },
193
197
  };
194
198
 
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "swagger": "2.0",
3
3
  "info": {
4
- "version": "0.7.0",
4
+ "version": "0.7.2",
5
5
  "title": "Soul API",
6
6
  "description": "API Documentation for <b>Soul</b>, a SQLite REST and realtime server. "
7
7
  },
@@ -535,6 +535,17 @@
535
535
  }
536
536
  }
537
537
  }
538
+ },
539
+ "/api/auth/logout": {
540
+ "get": {
541
+ "description": "",
542
+ "parameters": [],
543
+ "responses": {
544
+ "400": {
545
+ "description": "Bad Request"
546
+ }
547
+ }
548
+ }
538
549
  }
539
550
  },
540
551
  "definitions": {
@@ -985,6 +996,15 @@
985
996
  "example": "Invalid password"
986
997
  }
987
998
  }
999
+ },
1000
+ "RemoveTokensResponse": {
1001
+ "type": "object",
1002
+ "properties": {
1003
+ "message": {
1004
+ "type": "string",
1005
+ "example": "Logout successful"
1006
+ }
1007
+ }
988
1008
  }
989
1009
  }
990
1010
  }