seg_yinzy
/
myems
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added expiration datetimes to user actions in API

pull/85/head
13621160019@163.com 2021-09-21 16:03:39 +08:00
parent e56f52d625
commit 01b6dabb31
3 changed files with 127 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
myems-api/MyEMS.postman_collection.json
View File

@ -6601,6 +6601,27 @@
}, },
"response": [] "response": []
}, },
{
"name": "Get a User by ID",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/users/2",
"host": [
"{{base_url}}"
],
"path": [
"users",
"2"
]
}
},
"response": []
},
{ {
"name": "POST Create New User", "name": "POST Create New User",
"request": { "request": {
@ -6608,7 +6629,7 @@
"header": [], "header": [],
"body": { "body": {
"mode": "raw", "mode": "raw",
"raw": "{\"data\":{\"name\":\"albert\", \"display_name\":\"Mr. Albert\", \"email\":\"albert@myems.io\", \"is_admin\":false, \"privilege_id\":1, \"password\":\"!MyEMS1\"}}" "raw": "{\"data\":{\"name\":\"albert1\", \"display_name\":\"Mr. Albert\", \"email\":\"albert1@myems.io\", \"is_admin\":false, \"privilege_id\":1, \"password\":\"!MyEMS1\", \"account_expiration_datetime\":\"2100-01-01T00:00:00\",\"password_expiration_datetime\":\"2100-01-01T00:00:00\"}}"
}, },
"url": { "url": {
"raw": "{{base_url}}/users", "raw": "{{base_url}}/users",
@ -6669,7 +6690,7 @@
"header": [], "header": [],
"body": { "body": {
"mode": "raw", "mode": "raw",
"raw": "{\"data\":{\"name\":\"albert\", \"display_name\":\"Mr. Albert\", \"email\":\"albert@myems.io\", \"is_admin\":false, \"privilege_id\":1, \"password\":\"!MyEMS1\"}}" "raw": "{\"data\":{\"name\":\"albert\", \"display_name\":\"Mr. Albert\", \"email\":\"albert@myems.io\", \"is_admin\":false, \"privilege_id\":1, \"password\":\"!MyEMS1\", \"account_expiration_datetime\":\"2100-01-01T00:00:00\",\"password_expiration_datetime\":\"2100-01-01T00:00:00\"}}"
}, },
"url": { "url": {
"raw": "{{base_url}}/users/2", "raw": "{{base_url}}/users/2",
@ -6725,60 +6746,7 @@
] ]
} }
}, },
"response": [ "response": []
{
"name": "User Logout",
"originalRequest": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{base_url}}/users/logout",
"host": [
"{{base_url}}"
],
"path": [
"users",
"logout"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "gunicorn/19.9.0"
},
{
"key": "Date",
"value": "Thu, 19 Mar 2020 01:31:00 GMT"
},
{
"key": "Connection",
"value": "close"
},
{
"key": "content-length",
"value": "0"
},
{
"key": "content-type",
"value": "application/json; charset=UTF-8"
},
{
"key": "set-cookie",
"value": "user_uuid=\"\"; Domain=127.0.0.1; Path=/"
},
{
"key": "set-cookie",
"value": "token=\"\"; Domain=127.0.0.1; Path=/"
}
],
"cookie": [],
"body": ""
}
]
}, },
{ {
"name": "User Change Password", "name": "User Change Password",

12
myems-api/README.md
View File

@ -1947,25 +1947,25 @@ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"Hawaiian
``` ```
### User ### User
* GET User by ID
```bash
curl -i -X GET {{base_url}}/users/{id}
```
* GET All Users * GET All Users
```bash ```bash
curl -i -X GET {{base_url}}/users curl -i -X GET {{base_url}}/users
``` ```
* GET a User by ID
```bash
curl -i -X GET {{base_url}}/users/{id}
```
* DELETE User by id * DELETE User by id
```bash ```bash
curl -i -X DELETE {{base_url}}/users/{id} curl -i -X DELETE {{base_url}}/users/{id}
``` ```
* POST New User * POST New User
```bash ```bash
curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"albert", "display_name":"Mr. Albert", "email":"albert@myems.io", "is_admin":false, "password":"!MyEMS1"}}' {{base_url}}/users curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"albert", "display_name":"Mr. Albert", "email":"albert@myems.io", "is_admin":false, "password":"!MyEMS1", "account_expiration_datetime":"2100-01-01T00:00:00", "password_expiration_datetime":"2100-01-01T00:00:00"}}' {{base_url}}/users
``` ```
* PUT User Profile * PUT User Profile
```bash ```bash
curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"albert", "display_name":"Mr. Albert", "email":"albert@myems.io", "is_admin":false, "privilege_id":1, "password":"!MyEMS1"}}' {{base_url}}/users/{id} curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"albert", "display_name":"Mr. Albert", "email":"albert@myems.io", "is_admin":false, "privilege_id":1, "password":"!MyEMS1", "account_expiration_datetime":"2100-01-01T00:00:00", "password_expiration_datetime":"2100-01-01T00:00:00"}}' {{base_url}}/users/{id}
``` ```
* PUT User Login by Username * PUT User Login by Username
```bash ```bash

113
myems-api/core/user.py
View File

@ -6,7 +6,7 @@ import uuid
import hashlib import hashlib
import re import re
import os import os
from datetime import datetime, timedelta from datetime import datetime, timedelta, timezone
from core.userlogger import user_logger, write_log from core.userlogger import user_logger, write_log
@ -27,7 +27,8 @@ class UserCollection:
cursor = cnx.cursor() cursor = cnx.cursor()
query = (" SELECT u.id, u.name, u.display_name, u.uuid, " query = (" SELECT u.id, u.name, u.display_name, u.uuid, "
" u.email, u.is_admin, p.id,p.name " " u.email, u.is_admin, p.id, p.name, "
" u.account_expiration_datetime_utc, u.password_expiration_datetime_utc "
" FROM tbl_users u " " FROM tbl_users u "
" LEFT JOIN tbl_privileges p ON u.privilege_id = p.id " " LEFT JOIN tbl_privileges p ON u.privilege_id = p.id "
" ORDER BY u.name ") " ORDER BY u.name ")
@ -39,6 +40,8 @@ class UserCollection:
result = list() result = list()
if rows is not None and len(rows) > 0: if rows is not None and len(rows) > 0:
for row in rows: for row in rows:
account_expiration_datetime_utc = row[8].replace(tzinfo=timezone.utc)
password_expiration_datetime_utc = row[9].replace(tzinfo=timezone.utc)
meta_result = {"id": row[0], meta_result = {"id": row[0],
"name": row[1], "name": row[1],
"display_name": row[2], "display_name": row[2],
@ -47,7 +50,9 @@ class UserCollection:
"is_admin": True if row[5] else False, "is_admin": True if row[5] else False,
"privilege": { "privilege": {
"id": row[6], "id": row[6],
"name": row[7]} if row[6] is not None else None} "name": row[7]} if row[6] is not None else None,
"account_expiration_datetime": account_expiration_datetime_utc.timestamp() * 1000,
"password_expiration_datetime": password_expiration_datetime_utc.timestamp() * 1000}
result.append(meta_result) result.append(meta_result)
resp.body = json.dumps(result) resp.body = json.dumps(result)
@ -105,6 +110,20 @@ class UserCollection:
else: else:
privilege_id = None privilege_id = None
timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
if config.utc_offset[0] == '-':
timezone_offset = -timezone_offset
account_expiration_datetime = datetime.strptime(new_values['data']['account_expiration_datetime'],
'%Y-%m-%dT%H:%M:%S')
account_expiration_datetime = account_expiration_datetime.replace(tzinfo=timezone.utc)
account_expiration_datetime -= timedelta(minutes=timezone_offset)
password_expiration_datetime = datetime.strptime(new_values['data']['password_expiration_datetime'],
'%Y-%m-%dT%H:%M:%S')
password_expiration_datetime = password_expiration_datetime.replace(tzinfo=timezone.utc)
password_expiration_datetime -= timedelta(minutes=timezone_offset)
cnx = mysql.connector.connect(**config.myems_user_db) cnx = mysql.connector.connect(**config.myems_user_db)
cursor = cnx.cursor() cursor = cnx.cursor()
@ -138,8 +157,9 @@ class UserCollection:
description='API.PRIVILEGE_NOT_FOUND') description='API.PRIVILEGE_NOT_FOUND')
add_row = (" INSERT INTO tbl_users " add_row = (" INSERT INTO tbl_users "
" (name, uuid, display_name, email, salt, password, is_admin, privilege_id) " " (name, uuid, display_name, email, salt, password, is_admin, privilege_id, "
" VALUES (%s, %s, %s, %s, %s, %s, %s, %s) ") " account_expiration_datetime_utc, password_expiration_datetime_utc) "
" VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s) ")
salt = uuid.uuid4().hex salt = uuid.uuid4().hex
password = new_values['data']['password'] password = new_values['data']['password']
@ -152,7 +172,9 @@ class UserCollection:
salt, salt,
hashed_password, hashed_password,
is_admin, is_admin,
privilege_id)) privilege_id,
account_expiration_datetime,
password_expiration_datetime))
new_id = cursor.lastrowid new_id = cursor.lastrowid
cnx.commit() cnx.commit()
cursor.close() cursor.close()
@ -182,9 +204,12 @@ class UserItem:
cnx = mysql.connector.connect(**config.myems_user_db) cnx = mysql.connector.connect(**config.myems_user_db)
cursor = cnx.cursor() cursor = cnx.cursor()
query = (" SELECT id, name, display_name, uuid, email " query = (" SELECT u.id, u.name, u.display_name, u.uuid, "
" FROM tbl_users " " u.email, u.is_admin, p.id, p.name, "
" WHERE id =%s ") " u.account_expiration_datetime_utc, u.password_expiration_datetime_utc "
" FROM tbl_users u "
" LEFT JOIN tbl_privileges p ON u.privilege_id = p.id "
" WHERE u.id =%s ")
cursor.execute(query, (id_,)) cursor.execute(query, (id_,))
row = cursor.fetchone() row = cursor.fetchone()
cursor.close() cursor.close()
@ -193,12 +218,19 @@ class UserItem:
if row is None: if row is None:
raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND', raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND',
description='API.USER_NOT_FOUND') description='API.USER_NOT_FOUND')
account_expiration_datetime_utc = row[8].replace(tzinfo=timezone.utc)
password_expiration_datetime_utc = row[9].replace(tzinfo=timezone.utc)
result = {"id": row[0], result = {"id": row[0],
"name": row[1], "name": row[1],
"display_name": row[2], "display_name": row[2],
"uuid": row[3], "uuid": row[3],
"email": row[4]} "email": row[4],
"is_admin": True if row[5] else False,
"privilege": {
"id": row[6],
"name": row[7]} if row[6] is not None else None,
"account_expiration_datetime": account_expiration_datetime_utc.timestamp() * 1000,
"password_expiration_datetime": password_expiration_datetime_utc.timestamp() * 1000}
resp.body = json.dumps(result) resp.body = json.dumps(result)
@staticmethod @staticmethod
@ -285,6 +317,20 @@ class UserItem:
else: else:
privilege_id = None privilege_id = None
timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
if config.utc_offset[0] == '-':
timezone_offset = -timezone_offset
account_expiration_datetime = datetime.strptime(new_values['data']['account_expiration_datetime'],
'%Y-%m-%dT%H:%M:%S')
account_expiration_datetime = account_expiration_datetime.replace(tzinfo=timezone.utc)
account_expiration_datetime -= timedelta(minutes=timezone_offset)
password_expiration_datetime = datetime.strptime(new_values['data']['password_expiration_datetime'],
'%Y-%m-%dT%H:%M:%S')
password_expiration_datetime = password_expiration_datetime.replace(tzinfo=timezone.utc)
password_expiration_datetime -= timedelta(minutes=timezone_offset)
cnx = mysql.connector.connect(**config.myems_user_db) cnx = mysql.connector.connect(**config.myems_user_db)
cursor = cnx.cursor() cursor = cnx.cursor()
@ -328,13 +374,17 @@ class UserItem:
update_row = (" UPDATE tbl_users " update_row = (" UPDATE tbl_users "
" SET name = %s, display_name = %s, email = %s, " " SET name = %s, display_name = %s, email = %s, "
" is_admin = %s, privilege_id = %s " " is_admin = %s, privilege_id = %s,"
" account_expiration_datetime_utc = %s, "
" password_expiration_datetime_utc = %s "
" WHERE id = %s ") " WHERE id = %s ")
cursor.execute(update_row, (name, cursor.execute(update_row, (name,
display_name, display_name,
email, email,
is_admin, is_admin,
privilege_id, privilege_id,
account_expiration_datetime,
password_expiration_datetime,
id_,)) id_,))
cnx.commit() cnx.commit()
@ -379,7 +429,8 @@ class UserLogin:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_USER_NAME') description='API.INVALID_USER_NAME')
query = (" SELECT id, name, uuid, display_name, email, salt, password, is_admin " query = (" SELECT id, name, uuid, display_name, email, salt, password, is_admin, "
" account_expiration_datetime_utc, password_expiration_datetime_utc "
" FROM tbl_users " " FROM tbl_users "
" WHERE name = %s ") " WHERE name = %s ")
cursor.execute(query, (str.strip(new_values['data']['name']).lower(),)) cursor.execute(query, (str.strip(new_values['data']['name']).lower(),))
@ -396,7 +447,9 @@ class UserLogin:
"email": row[4], "email": row[4],
"salt": row[5], "salt": row[5],
"password": row[6], "password": row[6],
"is_admin": True if row[7] else False} "is_admin": True if row[7] else False,
"account_expiration_datetime_utc": row[8],
"password_expiration_datetime_utc": row[9]}
elif 'email' in new_values['data']: elif 'email' in new_values['data']:
if not isinstance(new_values['data']['email'], str) or \ if not isinstance(new_values['data']['email'], str) or \
@ -404,7 +457,8 @@ class UserLogin:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_EMAIL') description='API.INVALID_EMAIL')
query = (" SELECT id, name, uuid, display_name, email, salt, password, is_admin " query = (" SELECT id, name, uuid, display_name, email, salt, password, is_admin, "
" account_expiration_datetime_utc, password_expiration_datetime_utc "
" FROM tbl_users " " FROM tbl_users "
" WHERE email = %s ") " WHERE email = %s ")
cursor.execute(query, (str.strip(new_values['data']['email']).lower(),)) cursor.execute(query, (str.strip(new_values['data']['email']).lower(),))
@ -421,7 +475,9 @@ class UserLogin:
"email": row[4], "email": row[4],
"salt": row[5], "salt": row[5],
"password": row[6], "password": row[6],
"is_admin": True if row[7] else False} "is_admin": True if row[7] else False,
"account_expiration_datetime_utc": row[8],
"password_expiration_datetime_utc": row[9]}
else: else:
cursor.close() cursor.close()
cnx.disconnect() cnx.disconnect()
@ -437,6 +493,16 @@ class UserLogin:
cnx.disconnect() cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400, 'API.BAD_REQUEST', 'API.INVALID_PASSWORD') raise falcon.HTTPError(falcon.HTTP_400, 'API.BAD_REQUEST', 'API.INVALID_PASSWORD')
if result['account_expiration_datetime_utc'] <= datetime.utcnow():
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400, 'API.BAD_REQUEST', 'API.USER_ACCOUNT_HAS_EXPIRED')
if result['password_expiration_datetime_utc'] <= datetime.utcnow():
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400, 'API.BAD_REQUEST', 'API.USER_PASSWORD_HAS_EXPIRED')
add_session = (" INSERT INTO tbl_sessions " add_session = (" INSERT INTO tbl_sessions "
" (user_uuid, token, utc_expires) " " (user_uuid, token, utc_expires) "
" VALUES (%s, %s, %s) ") " VALUES (%s, %s, %s) ")
@ -449,6 +515,21 @@ class UserLogin:
cnx.disconnect() cnx.disconnect()
del result['salt'] del result['salt']
del result['password'] del result['password']
timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
if config.utc_offset[0] == '-':
timezone_offset = -timezone_offset
result['account_expiration_datetime'] = \
(result['account_expiration_datetime_utc'].replace(tzinfo=timezone.utc) +
timedelta(minutes=timezone_offset)).strftime('%Y-%m-%dT%H:%M:%S')
del result['account_expiration_datetime_utc']
result['password_expiration_datetime'] = \
(result['password_expiration_datetime_utc'].replace(tzinfo=timezone.utc) +
timedelta(minutes=timezone_offset)).strftime('%Y-%m-%dT%H:%M:%S')
del result['password_expiration_datetime_utc']
result['token'] = token result['token'] = token
resp.body = json.dumps(result) resp.body = json.dumps(result)