Authentication SMS Module
#########################
The `SMS <https://en.wikipedia.org/wiki/Short_Message_Service>`_ authentication
module allows users to authenticate via SMS. It adds a new authentication
method ``sms``, which can be used in the list of ``authentications`` in the
``session`` section of the configuration file.
The ``sms`` method just sends a code via SMS to the user. Then the user needs
to transcribe the code into the login dialog.
This method requires that the user has the correct *Mobile* phone number
defined otherwise it will not be possible for them to authenticate.
Configuration
*************
The configuration of the module is set in the ``authentication_sms`` section.
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
Raw data
{
"_id": null,
"home_page": "http://www.tryton.org/",
"name": "trytond-authentication-sms",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "tryton sms authentication two-factor 2FA",
"author": "Tryton",
"author_email": "foundation@tryton.org",
"download_url": "https://files.pythonhosted.org/packages/2c/ee/8b65ac59fd6e0b5db2d869cf1fb8d10452cf5170cb309ab414ea18f2c959/trytond_authentication_sms-7.2.0.tar.gz",
"platform": null,
"description": "Authentication SMS Module\n#########################\n\nThe `SMS <https://en.wikipedia.org/wiki/Short_Message_Service>`_ authentication\nmodule allows users to authenticate via SMS. It adds a new authentication\nmethod ``sms``, which can be used in the list of ``authentications`` in the\n``session`` section of the configuration file.\n\nThe ``sms`` method just sends a code via SMS to the user. Then the user needs\nto transcribe the code into the login dialog.\n\nThis method requires that the user has the correct *Mobile* phone number\ndefined otherwise it will not be possible for them to authenticate.\n\nConfiguration\n*************\n\nThe configuration of the module is set in the ``authentication_sms`` section.\n\nfunction\n--------\n\nThe fully qualified name of the method to send SMS. It must take three\narguments: text, to and from.\nThis method is required to send SMS.\n\nfrom\n----\n\nThe number from which the SMS are sent.\n\nlength\n------\n\nThe length of the generated code.\nDefault: 6\n\nttl\n---\n\nThe time to live for the generated codes in seconds.\nDefault: 300\n\nname\n----\n\nThe name used in the SMS text.\nDefault: Tryton\n",
"bugtrack_url": null,
"license": "GPL-3",
"summary": "Tryton module to authenticate users via SMS",
"version": "7.2.0",
"project_urls": {
"Bug Tracker": "https://bugs.tryton.org/",
"Documentation": "https://docs.tryton.org/",
"Download": "http://downloads.tryton.org/7.2/",
"Forum": "https://www.tryton.org/forum",
"Homepage": "http://www.tryton.org/",
"Source Code": "https://code.tryton.org/tryton"
},
"split_keywords": [
"tryton",
"sms",
"authentication",
"two-factor",
"2fa"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d16126447c0f0e8e4d7972a5cf7119e174e01bcaa5a5e0832ec6837979ebdcab",
"md5": "71bb52bf31ff9bb2749c3bd5562b358b",
"sha256": "636bacf03abdd7ced0a6b64457c669ec333a7122b44cc92bc7623fa82a2d39e3"
},
"downloads": -1,
"filename": "trytond_authentication_sms-7.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71bb52bf31ff9bb2749c3bd5562b358b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 32795,
"upload_time": "2024-04-29T15:38:24",
"upload_time_iso_8601": "2024-04-29T15:38:24.324636Z",
"url": "https://files.pythonhosted.org/packages/d1/61/26447c0f0e8e4d7972a5cf7119e174e01bcaa5a5e0832ec6837979ebdcab/trytond_authentication_sms-7.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2cee8b65ac59fd6e0b5db2d869cf1fb8d10452cf5170cb309ab414ea18f2c959",
"md5": "d4ea24e4656386b4350ccf20bceb9829",
"sha256": "0cf6ee0877343863aff185de2179a73c15bf0c773783f889e265aeafff3c4c68"
},
"downloads": -1,
"filename": "trytond_authentication_sms-7.2.0.tar.gz",
"has_sig": false,
"md5_digest": "d4ea24e4656386b4350ccf20bceb9829",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24977,
"upload_time": "2024-04-29T15:38:25",
"upload_time_iso_8601": "2024-04-29T15:38:25.725276Z",
"url": "https://files.pythonhosted.org/packages/2c/ee/8b65ac59fd6e0b5db2d869cf1fb8d10452cf5170cb309ab414ea18f2c959/trytond_authentication_sms-7.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 15:38:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "trytond-authentication-sms"
}
JSON