Django users authentication through SMS code
Project description
Django rest sms auth
- Authentication users
- Change phone number
- Providers:
- Megafon
- Smsaero
- Twilio
Requirements
- Python >= 3.0
- Django >= 2.0
- Celery
- Djangorestframework
- Django-phonenumber-field
Concept
- Client send phone number
smsauth
validate and createsms code
sms provider
send digit code- Client send
{sms code + phone number}
- Response info (
jwt token
)
Notes
- Library use
celery
. Instruction - To use
twilio
install extra library - You may add your own provider inherit from
SMSProvider
Installation
pip install django-rest-sms-auth
If you want to use twilio
:
pip install twilio
settings.py
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
...
'sms_auth', # you have to add this
'sms_auth.providers.twilio' # if twilio provider
'sms_auth.providers.megafon' # if megafon provider
]
SMS_AUTH_SETTINGS = {
"SMS_CELERY_FILE_NAME": "run_celery", # your system celery file,
"SMS_AUTH_SUCCESS_KEY": "jwt_token", # property from user model
"SMS_AUTH_PROVIDER_FROM": "ex: +7542222222", # sms signature
# If twilio
"SMS_AUTH_ACCOUNT_SID": "Twilio SID"
"SMS_AUTH_AUTH_TOKEN": "Twilio token"
# If another provider
"SMS_AUTH_PROVIDER_LOGIN":"SMS provider login"
"SMS_AUTH_PROVIDER_PASSWORD": "SMS provider password"
}
Add celery
configuration file: Instruction
run migrations:
python manage.py makemigrations sms_auth && python manage.py migrate
urls.py
path('auth/', include('sms_auth.api.urls'))
Library is ready to use.
Usage
- Sign-in / sign-up:
POST /auth/sign-in/
body: {
"phone_number":"user phone number"
}
result: 200/400 response
- Code validation and get token:
POST /auth/auth/
body: {
"phone_number":"user phone number",
"code":sms_code
}
result: 200/400 response (with token)
- Change phone number:
POST /auth/change-phonenumber/
body: {
"new_phone_number":"user new phone number"
}
result: 200/400 response
After your call previous endpoint: /auth/auth
and send new phone number with code.
Extra
To clear all expired sms codes
python manage.py clear_expired
Additional settings:
"SMS_AUTH_CODE_LEN": int (default: 4)
"SMS_DEBUG": bool (default: False)
"SMS_DEBUG_CODE": int (when debug, default 1111)
"SMS_USER_FIELD": "username"
"SMS_TIMELIFE": 60 # life time of each sms code
"SMS_CODE_NOT_FOUND": "Some text when code not found"
"SMS_WAIT_TIME": "Some text when sms was sended"
"SMS_REQUEST_SUCCESS": "Some text when success phone validatioin and sms sended to user",
"SMS_AUTH_DEBUG_PHONE_NUMBER": phone number with always SMS_DEBUG_CODE
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-rest-sms-auth-0.1.21.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcffa40ab0df2d449f25e5603d5aa3ce5ae69c292bc55e63d58773a030eaf858 |
|
MD5 | 30045bd3ce8974f23f601024c36b4ee7 |
|
BLAKE2b-256 | af786edae7d4ea8301ef241f71f92fb2b4acf7ec185648c99ec449e04af52041 |
Close
Hashes for django_rest_sms_auth-0.1.21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67b0a733d5b63507e7a020febdbaff7a9f96c3a2694f7a14177476ec895c5815 |
|
MD5 | 727e149d447753165305eaf459fe0526 |
|
BLAKE2b-256 | a8303ebb9966a581350ef4586fe15124ec7e4c37a2e5885346e57866a9be8607 |