{"title":"How to authenticate using REMOTE_USER","version":"4.0","locale":"pt-br","docname":"howto/auth-remote-user","url":"/pt-br/4.0/howto/auth-remote-user/","canonical":"https://djangodocs.dev/pt-br/4.0/howto/auth-remote-user/","summary":"This document describes how to make use of external authentication sources (where the web server sets the REMOTE_USER environment variable) in your Django…","html":"<h1>How to authenticate using <code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER</span></code><a class=\"heading-anchor\" href=\"#how-to-authenticate-using-remote-user\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>This document describes how to make use of external authentication sources\n(where the web server sets the <code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER</span></code> environment variable) in your\nDjango applications.  This type of authentication solution is typically seen on\nintranet sites, with single sign-on solutions such as IIS and Integrated\nWindows Authentication or Apache and <a class=\"reference external\" href=\"https://httpd.apache.org/docs/2.2/mod/mod_authnz_ldap.html\">mod_authnz_ldap</a>, <a class=\"reference external\" href=\"https://www.apereo.org/projects/cas\">CAS</a>, <a class=\"reference external\" href=\"http://weblogin.org\">Cosign</a>,\n<a class=\"reference external\" href=\"https://uit.stanford.edu/service/authentication\">WebAuth</a>, <a class=\"reference external\" href=\"https://sourceforge.net/projects/mod-auth-sspi\">mod_auth_sspi</a>, etc.</p>\n<p>When the web server takes care of authentication it typically sets the\n<code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER</span></code> environment variable for use in the underlying application.  In\nDjango, <code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER</span></code> is made available in the <a class=\"reference internal\" href=\"/pt-br/4.0/ref/request-response/#django.http.HttpRequest.META\" title=\"django.http.HttpRequest.META\"><code class=\"xref py py-attr docutils literal notranslate\"><span class=\"pre\">request.META</span></code></a> attribute.  Django can be configured to make\nuse of the <code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER</span></code> value using the <code class=\"docutils literal notranslate\"><span class=\"pre\">RemoteUserMiddleware</span></code>\nor <code class=\"docutils literal notranslate\"><span class=\"pre\">PersistentRemoteUserMiddleware</span></code>, and\n<a class=\"reference internal\" href=\"/pt-br/4.0/ref/contrib/auth/#django.contrib.auth.backends.RemoteUserBackend\" title=\"django.contrib.auth.backends.RemoteUserBackend\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">RemoteUserBackend</span></code></a> classes found in\n<a class=\"reference internal\" href=\"/pt-br/4.0/topics/auth/#module-django.contrib.auth\" title=\"django.contrib.auth: Django's authentication framework.\"><code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">django.contrib.auth</span></code></a>.</p>\n<section id=\"configuration\">\n<h2>Configuração<a class=\"heading-anchor\" href=\"#configuration\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Primeiro você deve adicionar  <a class=\"reference internal\" href=\"/pt-br/4.0/ref/middleware/#django.contrib.auth.middleware.RemoteUserMiddleware\" title=\"django.contrib.auth.middleware.RemoteUserMiddleware\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">django.contrib.auth.middleware.RemoteUserMiddleware</span></code></a> no <a class=\"reference internal\" href=\"/pt-br/4.0/ref/settings/#std-setting-MIDDLEWARE\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">MIDDLEWARE</span></code></a> definindo <strong>depois</strong> do <a class=\"reference internal\" href=\"/pt-br/4.0/ref/middleware/#django.contrib.auth.middleware.AuthenticationMiddleware\" title=\"django.contrib.auth.middleware.AuthenticationMiddleware\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">django.contrib.auth.middleware.AuthenticationMiddleware</span></code></a>:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"n\">MIDDLEWARE</span> <span class=\"o\">=</span> <span class=\"p\">[</span>\n    <span class=\"s1\">&#39;...&#39;</span><span class=\"p\">,</span>\n    <span class=\"s1\">&#39;django.contrib.auth.middleware.AuthenticationMiddleware&#39;</span><span class=\"p\">,</span>\n    <span class=\"s1\">&#39;django.contrib.auth.middleware.RemoteUserMiddleware&#39;</span><span class=\"p\">,</span>\n    <span class=\"s1\">&#39;...&#39;</span><span class=\"p\">,</span>\n<span class=\"p\">]</span>\n</code></pre></div>\n<p>Depois você deve substituir a <a class=\"reference internal\" href=\"/pt-br/4.0/ref/contrib/auth/#django.contrib.auth.backends.ModelBackend\" title=\"django.contrib.auth.backends.ModelBackend\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">ModelBackend</span></code></a> por <a class=\"reference internal\" href=\"/pt-br/4.0/ref/contrib/auth/#django.contrib.auth.backends.RemoteUserBackend\" title=\"django.contrib.auth.backends.RemoteUserBackend\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">RemoteUserBackend</span></code></a> na configuração <a class=\"reference internal\" href=\"/pt-br/4.0/ref/settings/#std-setting-AUTHENTICATION_BACKENDS\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">AUTHENTICATION_BACKENDS</span></code></a>:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"n\">AUTHENTICATION_BACKENDS</span> <span class=\"o\">=</span> <span class=\"p\">[</span>\n    <span class=\"s1\">&#39;django.contrib.auth.backends.RemoteUserBackend&#39;</span><span class=\"p\">,</span>\n<span class=\"p\">]</span>\n</code></pre></div>\n<p>Com esta configuração, o :class:`~django.contrib.auth.middleware.RemoteUserMiddleware irá detectar o __username__  em <code class=\"docutils literal notranslate\"><span class=\"pre\">request.META['REMOTE_USER']</span></code> e irá autenticar e automaticamente logar aquele usuário usando o <a class=\"reference internal\" href=\"/pt-br/4.0/ref/contrib/auth/#django.contrib.auth.backends.RemoteUserBackend\" title=\"django.contrib.auth.backends.RemoteUserBackend\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">RemoteUserBackend</span></code></a>.</p>\n<p>Esteja ciente de que essa definição em particular desabilita a autenticação com o padrão <code class=\"docutils literal notranslate\"><span class=\"pre\">ModelBackend</span></code>. Isso significa que se o valor de <code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER</span></code> não estiver definido o usuário não conseguirá logar-se, mesmo utilizando a inteface do Django admin. Adicionando <code class=\"docutils literal notranslate\"><span class=\"pre\">django.contrib.auth.backends.ModelBackend</span></code> à lista <code class=\"docutils literal notranslate\"><span class=\"pre\">AUTHENTICATION_BACKENDS</span></code> ele será utilizado como um substituto se “REMOTE_USER” estiver ausente, e esse problema não acontecerá.</p>\n<p>O gerenciamento de usuários do Django, bem como as views em <code class=\"docutils literal notranslate\"><span class=\"pre\">contrib.admin</span></code>, e o comando de gerenciamento <a class=\"reference internal\" href=\"/pt-br/4.0/ref/django-admin/#django-admin-createsuperuser\"><code class=\"xref std std-djadmin docutils literal notranslate\"><span class=\"pre\">createsuperuser</span></code></a>, não fazem integração com usuários remotos. Esta interface trabalha com usuários armazenados no banco de dados independente do <code class=\"docutils literal notranslate\"><span class=\"pre\">AUTHENTICATION_BACKENDS</span></code>.</p>\n<aside class=\"admonition admonition-note\" role=\"note\">\n<p class=\"admonition-title\">Nota</p>\n<p>Um vez que <code class=\"docutils literal notranslate\"><span class=\"pre\">RemoteUserBackend</span></code> herda de <code class=\"docutils literal notranslate\"><span class=\"pre\">ModelBackend</span></code>, você ainda terá todos as mesmas permissões de verificação que estão implementadas em <code class=\"docutils literal notranslate\"><span class=\"pre\">ModelBackend</span></code>.</p>\n<p>Usuários com <a class=\"reference internal\" href=\"/pt-br/4.0/ref/contrib/auth/#django.contrib.auth.models.User.is_active\" title=\"django.contrib.auth.models.User.is_active\"><code class=\"xref py py-attr docutils literal notranslate\"><span class=\"pre\">is_active=False</span></code></a> não serão permitidos a fazer a autenticação. Use <a class=\"reference internal\" href=\"/pt-br/4.0/ref/contrib/auth/#django.contrib.auth.backends.AllowAllUsersRemoteUserBackend\" title=\"django.contrib.auth.backends.AllowAllUsersRemoteUserBackend\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">AllowAllUsersRemoteUserBackend</span></code></a> se você quiser permití-los.</p>\n</aside>\n<p>Se o seu mecanismo de autenticação utilizar um cabeçalho HTTP costumizado e não o <code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER`,</span> <span class=\"pre\">você</span> <span class=\"pre\">pode</span> <span class=\"pre\">utilizar</span> <span class=\"pre\">a</span> <span class=\"pre\">subclass</span> <span class=\"pre\">``RemoteUserMiddleware</span></code> e definir o atributo <code class=\"docutils literal notranslate\"><span class=\"pre\">header</span></code> para atribuir a chave <code class=\"docutils literal notranslate\"><span class=\"pre\">request.META</span></code>. Por exemplo:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.contrib.auth.middleware</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">RemoteUserMiddleware</span>\n\n<span class=\"k\">class</span><span class=\"w\"> </span><span class=\"nc\">CustomHeaderMiddleware</span><span class=\"p\">(</span><span class=\"n\">RemoteUserMiddleware</span><span class=\"p\">):</span>\n    <span class=\"n\">header</span> <span class=\"o\">=</span> <span class=\"s1\">&#39;HTTP_AUTHUSER&#39;</span>\n</code></pre></div>\n<aside class=\"admonition admonition-warning\" role=\"note\">\n<p class=\"admonition-title\">Aviso</p>\n<p>Tenha muito cuidado se usar a subclasse <code class=\"docutils literal notranslate\"><span class=\"pre\">RemoteUserMiddleware</span></code> com um cabeçalho HTTP customizado. Tenha certeza que o servidor de front-end sempre defina ou retire  o cabeçalho baseado nos checks de autenticação apropriados, nunca permitindo que um usuário submeta um falso (ou falsificado) valor no cabeçalho. Já que os cabeçalhos HTTP <code class=\"docutils literal notranslate\"><span class=\"pre\">X-Auth-User</span></code> e o <code class=\"docutils literal notranslate\"><span class=\"pre\">X-Auth_User</span></code> (por exemplo) são ambos normalizados para a chave <code class=\"docutils literal notranslate\"><span class=\"pre\">HTTP_X_AUTH_USER</span></code> no <code class=\"docutils literal notranslate\"><span class=\"pre\">request.META</span></code>, tem que ser verificado que o seu servidor web não aceita um cabeçalho falsificado usando “underscores” no lugar de traços.</p>\n<p>Este alerta não se aplica ao <code class=\"docutils literal notranslate\"><span class=\"pre\">RemoteUserMiddleware</span></code> na sua configuração default <code class=\"docutils literal notranslate\"><span class=\"pre\">header</span> <span class=\"pre\">=</span> <span class=\"pre\">'REMOTE_USER'</span></code>, já que uma chave que não inicie com <code class=\"docutils literal notranslate\"><span class=\"pre\">HTTP_</span></code> em <code class=\"docutils literal notranslate\"><span class=\"pre\">request.META</span></code>  só pode ser setada pelo servidor WSGI, e não diretamente do cabeçalho da requisição HTTP</p>\n</aside>\n<p>Se você precisa de mais controle, é possível criar seu próprio “backend” de autenticação que herda de <a class=\"reference internal\" href=\"/pt-br/4.0/ref/contrib/auth/#django.contrib.auth.backends.RemoteUserBackend\" title=\"django.contrib.auth.backends.RemoteUserBackend\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">RemoteUserBackend</span></code></a> e sobrescreve um ou mais de seus  atributos e métodos.</p>\n</section>\n<section id=\"using-remote-user-on-login-pages-only\">\n<span id=\"persistent-remote-user-middleware-howto\"></span><h2>Usando <code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER</span></code> apenas nas páginas de login.<a class=\"heading-anchor\" href=\"#using-remote-user-on-login-pages-only\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>The <code class=\"docutils literal notranslate\"><span class=\"pre\">RemoteUserMiddleware</span></code> authentication middleware assumes that the HTTP\nrequest header <code class=\"docutils literal notranslate\"><span class=\"pre\">REMOTE_USER</span></code> is present with all authenticated requests. That\nmight be expected and practical when Basic HTTP Auth with <code class=\"docutils literal notranslate\"><span class=\"pre\">htpasswd</span></code> or\nsimilar mechanisms are used, but with Negotiate (GSSAPI/Kerberos) or other\nresource intensive authentication methods, the authentication in the front-end\nHTTP server is usually only set up for one or a few login URLs, and after\nsuccessful authentication, the application is supposed to maintain the\nauthenticated session itself.</p>\n<p>A classe <a class=\"reference internal\" href=\"/pt-br/4.0/ref/middleware/#django.contrib.auth.middleware.PersistentRemoteUserMiddleware\" title=\"django.contrib.auth.middleware.PersistentRemoteUserMiddleware\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">PersistentRemoteUserMiddleware</span></code></a> provê suporte para este caso de uso. Ele manterá a sessão de autenticação até o logout explícito do usuário. A classe pode ser usada como um substituto constante para <a class=\"reference internal\" href=\"/pt-br/4.0/ref/middleware/#django.contrib.auth.middleware.RemoteUserMiddleware\" title=\"django.contrib.auth.middleware.RemoteUserMiddleware\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">RemoteUserMiddleware</span></code></a> na documentação acima.</p>\n</section>","rootId":"how-to-authenticate-using-remote-user","toc":[{"title":"Configuração","anchor":"configuration","children":[]},{"title":"Usando REMOTE_USER apenas nas páginas de login.","anchor":"using-remote-user-on-login-pages-only","children":[]}],"breadcrumbs":[{"docname":"howto/index","title":"Guias de “como fazer”","url":"/pt-br/4.0/howto/"}],"prev":{"docname":"howto/index","title":"Guias de “como fazer”","url":"/pt-br/4.0/howto/"},"next":{"docname":"howto/custom-management-commands","title":"How to create custom django-admin commands","url":"/pt-br/4.0/howto/custom-management-commands/"},"formats":{"html":"/pt-br/4.0/howto/auth-remote-user/","markdown":"/pt-br/4.0/howto/auth-remote-user.md","json":"/pt-br/4.0/howto/auth-remote-user.json"},"source":"https://github.com/django/django/blob/stable/4.0.x/docs/howto/auth-remote-user.txt","official":"https://docs.djangoproject.com/pt-br/4.0/howto/auth-remote-user/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}