djangodocs

Django 1.9
Português (Brasil)
Documentation contents

Personalizando a autenticação no Django

A autenticação que vem com o Django é boa o suficiente pros casos mais comuns, mas você pode ter necessidades que não atendem os padrões fora-da-caixa. Para customizar a autenticação de forma a atender as necessidades do seu projeto, é preciso entender quais pontos do sistema fornecido são extensíveis ou substituíveis. Esse documento fornece detalhes sobre como o sistema de autenticação pode ser customizado.

Autenticação backend provê um sistema extensível para quando o username ou senha armazenado no User model precisar ser autenticado em um diferente serviço que o Django tem por padrão.

Você pode dar para seus models permissões customizadas que pode ser conferidas através do sistema de autorização do Django.

Você pode extender o User model padrão, ou substituir por um model completamente customizado.

Outras fontes de autenticação

Pode haver várias vezes que você precise enganchar em outro código de autenticação, outro código de usuário ou senha ou métodos de autenticação.

Por exemplo, sua companhia pode já ter um LDAP configurado que armazena o usuário e a senha para cada empregado. Isto é um aborrecimento para ambos administradores de rede e os próprios usuários se os usuários tiverem contas separadas em LDAP e a aplicação baseada em Django.

Então, para lidar com situações como está, o sistema de autenticação do Django deixa você conectá-lo em outras fontes de autenticação. Você pode sobrescrever o esquema padrão baseado em banco de dados, ou você pode usar o sistema padrão em conjunto com outros sistemas.

Veja a referência do backend de autenticação para informação sobre backends de autenticação incluída com Django.

Especificando backends de autenticação

Por de trás dos panos, Django mantém uma lista de “backends de autenticação” que ele verifica para autenticação. Quando alguém chama: func:django.contrib.auth.authenticate() – como descrito em Como logar um usuário – Django tenta autenticar através de todas os backends de autenticações. Se o primeiro método falhar, Django tenta o segundo, e assim por diante, até todos os backends terem sido tentados.

A lista de backends autenticação usada é especificada na definição AUTHENTICATION_BACKENDS. Isto deve ser uma lista de nomes de caminhos Python que apontam para classes Python que sabem como autenticar. Essas classes podem estar em qualquer lugar no seu caminho Python (python path).

Por padrão, :settings:`AUTHENTICATION_BACKENDS` é definido como:

Code
['django.contrib.auth.backends.ModelBackend']

Esta é o “backend” de autenticação básico que verifica o banco de dados de usuários Django e consulta as suas permissões embutidas. Ele não provê proteção contra ataques de força bruta via qualquer mecanismo limitante. Você pode implementar seu próprio mecanismo com taxa de limitação em um “backend” customizado de autenticação, ou usar o mecanismo fornecido pela maioria dos servidores Web.

A ordem dos :settings:`AUTHENTICATION_BACKENDS` importa, então se o mesmo usuário e senha são válidos em múltiplos backends, Django vai parar de processar na primeira combinação positiva.

Se um “backends” emitir uma exceção PermissionDenied, a autenticação irá falhar imediatamente. Django não irá verificar os próximos “backends”.

Desenvolvendo um backend de autenticação

Um “backend” de autenticação é uma classe que implementa 2 métodos obrigatórios: get_user(user_id) e authenticate(**credentials), também um conjunto de permissões opcionais relacionadas métodos de autorização.

O método get_user recebe um user_id – o qual pode ser um nome de usuário, id do banco de dados, tanto faz, mas tem que ser a chave-primária do seu objeto User – e retorna um objeto User.

O método recebe credenciais como argumentos nomeados. Na maioria das vezes, isso deve parecer com isso:

Code
class MyBackend(object):
    def authenticate(self, username=None, password=None):
        # Check the username/password and return a User.
        ...

Mas ele poderia também autenticar um token, tal qual:

Code
class MyBackend(object):
    def authenticate(self, token=None):
        # Check the token and return a User.
        ...

de qualquer maneira, o authenticate deve verificar as credenciais que recebe, e deve retornar um objeto User que combine com as credenciais, se as credenciais forem válidas. Se elas não são válidas, ele deve retornar None.

O Django admin está bem casado com o objeto User do Django. A melhor maneira de lidar com isso é criar um objeto User do Django para cada usuário que existir para seu “backend” (por ex.:, no seu diretório LDAP, seu banco de dados SQL externo e etc) Você pode inclusive escrever um script para fazer isso de ante-mão, ou seu método de autenticação pode fazê-lo na primeira vez que o usuário se logar.

Aqui um exemplo de “backend” que autentica com um nome de usuário e senha variáveis definidas no seu arquivo settings.py e cria um User Django na primeira vez que um usuário se autentique:

Code
from django.conf import settings
from django.contrib.auth.hashers import check_password
from django.contrib.auth.models import User

class SettingsBackend(object):
    """
    Authenticate against the settings ADMIN_LOGIN and ADMIN_PASSWORD.

    Use the login name, and a hash of the password. For example:

    ADMIN_LOGIN = 'admin'
    ADMIN_PASSWORD = 'pbkdf2_sha256$30000$Vo0VlMnkR4Bk$qEvtdyZRWTcOsCnI/oQ7fVOu1XAURIZYoOZ3iq8Dr4M='
    """

    def authenticate(self, username=None, password=None):
        login_valid = (settings.ADMIN_LOGIN == username)
        pwd_valid = check_password(password, settings.ADMIN_PASSWORD)
        if login_valid and pwd_valid:
            try:
                user = User.objects.get(username=username)
            except User.DoesNotExist:
                # Create a new user. Note that we can set password
                # to anything, because it won't be checked; the password
                # from settings.py will.
                user = User(username=username, password='get from settings.py')
                user.is_staff = True
                user.is_superuser = True
                user.save()
            return user
        return None

    def get_user(self, user_id):
        try:
            return User.objects.get(pk=user_id)
        except User.DoesNotExist:
            return None

Lidando com autorização em bakends personalizados

Backends de autenticação customizados podem fornecer suas próprias permissões

O modelo de usuário irá delegar funções “lookup” de permissões (get_group_permissions(), get_all_permissions(), has_perm(), and has_module_perms()) para qualquer “backend” de autenticação que implemente essas funções.

As permissões dadas para o usuário será um super-conjunto de todas as permissões devolvidas de todos os back-ends . Ou seja , o Django concede uma permissão para um usuário que qualquer backend concederia.

O “backend” simples acima poderia implementar permissões para o mágico admin de maneira relativamente simples.

Code
class SettingsBackend(object):
    ...
    def has_perm(self, user_obj, perm, obj=None):
        if user_obj.username == settings.ADMIN_LOGIN:
            return True
        else:
            return False

Isso dá permissão total para o usuário para qual o acesso foi concedido no exemplo acima. Note que além dos mesmos argumentos dados as funções associadas ao usuário, todas as funções do “backend” de autenticação recebem o objeto user, o qual talvez seja um usuário anônimo, como argumento.

Uma implementação completa de autorização pode ser encontrada na classe ModelBackend no django/contrib/auth/backends.py, o qual é o “backend” padrão e consulta a tabela auth_permission na maior parte do tempo. Se você quer fornecer um comportamento personalizado para somente parte da API do “backend”, você pode tirar vantagem da herança Python e criar uma subclasse de ModelBackend ao invés de de implmentar a API completa em um “backend” customizado.

Autorização para usuários anônimos

Um usuário anônimo é um que não está autenticado poe exemplo ele forneceu detalhes de autenticação não válidos. Todavia, isso não quer dizer necessariamente que eles não estão autorizados a fazer nada. Em um nível mais básico, a maioria dos websites autorizam usuário anônimos a navegar a maior parte do site, e muitos permitem enviar comentários e etc.

O framework de permissão do Django não possui um local para armazenar permissões para usuários anônimos. Porém, o objeto usuário passado para um “backend” de autenticação pode ser um objeto django.contrib.auth.models.AnonymousUser, permitindo o “backend” a especificar um comportamento de autorização personalizado para usuários anônimos. Isso é especialmente útil para autores de “apps” reutilizáveis, que podem delegar todas as questões de autorização para o “backend” de autorização, ao invés de demandar configurações, por exemplo, controlar acesso de anônimos.

Autorização para usuários inativos

Um usuário inativo é um que está autenticado mas tem seu atributo is_active definido como False. Todavia isso não quer dizer que ele não está autorizado a não fazer nada. Por exemplo eles estão permitidos a ativar suas contas.

O suporte para usuários anônimos no sistema de permissão permite um cenário onde usuários anônimos tem permissões de fazer alguma coisa enquanto usuário autenticados inativos não.

Não se esqueça de testar o atributo is_active do usuário nos métodos de permissão do seu próprio backend.

Manipulação de permissões de objeto

O framework de permissões do Django tem uma “foundation” para objetos de permissões, embora não haja uma implementação para isso no core. Isso significa que a verificação para permissões de objetos sempre retorna False ou uma lista vazia (dependendo da verificação realizada). Um “backend” de autenticação receberá os parâmetros nomeados obj e user_obj para cada método de autorização relacionado com o objeto e pode retornar o nível de permissão do objeto como for apropriado.

Permissões personalizadas

Para criar permissões persaonalizadas para um dado objeto de modelo, use o permissions model Meta attribute.

Este modelos “Task” de exemplo cria três permissões personalizadas, isto é, ações que usuários podem ou não podem fazer com instâncias de “Tasks”, específicas para sua aplicação:

Code
class Task(models.Model):
    ...
    class Meta:
        permissions = (
            ("view_task", "Can see available tasks"),
            ("change_task_status", "Can change the status of tasks"),
            ("close_task", "Can remove a task by setting its status as closed"),
        )

A única coisa que isso faz é criar aquelas permissões extras quando você roda manage.py migrate ( a função que cria permissões está conectada com o sinal post_migrate). Seu código está encarregado de verificar o valor destas permissões quando um usuário está tentando acessar a funcionalidade fornecida pela aplicação (ver tarefas, edita o status de tarefas, fechar tarefas). Continuando o exemplo acima, as seguintes verificam se um usuário pode ver “Tasks”:

Code
user.has_perm('app.view_task')

Estendendo o modelo Usuário existente

Existem duas maneiras de estender o modelo padrão User sem substituir seu próprio modelo. Se as mnudanças que precisa são puramente comprtamentais, e nao requerem nenhuma mudança no que é armazenado no banco de dados, você pode criar um proxy model baseado na User. Isso permite qualquer das funcionalidades oferecidas pelo modelo “proxy” incluindo “ordering” padrão, “managers” personalizados ou métodos persononalizados do modelo.

Se você deseja armazenar informação relacionada ao User, você pode usar a OneToOneField para um modelo contento os campos para a informação adicional. Este modelo com relação um-pra-um é muitas vezes chamado modelo de perfil, uma vez que poderia armazenar infomração que nao está relacionada com autenticação sobre o usuário do site. Por exemplo você poderia criar um modelo “Employee”

Code
from django.contrib.auth.models import User

class Employee(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    department = models.CharField(max_length=100)

Assumindo um “Employee” existente Fred Smith o qual tem ambos os modelos “User” e “Employee”, você pode acessar a informação relacionada usando a convenção de relação de modelo padrão do Django.

Code
>>> u = User.objects.get(username='fsmith')
>>> freds_department = u.employee.department

Para adicionar os campos do modelo de perfil para uma página de usuário no admin, defina uma InlineModelAdmin (para este exemplo, iremos usar uma StackedInline) no admin.py da sua aplicação e a adicione a classe UserAdmin a qual é registrada com a classe User:

Code
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
from django.contrib.auth.models import User

from my_user_profile_app.models import Employee

# Define an inline admin descriptor for Employee model
# which acts a bit like a singleton
class EmployeeInline(admin.StackedInline):
    model = Employee
    can_delete = False
    verbose_name_plural = 'employee'

# Define a new User admin
class UserAdmin(BaseUserAdmin):
    inlines = (EmployeeInline, )

# Re-register UserAdmin
admin.site.unregister(User)
admin.site.register(User, UserAdmin)

Este modelo de perfil não é especial de nenhum modo - eles são somente modelos Django que tem uma relação de um-pra-um com o modelo User. Portanto, eles não são criados automaticamente quando um usuário é criado, mas um django.db.models.signals.post_save pode ser usado para criar ou editar modelos relacionados quando apropriado.

Note que usar modelos relacionados resultam em consultas ou “joins” adicionais para retornar os dados relacionados, e dependendo de suas necessidades substituindo o modelo User e adicionando os campos relacionados talvez seja uma opção melhor. Todavia conexões existentes para o modelo de usuário padrão dentro da aplicação do seu projeto talvez justifique a carga extra no banco de dados.

Substituindo um modelo de Usuário personalizado

Alguns tipos de projetos talvez tenham requerimentos de autenticação para as quais o modelo User embutido do Django nem sempre é apropriado. Por exemplo, em alguns sites tenha mais sentido usar um endereço de e-mail como seu “token” de identificação no lugar de um nome de usuáro.

O Django permite que você sobrescreva o modelo “User” padrão através da definição de um valor para AUTH_USER_MODEL que referencia um modelo personalizado:

Code
AUTH_USER_MODEL = 'myapp.MyUser'

Este par pontuado descreve o nome da aplicação Django (o qual deve estar no seu INSTALLED_APPS), e o nome do modelo Django que você deseja usar como seu modelo de usuário.

Referenciando o modelo Usuário

Se você referencia diretamente o User (fpor exemplo, fazendo uma referencia através de uma chave estrangeira), seu código não irá funcionar em projetos onde a definição do AUTH_USER_MODEL tenha sido mudada para um modelo de “User” diferente.

get_user_model()

Ao invés de referenciar diretamente a User, você deve referenciar o modelo usando o django.contrib.auth.get_user_model(). Este método irá retornar o modelo de usuário atualmente ativo – O modelo de usuário personalizado se for especificado, ou se não o User.

QUando você definie uma chave estrangeira ou relações muitos-para-muitos para o modelo de usuário, você deve especificar o modelo usando a definição AUTH_USER_MODEL. Por exemplo:

Code
from django.conf import settings
from django.db import models

class Article(models.Model):
    author = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
    )

Quando conectar com “signals” enviados pelo modelo User, você deve especificar o modelo personalizado usando a definição do AUTH_USER_MODEL. Por exemplo:

Code
from django.conf import settings
from django.db.models.signals import post_save

def post_save_receiver(sender, instance, created, **kwargs):
    pass

post_save.connect(post_save_receiver, sender=settings.AUTH_USER_MODEL)

Falando genericamente, você deve referenciar o modelo de usuário com a definição do AUTH_USER_MODEL em código que é executado em tempo de importação. O get_user_model() somente funciona uma vez que o Django tenha importado todos os modelos.

Especificando um modelo User personalizado

O Django espera que seu modelo de usuário personalizado garanta algumas caracetrísticas mínimas.

  1. Se você usa o “backend” padrão de autenticação, então seu modelo deve ter um único campo “unique” que possa ser usado com o propósito de identificação. Isso pode ser um nome de usuário, um endereço de e-mail, ou qualquer atributo “unique”. Um nome de usuário que permita duplicaidade é permitido se você usar um “backend” de autenticação que dê suporte a isso.

  2. Seu modelo deve fornecer um maneira de endereçar o usuário de uma forma “curta” e outra “longa”. A interpretação mais comum disso seria usar o nome do usuário como identificador “curto”, e o nome completo do usuário como identificador “longo”. Porém, não tem nenhuma regra quanto ao o que estes dois métodos retornam – Se você quiser, eles podem retornar exatamente o mesmo valor.

A maneira mais fácil de construir um modelo de usuário compatível é herdar da AbstractBaseUser. A AbstractBaseUser fornece a implementação principal de um modelo ``User`, incluindo senhas criptografadas e “tokes” para resetar senhas. Você deve então fornecer algumas detalhes de implementações chave.

class models.CustomUser
USERNAME_FIELD

Uma string descrevendo o nome do campo no modelo do usuário que é usado como identificador único. Isso será geralmente o nome do usuário de algua maneira, mas pode ser também um endereço de e-mai, ou qualquer outro identificador único. O campo deve ser único (isto é, ter ``unique=True``definido na sua definição), a menos que você use um “backend” de autenticação personalizado que possa dar suporte a nomes de usuário com duplicidade.

No exemplo seguinte, o campo identifier é usado como o campo identificador:

Code
class MyUser(AbstractBaseUser):
    identifier = models.CharField(max_length=40, unique=True)
    ...
    USERNAME_FIELD = 'identifier'

USERNAME_FIELD agora suporta ForeignKeys. Uma vez que nao tem como passar uma instancia de modelo durante o “prompt” createsuperuser, espera que usuário entre com o valor do to_field (o primary_key por padrão) de uma instância existente.

REQUIRED_FIELDS

Um lista de nomes de campos que serão demandados quando criar um usuário através do coando de gerenciamento createsuperuser. O usuário será demandado a fornecer um valor para cada um destes campos. Isso deve incluir qualquer campo para o qual o blank é False ou indefinido e pode incluir campos adicionais que você queira demandar quando o usuário for criado interativamente. O REQUIRED_FIELDS não tem efeito em outras partes do Django, como criar um usuario no admin.

Por exemplo, aqui é a definição parcial de um modelo de User que define dois campos requeridos - um “date of birth” e “height”:

Code
class MyUser(AbstractBaseUser):
    ...
    date_of_birth = models.DateField()
    height = models.FloatField()
    ...
    REQUIRED_FIELDS = ['date_of_birth', 'height']

USERNAME_FIELD agora suporta ForeignKeys. Uma vez que não tem como passar uma instância de modelo durante o “prompt” createsuperuser, espera que usuário entre com o valor do to_field (o primary_key por padrão) de uma instância existente.

is_active

Um atributo booleano que indica se o usuário é considerado “active”. Este atributo é fornecido como um atributo na AbstractBaseUser padronizado omo True. Como você escolhe como implementar isso irá depender dos detalhes do seu “backend” de autenticação escolhido. Veja a documentação do o atributo "is_active" do modelo de usuário embutido para detalhes.

get_full_name()

Um identificador formal logon para o usuário. Uma interpretação comum seria o nome completo do usuário, mas pode ser qualquer string que identifique o usuário.

get_short_name()

Um identificação informal curta do usuário. Um interpretação comum seria o peimeiro nome do usuário, mas pode ser qualquer string que identifique o usuário de forma informal. Também pode retornar o mesmo valor que django.contrib.auth.models.User.get_full_name().

Os seguintes métodos estão disponíveis em qualquer subclasse de AbstractBaseUser:

class models.AbstractBaseUser
get_username()

Retorna o valor do campo denominado no USERNAME_FIELD.

is_anonymous()

Sempre retorna False. Essa é uma maneira de diferenciar dos objetos do tipo AnonymousUser. Geralmente, você deve preferir usar is_authenticated() para este método.

is_authenticated()

Sempre retorna True. Esta é uma maneira de dizer se o usuário foi autenticado. Isso não implica em nenhuma permissão, e não verifica se o usuário é ativo - isso somente indica se o usuário forneceu um nome de usuário e senha válidos.

set_password(raw_password)

Define a senha do usuário para uma dada string simples, levando em conta a criptografia da senha. Não salva o objeto AbstractBaseUser.

Quando a senha simples (plana) é None, a senha será definida como uma senha inutilizável, como se set_unusable_password() fosse usado.

check_password(raw_password)

Retorna ``True``se a string simples é a senha correta para o usuário. (leva em conta a criptografia da senha quando fizer a comparação.)

set_unusable_password()

Marca o usuário como não tendo uma senha definida. Não é o mesmo que uma string em branco para senha. check_password() para este usuário nunca retornará True. Não salva o objeto AbstractBaseUser.

Você talvez precise disso se a autenticação para sua aplicação é feita em uma fonte externa existente como um diretório LDAP.

has_usable_password()

Retorna False se set_unusable_password() foi chamado para este usuário.

get_session_auth_hash()

Retorna um HMAC do campo senha. Usado para “Session invalidation on password change” isto é, invalidar sessão no caso de alteração de password.

Você deve também definir um “manager” personalizado para seu modelo User. Se seu modelo User defini os campos username, email, is_staff, is_active, is_superuser, last_login, e date_joined o mesmo que o User padrão do Django, você pode somente instalar o UserManager; Porém, se seu modelo User define campos diferentes, você precisa definir um “manager” personalizado que estende BaseUserManager e fornecendo dois métodos adicionais.

class models.CustomUserManager
create_user(*username_field*, password=None, \**other_fields)

O protótipo de create_user()``deve aceitar o campo "username" , mais todos os campos requeridos como argumentos. Por exemlo, se seu modelo de usuário usa ``email como o campo username, e tem date_of_birth como campo requerido, então create_user deve ser definido como:

Code
def create_user(self, email, date_of_birth, password=None):
    # create user here
    ...
create_superuser(*username_field*, password, \**other_fields)

O protótipo de create_superuser()``deve aceitar o campo "username" , mais todos os campos requeridos como argumentos. Por exemlo, se seu modelo de usuário usa ``email como o campo “username”, e tem date_of_birth como campo requerido, então create_user deve ser definido como:

Code
def create_superuser(self, email, date_of_birth, password):
    # create superuser here
    ...

Diferente de create_user(), o create_superuser() deve requerer o “caller” para fornecer um password.

BaseUserManager fornece os seguintes métodos de utilidade:

class models.BaseUserManager
classmethod normalize_email(email)

Normalizes email addresses by lowercasing the domain portion of the email address.

get_by_natural_key(username)

Retornar uma instância de usuário usando o conteúdo do campo denominado no USERNAME_FIELD.

make_random_password(length=10, allowed_chars='abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789')

Retorna uma senha randômica com o tamanho dado e a dada string de caracteres permitidos. Note que o calor padrão de allowed_chars não contém letrar que podem causar confusão, incluindo:

  • i, l, I, e 1 (letra i minúscula, letra L maiúscula, letra i maiúscula, e o número um)

  • o, O, e 0 (letra o minúscula, letra o maiúscula, e zero)

Estendendo o Usuário padrão do Django

Se você está inteiramente feliz com o modelo User do Django e você só quer adicionar algumas infomrações de perfil, você pode simplesmente criar uma subclasse de django.contrib.auth.models.AbstractUser e adicionar seus campos de perfil customizados, embora recomendaríamos um modelo separado como descrito no “Considerações de design de modelo” note o Especificando um modelo User personalizado. O AbstractUser fornece uma implementação completa da User padrão como um modelo abstrato.

Usuários personalizados e o formulários de autenticação embutidos.

Os forms e views embutidos no Django tem certas premissas sobre o modelo de usuário que eles estão trabalhando.

Os “forms” seguintes são compatíveis com qualquer subclasse de AbstractBaseUser:

Os seguintes forms tem premissas sobre o modelo de usuário e podem ser usadas como estão se estas premissas forem atendidas:

  • PasswordResetForm: assume que o modelo de usuário tem um campo chamado email que pode ser usado para identificar o usuário e um campo booleano chamado is_active para prevenir o “reset” de senhas por usuários inativos.

Finalmente, os seguintes forms estão amarrados a User e precisa ser rescrito ou estendido para funcionar com o modelo de usuário personalizado:

Se o seu modelo de usuário personalizado é uma simples subclasse de AbstractUser, então você pode estender estes forms desta manera:

Code
from django.contrib.auth.forms import UserCreationForm
from myapp.models import CustomUser

class CustomUserCreationForm(UserCreationForm):

    class Meta(UserCreationForm.Meta):
        model = CustomUser
        fields = UserCreationForm.Meta.fields + ('custom_field',)

Usuários personalizados e django.contrib.admin

Se você quer que seu modelo de usuário personalizado também trabalhe com o Admin, se modelo de usuário deve definir alguns atributos adicionais e métodos. Estes métodos possibilitam o admin a controlar o acesso do usuário ao conteúdo do admin:

class models.CustomUser
is_staff

Retorna ``True``se o usuário está permitido a ter acesso ao site admin.

is_active

Retorna True se a conta de usuário estiver ativa.

has_perm(perm, obj=None):

Retorna True``se o usuário tem a permissão nominada. Se ``obj é fornecido, a permissão necessária para ser verificado para uma instância de objeto específica.

has_module_perms(app_label):

Retorna ``True``se o usuário tem permissão para acessar modelos na dada aplicação.

Você irá também precisar registrar seu modelo de usuário personalizado com o admin. Se o seu modelo de usuário customizado estende django.contrib.auth.models.AbstractUser, você pode usar a classe existente django.contrib.auth.admin.UserAdmin do Django. Porém, se o seu modelo de usuário estende AbstractBaseUser, você irá precisar definir uma classe ModelAdmin personalizada. Talvez seja possível criar uma subclasse da django.contrib.auth.admin.UserAdmin padrão; Porém, você irá precisar sobrescrever qualquer definição que referencie campos na django.contrib.auth.models.AbstractUser que não estão na sua classe de usuário personalizada.

Usuários personalizados e permissões

Para tornar fácil incluir o framework de permissões do Django na sua própria classe User, Django fornece PermissionsMixin. Isso é um modelo abstrato que você pode incluir na hierarquia de classe para seu modelos de usuário, dando a você todos os métodos e campos do banco de dados necessários para dar suporte ao modelo de permissões do Django.

PermissionsMixin fornece os seguintes métodos e atributos:

class models.PermissionsMixin
is_superuser

Booleano. Designa que este user tem todas as permissões sem assinalá-las explicitamente.

get_group_permissions(obj=None)

Retorna um conjunto de strings de permissões que o usuário tem através de seus grupos.

Se o obj é passado, somente retorna o grupo de permissões para este objeto específico.

get_all_permissions(obj=None)

Retorna um conjunto de strings de permissões que o usuário tem, através de ambos permissões de grupo e usuário.

Se o obj é passado, somente retorna as permissões para este objeto específico.

has_perm(perm, obj=None)

Retorna True se o usuário tem a permissão especificada, onde perm está no formato "<app label>.<permission codename>" (see permissões). Se o usuário é inativo, este método irá sempre retornar False.

Se obj é passado, este método não irá verificar por permissões para o modelo, mas para este objeto específico.

has_perms(perm_list, obj=None)

Retorna True se o usuário tem cada uma das permissões especificadas, onde cara permissão este no formato "<app label>.<permission codename>". Se o usuário é inativo, este método sempre irá retornar False.

Se obj é passado, este método não irá verificar por permissões para o modelo, mas para este objeto específico.

has_module_perms(package_name)

Retorna True se o usuário tiver qualquer permissão no dado pacote (o nome da aplicação Django). Se o usuário é inativo, este métodos irá sempre retornar False.

Usuários personalizados e modelos de proxy

Uma limitação de modelos de usuários personalizados é que ao instalar um modelos de usuário personalizado irá quebrar qualquer modelos “proxy” que estenda User. Modelos “proxy” devem ser baseados em um classe concreta; definindo um modelo de usuário personalizado, você remove a habilidade do Django de identificar com segurança a classe base.

Se seu projeto usa modelos “proxy”, você deve ou modificar o “proxy” para estender o modelos de usuário que está em uso no seu projeto, ou juntar o comportamento do seu modelo “proxy” na sua subclasse de usuário.

Um exemplo completo

Aqui está um exemplo de uma aplicação de usuário customizada compatível com o admin. Este “user model” utiliza um endereço de e-mail como nome de usuário e requer uma data de nascimento; realiza verificação de permissões, além de uma simples administração de contas de usuários. Este model é compatível com todos forms de autenticação “auth forms” e views embutidos, exceto para os forms de criação de usuários “User creation forms”. Este exemplo ilustra como a maioria dos componentes funcionam juntos, mas não se destina a ser copiado e aplicado diretamente nos projetos para uso em produção.

Todo este código deve estar no arquivo “models.py” para um aplicativo de autenticação customizável:

Code
from django.db import models
from django.contrib.auth.models import (
    BaseUserManager, AbstractBaseUser
)


class MyUserManager(BaseUserManager):
    def create_user(self, email, date_of_birth, password=None):
        """
        Creates and saves a User with the given email, date of
        birth and password.
        """
        if not email:
            raise ValueError('Users must have an email address')

        user = self.model(
            email=self.normalize_email(email),
            date_of_birth=date_of_birth,
        )

        user.set_password(password)
        user.save(using=self._db)
        return user

    def create_superuser(self, email, date_of_birth, password):
        """
        Creates and saves a superuser with the given email, date of
        birth and password.
        """
        user = self.create_user(
            email,
            password=password,
            date_of_birth=date_of_birth,
        )
        user.is_admin = True
        user.save(using=self._db)
        return user


class MyUser(AbstractBaseUser):
    email = models.EmailField(
        verbose_name='email address',
        max_length=255,
        unique=True,
    )
    date_of_birth = models.DateField()
    is_active = models.BooleanField(default=True)
    is_admin = models.BooleanField(default=False)

    objects = MyUserManager()

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = ['date_of_birth']

    def get_full_name(self):
        # The user is identified by their email address
        return self.email

    def get_short_name(self):
        # The user is identified by their email address
        return self.email

    def __str__(self):              # __unicode__ on Python 2
        return self.email

    def has_perm(self, perm, obj=None):
        "Does the user have a specific permission?"
        # Simplest possible answer: Yes, always
        return True

    def has_module_perms(self, app_label):
        "Does the user have permissions to view the app `app_label`?"
        # Simplest possible answer: Yes, always
        return True

    @property
    def is_staff(self):
        "Is the user a member of staff?"
        # Simplest possible answer: All admins are staff
        return self.is_admin

Então, para registrar este aplicativo customizado e ser possível acessá-lo por meio do admin do Django, o seguinte código deve ser inserido no arquivo “admin.py” da aplicação.

Code
from django import forms
from django.contrib import admin
from django.contrib.auth.models import Group
from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
from django.contrib.auth.forms import ReadOnlyPasswordHashField

from customauth.models import MyUser


class UserCreationForm(forms.ModelForm):
    """A form for creating new users. Includes all the required
    fields, plus a repeated password."""
    password1 = forms.CharField(label='Password', widget=forms.PasswordInput)
    password2 = forms.CharField(label='Password confirmation', widget=forms.PasswordInput)

    class Meta:
        model = MyUser
        fields = ('email', 'date_of_birth')

    def clean_password2(self):
        # Check that the two password entries match
        password1 = self.cleaned_data.get("password1")
        password2 = self.cleaned_data.get("password2")
        if password1 and password2 and password1 != password2:
            raise forms.ValidationError("Passwords don't match")
        return password2

    def save(self, commit=True):
        # Save the provided password in hashed format
        user = super(UserCreationForm, self).save(commit=False)
        user.set_password(self.cleaned_data["password1"])
        if commit:
            user.save()
        return user


class UserChangeForm(forms.ModelForm):
    """A form for updating users. Includes all the fields on
    the user, but replaces the password field with admin's
    password hash display field.
    """
    password = ReadOnlyPasswordHashField()

    class Meta:
        model = MyUser
        fields = ('email', 'password', 'date_of_birth', 'is_active', 'is_admin')

    def clean_password(self):
        # Regardless of what the user provides, return the initial value.
        # This is done here, rather than on the field, because the
        # field does not have access to the initial value
        return self.initial["password"]


class UserAdmin(BaseUserAdmin):
    # The forms to add and change user instances
    form = UserChangeForm
    add_form = UserCreationForm

    # The fields to be used in displaying the User model.
    # These override the definitions on the base UserAdmin
    # that reference specific fields on auth.User.
    list_display = ('email', 'date_of_birth', 'is_admin')
    list_filter = ('is_admin',)
    fieldsets = (
        (None, {'fields': ('email', 'password')}),
        ('Personal info', {'fields': ('date_of_birth',)}),
        ('Permissions', {'fields': ('is_admin',)}),
    )
    # add_fieldsets is not a standard ModelAdmin attribute. UserAdmin
    # overrides get_fieldsets to use this attribute when creating a user.
    add_fieldsets = (
        (None, {
            'classes': ('wide',),
            'fields': ('email', 'date_of_birth', 'password1', 'password2')}
        ),
    )
    search_fields = ('email',)
    ordering = ('email',)
    filter_horizontal = ()

# Now register the new UserAdmin...
admin.site.register(MyUser, UserAdmin)
# ... and, since we're not using Django's built-in permissions,
# unregister the Group model from admin.
admin.site.unregister(Group)

Finalmente, especifique o model customizado como sendo o “user model” padrão para o seu projeto, utilizando para isso, AUTH_USER_MODEL no arquivo “settings.py”:

Code
AUTH_USER_MODEL = 'customauth.MyUser'

This page as Markdown JSON

Edit this page on GitHub Official version