<a id="email-auth"></a>

# Email Auth

<a id="backend-class"></a>

## Backend class

For Django, add this class path to `AUTHENTICATION_BACKENDS`. For other
integrations, use the same class path in the framework-specific backend
setting.

| Backend name   | Class path                             |
|----------------|----------------------------------------|
| `email`        | `social_core.backends.email.EmailAuth` |

[python-social-auth](https://github.com/python-social-auth) comes with an [EmailAuth](https://github.com/python-social-auth/social-core/blob/master/social_core/backends/email.py) backend which comes handy when
your site uses requires the plain old email and password authentication
mechanism.

Actually that’s a lie since the backend doesn’t handle password at all, that’s
up to the developer to validate the password in and the proper place to do it
is the pipeline, right after the user instance was retrieved or created.

The reason to leave password handling to the developer is because too many
things are really tied to the project, like the field where the password is
stored, salt handling, password hashing algorithm and validation. So just add
the pipeline functions that will do that following the needs of your project.

<a id="backend-settings"></a>

## Backend settings

`SOCIAL_AUTH_EMAIL_FORM_URL = '/login-form/'`
: Used to redirect the user to the login/signup form, it must have at least
  one field named `email`. Form submit should go to `/complete/email`,
  or if it goes to your view, then your view should complete the process
  calling `social_core.actions.do_complete`.

`SOCIAL_AUTH_EMAIL_FORM_HTML = 'login_form.html'`
: The template will be used to render the login/signup form to the user, it
  must have at least one field named `email`. Form submit should go to
  `/complete/email`, or if it goes to your view, then your view should
  complete the process calling `social_core.actions.do_complete`.

<a id="email-validation"></a>

## Email validation

Check *Email validation* pipeline in the [pipeline docs](../pipeline.html#email-validation).

<a id="password-handling"></a>

## Password handling

Here’s an example of password handling to add to the pipeline:

```default
from social_core.exceptions import AuthCredentialError


def user_password(strategy, backend, user, is_new=False, *args, **kwargs):
    if backend.name != 'email':
        return

    password = strategy.request_data()['password']
    if is_new:
        user.set_password(password)
        user.save()
    elif not user.validate_password(password):
        # return {'user': None, 'social': None}
        raise AuthCredentialError(
            backend,
            code="credential_rejected",
            source="request",
            stage="pipeline",
            parameter="password",
            recovery="correct_input",
        )
```