????
Your IP : 216.73.216.122
"""
flask_security.confirmable
~~~~~~~~~~~~~~~~~~~~~~~~~~
Flask-Security confirmable module
:copyright: (c) 2012 by Matt Wright.
:copyright: (c) 2017 by CERN.
:copyright: (c) 2021-2023 by J. Christopher Wagner (jwag).
:license: MIT, see LICENSE for more details.
"""
from flask import current_app
from .proxies import _security, _datastore
from .signals import confirm_instructions_sent, user_confirmed
from .utils import (
config_value as cv,
get_token_status,
hash_data,
send_mail,
url_for_security,
verify_hash,
)
def generate_confirmation_link(user):
token = generate_confirmation_token(user)
return url_for_security("confirm_email", token=token, _external=True), token
def send_confirmation_instructions(user):
"""Sends the confirmation instructions email for the specified user.
:param user: The user to send the instructions to
"""
confirmation_link, token = generate_confirmation_link(user)
send_mail(
cv("EMAIL_SUBJECT_CONFIRM"),
user.email,
"confirmation_instructions",
user=user,
confirmation_link=confirmation_link,
confirmation_token=token,
)
confirm_instructions_sent.send(
current_app._get_current_object(),
_async_wrapper=current_app.ensure_sync,
user=user,
token=token,
confirmation_token=token,
)
def generate_confirmation_token(user):
"""Generates a unique confirmation token for the specified user.
:param user: The user to work with
"""
data = [str(user.fs_uniquifier), hash_data(user.email)]
return _security.confirm_serializer.dumps(data)
def requires_confirmation(user):
"""Returns `True` if the user requires confirmation."""
return (
_security.confirmable
and not cv("LOGIN_WITHOUT_CONFIRMATION")
and user.confirmed_at is None
)
def confirm_email_token_status(token):
"""Returns the expired status, invalid status, and user of a confirmation
token. For example::
expired, invalid, user = confirm_email_token_status('...')
:param token: The confirmation token
"""
expired, invalid, user, token_data = get_token_status(
token, "confirm", "CONFIRM_EMAIL", return_data=True
)
if not invalid and user:
user_id, token_email_hash = token_data
invalid = not verify_hash(token_email_hash, user.email)
return expired, invalid, user
def confirm_user(user):
"""Confirms the specified user
:param user: The user to confirm
"""
if user.confirmed_at is not None:
return False
user.confirmed_at = _security.datetime_factory()
_datastore.put(user)
user_confirmed.send(
current_app._get_current_object(),
_async_wrapper=current_app.ensure_sync,
user=user,
)
return True