2016-06-02 23:48:08 +02:00
|
|
|
Authentication SMS Module
|
|
|
|
|
#########################
|
|
|
|
|
|
|
|
|
|
The `SMS <https://en.wikipedia.org/wiki/Short_Message_Service>`_ authentication
|
2020-05-21 09:05:46 +02:00
|
|
|
module allows users to authenticate via SMS. It adds a new authentication
|
2022-12-20 14:07:50 +01:00
|
|
|
method ``sms``, which can be used in the list of ``authentications`` in the
|
|
|
|
|
``session`` section of the configuration file.
|
2016-06-02 23:48:08 +02:00
|
|
|
|
2022-12-20 14:07:50 +01:00
|
|
|
The ``sms`` method just sends a code via SMS to the user. Then the user needs
|
|
|
|
|
to transcribe the code into the login dialog.
|
2016-06-02 23:48:08 +02:00
|
|
|
|
2020-05-21 09:05:46 +02:00
|
|
|
This method requires that the user has the correct *Mobile* phone number
|
|
|
|
|
defined otherwise it will not be possible for them to authenticate.
|
2016-06-02 23:48:08 +02:00
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
*************
|
|
|
|
|
|
2022-12-20 14:07:50 +01:00
|
|
|
The configuration of the module is set in the ``authentication_sms`` section.
|
2016-06-02 23:48:08 +02:00
|
|
|
|
|
|
|
|
function
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
The fully qualified name of the method to send SMS. It must take three
|
|
|
|
|
arguments: text, to and from.
|
|
|
|
|
This method is required to send SMS.
|
|
|
|
|
|
|
|
|
|
from
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
The number from which the SMS are sent.
|
|
|
|
|
|
|
|
|
|
length
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
The length of the generated code.
|
|
|
|
|
Default: 6
|
|
|
|
|
|
|
|
|
|
ttl
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
The time to live for the generated codes in seconds.
|
|
|
|
|
Default: 300
|
|
|
|
|
|
|
|
|
|
name
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
The name used in the SMS text.
|
|
|
|
|
Default: Tryton
|
